GenericSignalPtr< InterfaceType > Class Template Reference

A signal with an unique ID that sends event/data packets through connections to input ports the signal is connected to. More...

Detailed Description

template<typename InterfaceType>
class GenericSignalPtr< InterfaceType >

A signal with an unique ID that sends event/data packets through connections to input ports the signal is connected to.

A signal features an unique ID within a given device. It sends data along its signal path to all connected input ports, if its set to be active via its active property.

A signal is visible, and its data is streamed to all clients connected to a device only if its public property is set to True.

Each signal has a domain descriptor, which is set by the owner of the signal - most often a function block or device. The descriptor defines all properties of the signal, such as its name, description and data structure.

Signals can have a reference to another signal, which is used for determining the domain data. The domain signal outputs data at the same rate as the signal itself, providing domain (most often time - timestamps) information for each sample sent along the signal path. Each value packet sent by a signal thus contains a reference to another data packet containing domain data (if the signal is associated with another domain signal).

Additionally, a list of related signals can be defined, containing any signals relevant to interpreting the signal data.

To get the list of connections to input ports of the signal, getConnections can be used.

Public Member Functions
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...

Member Function Documentation

getConnections()

daq::ListPtr<daq::IConnection> getConnections ( ) const

inline

Gets the list of connections to input ports formed by the signal.

Returns

The list of connections.

getDescriptor()

daq::DataDescriptorPtr getDescriptor ( ) const

inline

Gets the signal's data descriptor.

Returns

The signal's data descriptor.

The descriptor contains metadata about the signal, providing information about its name, description,... and defines how the data in it's packet's buffers should be interpreted.

getDomainSignal()

daq::SignalPtr getDomainSignal ( ) const

inline

Gets the signal that carries its domain data.

Returns

The domain signal.

The domain signal contains domain (most often time) data that is used to interpret a signal's data in a given domain. It has the same sampling rate as the signal.

getLastValue()

daq::BaseObjectPtr getLastValue ( ) const

inline

Gets the signal last value.

Returns

The IBaseObject value can be a nullptr if there is no value, or if the data type is not supported by the function.

If a value is assigned, it can be cast based on the signal description to IFloat if the type is Float32 or Float64, to IInteger if the type is Int8 through Int64 or UInt8 through UInt64, to IComplexNumber if the type is ComplexFloat32 or ComplexFloat64, to IRange if the type is RangeInt64, to IStruct if the type is Struct, and to IList of the forementioned types if there is exactly one dimension.

getPublic()

daq::Bool getPublic ( ) const

inline

Returns true if the signal is public; false otherwise.

Returns

True if the signal is public; false otherwise.

Public signals are visible to clients connected to the device, and are streamed.

getRelatedSignals()

daq::ListPtr<daq::ISignal> getRelatedSignals ( ) const

inline

Gets a list of related signals.

Returns

The list of related signals.

Signals within the related signals list are facilitate the interpretation of a given signal's data, or are otherwise relevant when working with the signal.

getStreamed()

daq::Bool getStreamed ( ) const

inline

Returns true if the signal is streamed; false otherwise.

Returns

True if the signal is streamed; false otherwise.

A streamed signal receives packets from a streaming server and forwards packets on the signal path. Method always sets streamed parameter to False if the signal is local to the current Instance.

setPublic()

void setPublic ( daq::Bool  isPublic ) const

inline

Sets the signal to be either public or private.

Parameters

isPublic

If false, the signal is set to private; if true, the signal is set to be public.

Public signals are visible to clients connected to the device, and are streamed.

setStreamed()

void setStreamed ( daq::Bool  streamed ) const

inline

Sets the signal to be either streamed or not.

Parameters

streamed

The new streamed state of the signal.

A streamed signal receives packets from a streaming server and forwards packets on the signal path. Setting the "Streamed" flag has no effect if the signal is local to the current Instance. Method returns OPENDAQ_IGNORED if that is the case.