Interface class for signals. More...
#include <signals.h>
Public Types | |
| using | ConstPtr = std::shared_ptr< const SignalInterface > |
| using | Ptr = std::shared_ptr< SignalInterface > |
Public Member Functions | |
| virtual SignalType | getType () const =0 |
| Get the signal type according to enumeration SignalType. More... | |
| virtual void | getValueLabels (std::vector< std::string > &sublabels) const |
| Return labels for the underlying components of the signal (e.g. axes labels) More... | |
| virtual | ~SignalInterface () |
| Virtual destructor. More... | |
Public Attributes | |
| SignalHeader | header |
| The header of the signal. More... | |
Detailed Description
Interface class for signals.
Signals are generated in certain modules like controllers, obervers or tasks in order to provide internal data (e.g. measurements, states, statistics, ...). Signals are usually derived from SignalInterface which implements an adapter to the actually data including general signal information (refer to SignalHeader).
Signals are identified using unique names. Signalnamespaces can be set using a "/" as delimiter, e.g.: /c this/is/a_signal/with/namespaces. Names can only be composed of alphanumeric characters and underscores (_).
In general signals are provided as data stream and hence multiple signals with different time stamps can share the same identifier (name). Signals are usually sent/streamed to a SignalTargetInterface.
- See also
- SignalHeader SignalTargetInterface
Member Typedef Documentation
◆ ConstPtr
| using corbo::SignalInterface::ConstPtr = std::shared_ptr<const SignalInterface> |
◆ Ptr
| using corbo::SignalInterface::Ptr = std::shared_ptr<SignalInterface> |
Constructor & Destructor Documentation
◆ ~SignalInterface()
|
inlinevirtual |
Member Function Documentation
◆ getType()
|
pure virtual |
Get the signal type according to enumeration SignalType.
Implemented in corbo::MatrixSetSignal, corbo::MatrixSignal, corbo::IndexedValuesSetSignal, corbo::IndexedValuesSignal, corbo::TimeSeriesSequenceSignal, corbo::TimeSeriesSignal, and corbo::Measurement.
◆ getValueLabels()
|
inlinevirtual |
Return labels for the underlying components of the signal (e.g. axes labels)
Reimplemented in corbo::TimeSeriesSequenceSignal, corbo::TimeSeriesSignal, and corbo::Measurement.
Member Data Documentation
◆ header
| SignalHeader corbo::SignalInterface::header |
The documentation for this class was generated from the following file: