MirroredSignalConfigPtr Class Reference

Represents configuration interface for mirrored signals. Allows selecting streaming data sources per signal. More...

Inheritance diagram for MirroredSignalConfigPtr:

Collaboration diagram for MirroredSignalConfigPtr:

Detailed Description

Represents configuration interface for mirrored signals. Allows selecting streaming data sources per signal.

Public Member Functions
daq::StringPtr	getRemoteId () const
	Gets the global ID of the signal as it appears on the remote device. More...
daq::ListPtr< daq::IString >	getStreamingSources () const
	Gets a list of connection strings of all available streaming sources of the signal. More...
void	setActiveStreamingSource (const daq::StringPtr &streamingConnectionString) const
	Sets the active streaming source of the signal. More...
daq::StringPtr	getActiveStreamingSource () const
	Gets a connection strings of the active streaming source of the signal. More...
void	deactivateStreaming () const
	Stops the streaming and clears the active streaming source of the signal.
daq::Event< daq::MirroredSignalConfigPtr, daq::SubscriptionEventArgsPtr >	getOnSubscribeComplete () const
	Gets the Event that is triggered whenever the acknowledgment for signal subscription completion is received from the streaming server. More...
daq::Event< daq::MirroredSignalConfigPtr, daq::SubscriptionEventArgsPtr >	getOnUnsubscribeComplete () const
	Gets the Event that is triggered whenever the acknowledgment for signal unsubscription completion is received from the streaming server. More...
Public Member Functions inherited from GenericSignalConfigPtr< IMirroredSignalConfig >
void	setDescriptor (const daq::DataDescriptorPtr &descriptor) const
	Sets the data descriptor. More...
void	setDomainSignal (const daq::GenericSignalPtr< daq::ISignal > &signal) const
	Sets the domain signal reference. More...
void	setRelatedSignals (const daq::ListPtr< daq::ISignal > &signals) const
	Sets the list of related signals. More...
void	addRelatedSignal (const daq::GenericSignalPtr< daq::ISignal > &signal) const
	Adds a related signal to the list of related signals. More...
void	removeRelatedSignal (const daq::GenericSignalPtr< daq::ISignal > &signal) const
	Removes a signal from the list of related signal. More...
void	clearRelatedSignals () const
	Clears the list of related signals.
void	sendPacket (const daq::PacketPtr &packet) const
	Sends a packet through all connections of the signal. More...
void	sendPacket (daq::PacketPtr &&packet) const
	Sends a packet through all connections of the signal. Ownership of the packet is transfered. More...
void	sendPackets (const daq::ListPtr< daq::IPacket > &packets) const
	Sends multiple packets through all connections of the signal. More...
void	sendPackets (daq::ListPtr< daq::IPacket > &&packets) const
	Sends multiple packets through all connections of the signal. Ownership of the packets is transfered. More...
void	setLastValue (const daq::BaseObjectPtr &lastValue) const
	Sets the last value of the signal. More...
Public Member Functions inherited from GenericSignalPtr< IMirroredSignalConfig >
daq::Bool	getPublic () const
	Returns true if the signal is public; false otherwise. More...
void	setPublic (daq::Bool isPublic) const
	Sets the signal to be either public or private. More...
daq::DataDescriptorPtr	getDescriptor () const
	Gets the signal's data descriptor. More...
daq::SignalPtr	getDomainSignal () const
	Gets the signal that carries its domain data. More...
daq::ListPtr< daq::ISignal >	getRelatedSignals () const
	Gets a list of related signals. More...
daq::ListPtr< daq::IConnection >	getConnections () const
	Gets the list of connections to input ports formed by the signal. More...
daq::Bool	getStreamed () const
	Returns true if the signal is streamed; false otherwise. More...
void	setStreamed (daq::Bool streamed) const
	Sets the signal to be either streamed or not. More...
daq::BaseObjectPtr	getLastValue () const
	Gets the signal last value. More...
Public Member Functions inherited from GenericComponentPtr< IMirroredSignalConfig >
daq::StringPtr	getLocalId () const
	Gets the local ID of the component. More...
daq::StringPtr	getGlobalId () const
	Gets the global ID of the component. More...
daq::Bool	getActive () const
	Returns true if the component is active; false otherwise. More...
void	setActive (daq::Bool active) const
	Sets the component to be either active or inactive. Sets the local active state and notifies children about the parent active state change. More...
daq::ContextPtr	getContext () const
	Gets the context object. More...
daq::ComponentPtr	getParent () const
	Gets the parent of the component. More...
daq::StringPtr	getName () const
	Gets the name of the component. More...
void	setName (const daq::StringPtr &name) const
	Sets the name of the component. More...
daq::StringPtr	getDescription () const
	Gets the description of the component. More...
void	setDescription (const daq::StringPtr &description) const
	Sets the description of the component. More...
daq::TagsPtr	getTags () const
	Gets the tags of the component. More...
daq::Bool	getVisible () const
	Gets visible metadata state of the component. More...
void	setVisible (daq::Bool visible) const
	Sets visible attribute state of the component. More...
daq::ListPtr< daq::IString >	getLockedAttributes () const
	Gets a list of the component's locked attributes. The locked attributes cannot be modified via their respective setters. More...
daq::Event< daq::ComponentPtr, daq::CoreEventArgsPtr >	getOnComponentCoreEvent () const
	Gets the Core Event object that triggers whenever a change to this component happens within the openDAQ core structure. More...
daq::ComponentStatusContainerPtr	getStatusContainer () const
	Gets the container of Component statuses. More...
daq::ComponentPtr	findComponent (const daq::StringPtr &id) const
	Finds the component (signal/device/function block) with the specified (global) id. More...
daq::OperationModeType	getOperationMode () const
	Gets the operation mode of the device. More...
