Detailed Description

Represents the configuration interface for mirrored input ports.

Allows listing available streaming sources and selecting the active source for a mirrored input port. Only sources that support client-to-device streaming are allowed. The active sources sends client signal (and the associated domain signal) data to the device, which is then consumed by the connection formed by the input port origin and the mirrored signal connected to it.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	getRemoteId (IString **id) const =0
	Gets the global ID of the input port as it appears on the remote device. More...

virtual ErrCode INTERFACE_FUNC	getStreamingSources (IList **streamingConnectionStrings)=0
	Gets a list of connection strings of all available streaming sources of the input port. More...

virtual ErrCode INTERFACE_FUNC	setActiveStreamingSource (IString *streamingConnectionString)=0
	Sets the active streaming source of the input port. More...

virtual ErrCode INTERFACE_FUNC	getActiveStreamingSource (IString **streamingConnectionString)=0
	Gets a connection strings of the active streaming source of the input port. More...

Public Member Functions inherited from IInputPortConfig
virtual ErrCode INTERFACE_FUNC	setNotificationMethod (PacketReadyNotification method)=0
	Sets the input-ports response to the packet enqueued notification.

virtual ErrCode INTERFACE_FUNC	getNotificationMethod (PacketReadyNotification *method)=0
	Gets 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...

virtual ErrCode INTERFACE_FUNC	notifyPacketEnqueuedWithScheduler ()=0
	Gets called when a packet was enqueued in a connection. More...

virtual ErrCode INTERFACE_FUNC	getListener (IInputPortNotifications **port)=0
	Gets the object receiving input-port related events and notifications.

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...

virtual ErrCode INTERFACE_FUNC	getPublic (Bool *isPublic)=0
	Returns true if the port is public; false otherwise. More...

virtual ErrCode INTERFACE_FUNC	setPublic (Bool isPublic)=0
	Sets the port to be either public or private. More...

virtual ErrCode INTERFACE_FUNC	acceptsSignals (IList signals, IList *accepts)=0
	Checks whether the given signals can be connected to the 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. Sets the local active state and notifies children about the parent active state change. 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...

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

virtual ErrCode INTERFACE_FUNC	getParentActive (Bool *parentActive)=0
	Returns true if the component's parent is active; false otherwise. 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...

virtual ErrCode INTERFACE_FUNC	findProperties (IList *properties, ISearchFilter propertyFilter, ISearchFilter *componentFilter=nullptr)=0
	Retrieves a list of properties from the Property object that match the given property filter. More...

virtual ErrCode INTERFACE_FUNC	setPropertySelectionValue (IString propertyName, IBaseObject value)=0
	Sets the value of a Selection property by the selection item value (e.g. string, float, or list/dict value). More...

virtual ErrCode INTERFACE_FUNC	clearPropertyValues ()=0
	Clears values of all properties contained in the Property object, including nested child properties. 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

◆ getActiveStreamingSource()

virtual ErrCode INTERFACE_FUNC getActiveStreamingSource ( IString ** streamingConnectionString )

pure virtual

Gets a connection strings of the active streaming source of the input port.

Parameters

[out] streamingConnectionString The connection string of active streaming source.

◆ getRemoteId()

virtual ErrCode INTERFACE_FUNC getRemoteId ( IString ** id ) const

pure virtual

Gets the global ID of the input port as it appears on the remote device.

Parameters

[out] id The input port ID.

◆ getStreamingSources()

virtual ErrCode INTERFACE_FUNC getStreamingSources ( IList ** streamingConnectionStrings )

pure virtual

Gets a list of connection strings of all available streaming sources of the input port.

Parameters

[out] streamingConnectionStrings The list of streaming connection strings.

◆ setActiveStreamingSource()

virtual ErrCode INTERFACE_FUNC setActiveStreamingSource ( IString * streamingConnectionString )

pure virtual

Sets the active streaming source of the input port.

Parameters

streamingConnectionString The connection string of streaming source to be set as active.

Return values

OPENDAQ_ERR_NOTFOUND if the streaming source with the corresponding connection string is not part of the available streaming sources for the input port.

Detailed Description

Public Member Functions

Member Function Documentation

◆ getActiveStreamingSource()

◆ getRemoteId()

◆ getStreamingSources()

◆ setActiveStreamingSource()