openDAQ
Open data acquisition platform
GenericSignalConfigPtr< InterfaceType > Class Template Reference

The configuration component of a Signal. Allows for configuration of its properties, managing its streaming sources, and sending packets through its connections. More...

+ Inheritance diagram for GenericSignalConfigPtr< InterfaceType >:
+ Collaboration diagram for GenericSignalConfigPtr< InterfaceType >:

Detailed Description

template<typename InterfaceType>
class GenericSignalConfigPtr< InterfaceType >

The configuration component of a Signal. Allows for configuration of its properties, managing its streaming sources, and sending packets through its connections.

The Signal config is most often accessible only to the devices or function blocks that own the signal. They react on property, or input signal changes to modify a signal's data descriptor, and send processed/acquired data down its signal path.

Public Member Functions

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 sendPackets (const daq::ListPtr< daq::IPacket > &packets) const
 Sends multiple packets 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 (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< InterfaceType >
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< InterfaceType >
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. Also recursively sets the active field of all child components if component is a folder. 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...
 
- Public Member Functions inherited from GenericPropertyObjectPtr< InterfaceType >
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...