IInputPortConfig Struct Reference

The configuration component of input ports. Provides access to Input port owners to internal components of the input port. More...

Inheritance diagram for IInputPortConfig:

Collaboration diagram for IInputPortConfig:

Detailed Description

The configuration component of input ports. Provides access to Input port owners to internal components of the input port.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	setNotificationMethod (PacketReadyNotification method)=0
	Sets the input-ports response to the packet enqueued notification.
virtual ErrCode INTERFACE_FUNC	notifyPacketEnqueued (Bool queueWasEmpty)=0
	Gets called when a packet was enqueued in a connection. More...
virtual ErrCode INTERFACE_FUNC	notifyPacketEnqueuedOnThisThread ()=0
	Gets called when a packet was enqueued in a connection. More...
virtual ErrCode INTERFACE_FUNC	setListener (IInputPortNotifications *port)=0
	Set the object receiving input-port related events and notifications.
virtual ErrCode INTERFACE_FUNC	getCustomData (IBaseObject **customData)=0
	Get a custom data attached to the object.
virtual ErrCode INTERFACE_FUNC	setCustomData (IBaseObject *customData)=0
	Set a custom data attached to the object.
virtual ErrCode INTERFACE_FUNC	setRequiresSignal (Bool requiresSignal)=0
	Sets requires signal flag of the input port. More...
virtual ErrCode INTERFACE_FUNC	getGapCheckingEnabled (Bool *gapCheckingEnabled)=0
	Returns the state of gap checking requested by the input port. More...
Public Member Functions inherited from IInputPort
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...
virtual ErrCode INTERFACE_FUNC	getOperationMode (OperationModeType *modeType)=0
	Gets the operation mode of the device. 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	getOnAnyPropertyValueWrite (IEvent **event)=0
	Gets the Event that is triggered whenever any Property value is written. The event is triggered after the specific Property event. More...
virtual ErrCode INTERFACE_FUNC	getOnAnyPropertyValueRead (IEvent **event)=0
	Gets the Event that is triggered whenever any Property value is read.The event is triggered after the specific Property event. 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

getGapCheckingEnabled()

virtual ErrCode INTERFACE_FUNC getGapCheckingEnabled ( Bool *  gapCheckingEnabled )

pure virtual

Returns the state of gap checking requested by the input port.

Parameters

gapCheckingEnabled

true if gap checking is requested by the input port.

notifyPacketEnqueued()

virtual ErrCode INTERFACE_FUNC notifyPacketEnqueued ( Bool  queueWasEmpty )

pure virtual

Gets called when a packet was enqueued in a connection.

Parameters

queueWasEmpty

True if queue was empty before packet was enqueued.

notifyPacketEnqueuedOnThisThread()

virtual ErrCode INTERFACE_FUNC notifyPacketEnqueuedOnThisThread ( )

pure virtual

Gets called when a packet was enqueued in a connection.

The notification is called on the same thread that enqueued the packet.

setRequiresSignal()

virtual ErrCode INTERFACE_FUNC setRequiresSignal ( Bool  requiresSignal )

pure virtual

Sets requires signal flag of the input port.

Parameters

requiresSignal

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

If an input port requires a signal, then the input port must have a signal connected otherwise the owner of the input port (function block) should report an error.