Signal

Collaboration diagram for Signal:

Detailed Description

Modules
	Factories

Classes
struct	ISignal
	A signal with an unique ID that sends event/data packets through connections to input ports the signal is connected to. More...
struct	ISignalConfig
	The configuration component of a Signal. Allows for configuration of its properties, managing its streaming sources, and sending packets through its connections. More...
struct	ISignalEvents
	Internal functions of a signal containing event methods that are called on certain events. Eg. when a signal is connected to an input port, or when a signal is used as a domain signal of another. More...
struct	ISignalPrivate
	Internal functions used by openDAQ core. This interface should never be used in client SDK or module code. More...
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. More...
class	SignalEventsPtr
	Internal functions of a signal containing event methods that are called on certain events. Eg. when a signal is connected to an input port, or when a signal is used as a domain signal of another. More...
class	SignalPrivatePtr
	Internal functions used by openDAQ core. This interface should never be used in client SDK or module code. More...
class	GenericSignalPtr< InterfaceType >
	A signal with an unique ID that sends event/data packets through connections to input ports the signal is connected to. More...

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

Function Documentation

addRelatedSignal()

void addRelatedSignal ( const daq::GenericSignalPtr< daq::ISignal > &  signal ) const

inline

Adds a related signal to the list of related signals.

Parameters

signal

The signal to be added.

Exceptions

DuplicateItemException

if the signal is already present in the list.

removeRelatedSignal()

void removeRelatedSignal ( const daq::GenericSignalPtr< daq::ISignal > &  signal ) const

inline

Removes a signal from the list of related signal.

Parameters

signal

The signal to be removed.

Exceptions

NotFoundException

if the signal is not part of the list.

sendPacket() [1/2]

void sendPacket ( const daq::PacketPtr &  packet ) const

inline

Sends a packet through all connections of the signal.

Parameters

packet

The packet to be sent.

sendPacket() [2/2]

void sendPacket ( daq::PacketPtr &&  packet ) const

inline

Sends a packet through all connections of the signal. Ownership of the packet is transfered.

Parameters

packet

The packet to be sent.

After calling the method, the packet should not be touched again. The ownership of the packet is taken by underlying connections and it could be destroyed before the function returns.

sendPackets() [1/2]

void sendPackets ( const daq::ListPtr< daq::IPacket > &  packets ) const

inline

Sends multiple packets through all connections of the signal.

Parameters

packets

The packets to be sent.

Sending multiple packets creates a single notification to input port.

sendPackets() [2/2]

void sendPackets ( daq::ListPtr< daq::IPacket > &&  packets ) const

inline

Sends multiple packets through all connections of the signal. Ownership of the packets is transfered.

Parameters

packets

The packets to be sent.

After calling the method, the packets should not be touched again. The ownership of the packets is taken by underlying connections and they could be destroyed before the function returns.

setDescriptor()

void setDescriptor ( const daq::DataDescriptorPtr &  descriptor ) const

inline

Sets the data descriptor.

Parameters

descriptor

The data descriptor.

Setting the data descriptor triggers a Descriptor changed event packet to be sent to all connections of the signal. If the signal is a domain signal of another, that signal also sends a Descriptor changed event to all its connections.

setDomainSignal()

void setDomainSignal ( const daq::GenericSignalPtr< daq::ISignal > &  signal ) const

inline

Sets the domain signal reference.

Parameters

signal

The domain signal.

Setting a new domain signal triggers a Descriptor changed event packet to be sent to all connections of the signal.

setLastValue()

void setLastValue ( const daq::BaseObjectPtr &  lastValue ) const

inline

Sets the last value of the signal.

Parameters

lastValue

The lastValue.

This method is used to manually set the last value of the signal. Useful when automatic calculation of last value is disabled, usually due to performance reasons.

setRelatedSignals()

void setRelatedSignals ( const daq::ListPtr< daq::ISignal > &  signals ) const

inline

Sets the list of related signals.

Parameters

signals

The list of related signals.