Public Member Functions | Public Attributes | List of all members
corbo::SignalHeader Struct Reference

Signal header. More...

#include <signals.h>

Public Member Functions

std::string getShortName () const
 

Public Attributes

std::string name = "unknown"
 Unique signal identifier. More...
 
Time time
 Time-stamp. More...
 
int value_dimension = 0
 Dimension of the underlying signal (type-dependent) More...
 
bool zero_order_hold = false
 If true, two consecutive in the signal are intended to be connected via 0-order hold. More...
 

Detailed Description

Signal header.

The signal header stores general information about the underlying signal e.g. its unique identifier, the time-stamp and the dimension of the underlying value (the actual interpretation depends on the specific signal type).

See also
SignalInterface SignalTargetInterface
Author
Christoph Rösmann (chris.nosp@m.toph.nosp@m..roes.nosp@m.mann.nosp@m.@tu-d.nosp@m.ortm.nosp@m.und.d.nosp@m.e)

Definition at line 75 of file signals.h.

Member Function Documentation

◆ getShortName()

std::string corbo::SignalHeader::getShortName ( ) const
inline

Definition at line 82 of file signals.h.

Member Data Documentation

◆ name

std::string corbo::SignalHeader::name = "unknown"

Unique signal identifier.

Definition at line 77 of file signals.h.

◆ time

Time corbo::SignalHeader::time

Time-stamp.

Definition at line 78 of file signals.h.

◆ value_dimension

int corbo::SignalHeader::value_dimension = 0

Dimension of the underlying signal (type-dependent)

Definition at line 79 of file signals.h.

◆ zero_order_hold

bool corbo::SignalHeader::zero_order_hold = false

If true, two consecutive in the signal are intended to be connected via 0-order hold.

Definition at line 80 of file signals.h.


The documentation for this struct was generated from the following file:


control_box_rst
Author(s): Christoph Rösmann
autogenerated on Mon Feb 28 2022 22:08:03