Signals accepted by input ports can be connected, forming a connection between the input port and signal, through which Packets can be sent. More...

Inheritance diagram for IInputPort:

Collaboration diagram for IInputPort:

Detailed Description

Signals accepted by input ports can be connected, forming a connection between the input port and signal, through which Packets can be sent.

Any openDAQ object which wishes to receive signal data must create an input port and connect it to said signals. Such objects are for example function blocks, and readers.

An input port can filter out incompatible signals by returning false when such a signal is passed as argument to acceptsSignal, and also rejects the signals when they are passed as argument to connect.

Depending on the configuration, an input port might not require a signal to be connected, returning false when requiresSignal is called. Such input ports are usually a part of function blocks that do not require a given signal to perform calculations.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	acceptsSignal (ISignal signal, Bool accepts)=0
	Returns true if the signal can be connected to the input port; false otherwise. More...

virtual ErrCode INTERFACE_FUNC	connect (ISignal *signal)=0
	Connects the signal to the input port, forming a Connection. More...

virtual ErrCode INTERFACE_FUNC	disconnect ()=0
	Disconnects the signal from the input port.

virtual ErrCode INTERFACE_FUNC	getSignal (ISignal **signal)=0
	Gets the signal connected to the input port. More...

virtual ErrCode INTERFACE_FUNC	getRequiresSignal (Bool *requiresSignal)=0
	Returns true if the input port requires a signal to be connected; false otherwise. More...

virtual ErrCode INTERFACE_FUNC	getConnection (IConnection **connection)=0
	Gets the Connection object formed between the Signal and Input port. More...

Public Member Functions inherited from IComponent
virtual ErrCode INTERFACE_FUNC	getLocalId (IString **localId)=0
	Gets the local ID of the component. More...

virtual ErrCode INTERFACE_FUNC	getGlobalId (IString **globalId)=0
	Gets the global ID of the component. More...

virtual ErrCode INTERFACE_FUNC	getActive (Bool *active)=0
	Returns true if the component is active; false otherwise. More...

virtual ErrCode INTERFACE_FUNC	setActive (Bool active)=0
	Sets the component to be either active or inactive. Also recursively sets the `active` field of all child components if component is a folder. More...

virtual ErrCode INTERFACE_FUNC	getContext (IContext **context)=0
	Gets the context object. More...

virtual ErrCode INTERFACE_FUNC	getParent (IComponent **parent)=0
	Gets the parent of the component. More...

virtual ErrCode INTERFACE_FUNC	getName (IString **name)=0
	Gets the name of the component. More...

virtual ErrCode INTERFACE_FUNC	setName (IString *name)=0
	Sets the name of the component. More...

virtual ErrCode INTERFACE_FUNC	getDescription (IString **description)=0
	Gets the description of the component. More...

virtual ErrCode INTERFACE_FUNC	setDescription (IString *description)=0
	Sets the description of the component. More...

virtual ErrCode INTERFACE_FUNC	getTags (ITags **tags)=0
	Gets the tags of the component. More...

virtual ErrCode INTERFACE_FUNC	getVisible (Bool *visible)=0
	Gets `visible` metadata state of the component. More...

virtual ErrCode INTERFACE_FUNC	setVisible (Bool visible)=0
	Sets `visible` attribute state of the component. More...

virtual ErrCode INTERFACE_FUNC	getLockedAttributes (IList **attributes)=0
	Gets a list of the component's locked attributes. The locked attributes cannot be modified via their respective setters. More...

virtual ErrCode INTERFACE_FUNC	getOnComponentCoreEvent (IEvent **event)=0
	Gets the Core Event object that triggers whenever a change to this component happens within the openDAQ core structure. More...

virtual ErrCode INTERFACE_FUNC	getStatusContainer (IComponentStatusContainer **statusContainer)=0
	Gets the container of Component statuses. More...

virtual ErrCode INTERFACE_FUNC	findComponent (IString id, IComponent *outComponent)=0
	Finds the component (signal/device/function block) with the specified (global) id. More...

Public Member Functions inherited from IPropertyObject
virtual ErrCode INTERFACE_FUNC	getClassName (IString **className)=0
	Gets the name of the class the Property object was constructed with. More...

virtual ErrCode INTERFACE_FUNC	setPropertyValue (IString propertyName, IBaseObject value)=0
	Sets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertyValue (IString propertyName, IBaseObject *value)=0
	Gets the value of the Property with the given name. More...

virtual ErrCode INTERFACE_FUNC	getPropertySelectionValue (IString propertyName, IBaseObject *value)=0
	Gets the selected value of the Property, if the Property is a Selection property. More...

virtual ErrCode INTERFACE_FUNC	clearPropertyValue (IString *propertyName)=0
	Clears the Property value from the Property object. More...

virtual ErrCode INTERFACE_FUNC	hasProperty (IString propertyName, Bool hasProperty)=0
	Checks if the Property object contains a property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getProperty (IString propertyName, IProperty *property)=0
	Gets the Property with the given `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	addProperty (IProperty *property)=0
	Adds the property to the Property object. More...

virtual ErrCode INTERFACE_FUNC	removeProperty (IString *propertyName)=0
	Removes the Property named `propertyName` from the Property object. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueWrite (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value is written to the Property named `propertyName`. More...

virtual ErrCode INTERFACE_FUNC	getOnPropertyValueRead (IString propertyName, IEvent *event)=0
	Gets the Event that is triggered whenever a Property value of a Property named `propertyName` is read. More...

virtual ErrCode INTERFACE_FUNC	getVisibleProperties (IList **properties)=0
	Returns a list of visible properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	getAllProperties (IList **properties)=0
	Returns a list of all properties contained in the Property object. More...

virtual ErrCode INTERFACE_FUNC	setPropertyOrder (IList *orderedPropertyNames)=0
	Sets a custom order of properties as defined in the list of property names. More...

virtual ErrCode INTERFACE_FUNC	beginUpdate ()=0
	Begins batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	endUpdate ()=0
	Ends batch configuration of the object. More...

virtual ErrCode INTERFACE_FUNC	getUpdating (Bool *updating)=0
	Returns the state of batch configuration. More...

virtual ErrCode INTERFACE_FUNC	getOnEndUpdate (IEvent **event)=0
	Gets the Event that is triggered whenever the batch configuration is applied. More...

virtual ErrCode INTERFACE_FUNC	getPermissionManager (IPermissionManager **permissionManager)=0
	Gets the permission manager of property object. More...

Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...

virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...

virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...

virtual ErrCode INTERFACE_FUNC	equals (IBaseObject other, Bool equal) const =0
	Compares object to another object for equality. More...

virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...

Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...

virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...

virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

◆ acceptsSignal()

virtual ErrCode INTERFACE_FUNC acceptsSignal	(	ISignal *	signal,
		Bool *	accepts
	)

pure virtual

Returns true if the signal can be connected to the input port; false otherwise.

Parameters

	signal	The signal being evaluated for compatibility.
[out]	accepts	True if the signal can be connected; false otherwise.

Return values

OPENDAQ_ERR_NOTASSIGNED if the accepted signal criteria is not defined by the input port.

◆ connect()

virtual ErrCode INTERFACE_FUNC connect ( ISignal * signal )

pure virtual

Connects the signal to the input port, forming a Connection.

Parameters

signal The signal to be connected to the input port.

Return values

OPENDAQ_ERR_SIGNAL_NOT_ACCEPTED	if the signal is not accepted.
OPENDAQ_ERR_NOTASSIGNED	if the accepted signal criteria is not defined by the input port.

The signal is notified of the connection formed between it and the input port.

◆ getConnection()

virtual ErrCode INTERFACE_FUNC getConnection ( IConnection ** connection )

pure virtual

Gets the Connection object formed between the Signal and Input port.

Parameters

[out] connection The Connection object.

◆ getRequiresSignal()

virtual ErrCode INTERFACE_FUNC getRequiresSignal ( Bool * requiresSignal )

pure virtual

Returns true if the input port requires a signal to be connected; false otherwise.

Parameters

[out] requiresSignal True if the input port requires a signal to be connected; false otherwise.

◆ getSignal()

virtual ErrCode INTERFACE_FUNC getSignal ( ISignal ** signal )

pure virtual

Gets the signal connected to the input port.

Parameters

[out] signal The signal connected to the input port.

	openDAQ Open data acquisition platform

Detailed Description

Public Member Functions

Member Function Documentation

◆ acceptsSignal()

◆ connect()

◆ getConnection()

◆ getRequiresSignal()

◆ getSignal()