daq::Bool	getLocalActive () const
	Returns true if the component is local active; false otherwise. More...
daq::Bool	getParentActive () const
	Returns true if the component's parent is active; false otherwise. More...
Public Member Functions inherited from GenericPropertyObjectPtr< IMirroredSignalConfig >
daq::StringPtr	getClassName () const
	Gets the name of the class the Property object was constructed with. More...
void	setPropertyValue (const daq::StringPtr &propertyName, const daq::BaseObjectPtr &value) const
	Sets the value of the Property with the given name. More...
daq::BaseObjectPtr	getPropertyValue (const daq::StringPtr &propertyName) const
	Gets the value of the Property with the given name. More...
daq::BaseObjectPtr	getPropertySelectionValue (const daq::StringPtr &propertyName) const
	Gets the selected value of the Property, if the Property is a Selection property. More...
void	clearPropertyValue (const daq::StringPtr &propertyName) const
	Clears the Property value from the Property object. More...
daq::Bool	hasProperty (const daq::StringPtr &propertyName) const
	Checks if the Property object contains a property named propertyName. More...
daq::PropertyPtr	getProperty (const daq::StringPtr &propertyName) const
	Gets the Property with the given propertyName. More...
void	addProperty (const daq::PropertyPtr &property) const
	Adds the property to the Property object. More...
void	removeProperty (const daq::StringPtr &propertyName) const
	Removes the Property named propertyName from the Property object. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnPropertyValueWrite (const daq::StringPtr &propertyName) const
	Gets the Event that is triggered whenever a Property value is written to the Property named propertyName. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnPropertyValueRead (const daq::StringPtr &propertyName) const
	Gets the Event that is triggered whenever a Property value of a Property named propertyName is read. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnAnyPropertyValueWrite () const
	Gets the Event that is triggered whenever any Property value is written. The event is triggered after the specific Property event. More...
daq::Event< daq::PropertyObjectPtr, daq::PropertyValueEventArgsPtr >	getOnAnyPropertyValueRead () const
	Gets the Event that is triggered whenever any Property value is read.The event is triggered after the specific Property event. More...
daq::ListPtr< daq::IProperty >	getVisibleProperties () const
	Returns a list of visible properties contained in the Property object. More...
daq::ListPtr< daq::IProperty >	getAllProperties () const
	Returns a list of all properties contained in the Property object. More...
void	setPropertyOrder (const daq::ListPtr< daq::IString > &orderedPropertyNames) const
	Sets a custom order of properties as defined in the list of property names. More...
void	beginUpdate () const
	Begins batch configuration of the object. More...
void	endUpdate () const
	Ends batch configuration of the object. More...
daq::Bool	getUpdating () const
	Returns the state of batch configuration. More...
daq::Event< daq::PropertyObjectPtr, daq::EndUpdateEventArgsPtr >	getOnEndUpdate () const
	Gets the Event that is triggered whenever the batch configuration is applied. More...
daq::PermissionManagerPtr	getPermissionManager () const
	Gets the permission manager of property object. More...
daq::ListPtr< daq::IProperty >	findProperties (const daq::SearchFilterPtr &propertyFilter, const daq::SearchFilterPtr &componentFilter=nullptr) const
	Retrieves a list of properties from the Property object that match the given property filter. More...
void	setPropertySelectionValue (const daq::StringPtr &propertyName, const daq::BaseObjectPtr &value) const
	Sets the value of a Selection property by the selection item value (e.g. string, float, or list/dict value). More...
void	clearPropertyValues () const
	Clears values of all properties contained in the Property object, including nested child properties. More...

Member Function Documentation

getActiveStreamingSource()

daq::StringPtr getActiveStreamingSource ( ) const

inline

Gets a connection strings of the active streaming source of the signal.

Returns

The connection string of active streaming source.

getOnSubscribeComplete()

daq::Event< daq::MirroredSignalConfigPtr, daq::SubscriptionEventArgsPtr > getOnSubscribeComplete ( ) const

inline

Gets the Event that is triggered whenever the acknowledgment for signal subscription completion is received from the streaming server.

Returns

The Event representing the acknowledgment of signal subscription completion.

A handler can be added to the event containing a callback function which is invoked whenever the event is triggered. The callback function requires two parameters - a MirroredSignalConfig object, as well as a "Subscription event args" object. The callback will be invoked with the MirroredSignalConfig object as the first argument, the second argument holds an event args object that contains the connection string of streaming and the event type (Subscribed).

getOnUnsubscribeComplete()

daq::Event< daq::MirroredSignalConfigPtr, daq::SubscriptionEventArgsPtr > getOnUnsubscribeComplete ( ) const

inline

Gets the Event that is triggered whenever the acknowledgment for signal unsubscription completion is received from the streaming server.

Returns

The Event representing the acknowledgment of signal unsubscription completion.

A handler can be added to the event containing a callback function which is invoked whenever the event is triggered. The callback function requires two parameters - a MirroredSignalConfig object, as well as a "Subscription event args" object. The callback will be invoked with the MirroredSignalConfig object as the first argument, the second argument holds an event args object that contains the connection string of streaming and the event type (Unsubscribed).

getRemoteId()

daq::StringPtr getRemoteId ( ) const

inline

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

Returns

The signal ID.

getStreamingSources()

daq::ListPtr< daq::IString > getStreamingSources ( ) const

inline

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

Returns

The list of streaming connection strings.

setActiveStreamingSource()

void setActiveStreamingSource ( const daq::StringPtr &  streamingConnectionString ) const

inline

Sets the active streaming source of the signal.

Parameters

streamingConnectionString

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

Exceptions

NotFoundException

if the streaming source with the corresponding connection string is not * part of the available streaming sources for the signal.