Public Types | Public Member Functions | Private Attributes | List of all members
corbo::IndexedValuesSetSignal Class Reference

Signal containing values indexed by an integer (int to double[] map) More...

#include <signals.h>

Inheritance diagram for corbo::IndexedValuesSetSignal:
Inheritance graph
[legend]

Public Types

using ConstPtr = std::shared_ptr< const IndexedValuesSetSignal >
 
using Map = std::map< int, std::vector< double > >
 
using Ptr = std::shared_ptr< IndexedValuesSetSignal >
 
- Public Types inherited from corbo::SignalInterface
using ConstPtr = std::shared_ptr< const SignalInterface >
 
using Ptr = std::shared_ptr< SignalInterface >
 

Public Member Functions

void add (int index, double value)
 Add index value pair. More...
 
void add (const IndexedValuesSignal &indexed_values)
 Add from IndexedValuesSignal. More...
 
void add (int index, const Eigen::Ref< const Eigen::VectorXd > &values)
 Add several values to the desired index. More...
 
void add (int index, const std::vector< double > &values)
 Add several values to the desired index (STL version) More...
 
void clear ()
 
const MapgetData () const
 Read access to the underlying map object. More...
 
MapgetDataRef ()
 Write access to the underlying map (use with care) More...
 
int getMaxValueDimension () const
 Iterate internal map to find the largest value vector dimension. More...
 
SignalType getType () const override
 Get the signal type according to enumeration SignalType. More...
 
 IndexedValuesSetSignal ()=default
 Default constructor. More...
 
bool isEmpty () const
 Check if the underlying map is empty. More...
 
- Public Member Functions inherited from corbo::SignalInterface
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...
 

Private Attributes

Map _values_map
 

Additional Inherited Members

- Public Attributes inherited from corbo::SignalInterface
SignalHeader header
 The header of the signal. More...
 

Detailed Description

Signal containing values indexed by an integer (int to double[] map)

See also
IndexedValuesSignal SignalInterface Measurement
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 474 of file signals.h.

Member Typedef Documentation

◆ ConstPtr

Definition at line 478 of file signals.h.

◆ Map

using corbo::IndexedValuesSetSignal::Map = std::map<int, std::vector<double> >

Definition at line 479 of file signals.h.

◆ Ptr

Definition at line 477 of file signals.h.

Constructor & Destructor Documentation

◆ IndexedValuesSetSignal()

corbo::IndexedValuesSetSignal::IndexedValuesSetSignal ( )
default

Default constructor.

Member Function Documentation

◆ add() [1/4]

void corbo::IndexedValuesSetSignal::add ( int  index,
double  value 
)

Add index value pair.

Definition at line 174 of file signals.cpp.

◆ add() [2/4]

void corbo::IndexedValuesSetSignal::add ( const IndexedValuesSignal indexed_values)

Add from IndexedValuesSignal.

Definition at line 176 of file signals.cpp.

◆ add() [3/4]

void corbo::IndexedValuesSetSignal::add ( int  index,
const Eigen::Ref< const Eigen::VectorXd > &  values 
)

Add several values to the desired index.

Definition at line 181 of file signals.cpp.

◆ add() [4/4]

void corbo::IndexedValuesSetSignal::add ( int  index,
const std::vector< double > &  values 
)

Add several values to the desired index (STL version)

Definition at line 186 of file signals.cpp.

◆ clear()

void corbo::IndexedValuesSetSignal::clear ( )
inline

Definition at line 507 of file signals.h.

◆ getData()

const Map& corbo::IndexedValuesSetSignal::getData ( ) const
inline

Read access to the underlying map object.

Definition at line 500 of file signals.h.

◆ getDataRef()

Map& corbo::IndexedValuesSetSignal::getDataRef ( )
inline

Write access to the underlying map (use with care)

Definition at line 502 of file signals.h.

◆ getMaxValueDimension()

int corbo::IndexedValuesSetSignal::getMaxValueDimension ( ) const

Iterate internal map to find the largest value vector dimension.

Definition at line 191 of file signals.cpp.

◆ getType()

SignalType corbo::IndexedValuesSetSignal::getType ( ) const
inlineoverridevirtual

Get the signal type according to enumeration SignalType.

Implements corbo::SignalInterface.

Definition at line 488 of file signals.h.

◆ isEmpty()

bool corbo::IndexedValuesSetSignal::isEmpty ( ) const
inline

Check if the underlying map is empty.

Definition at line 485 of file signals.h.

Member Data Documentation

◆ _values_map

Map corbo::IndexedValuesSetSignal::_values_map
private

Definition at line 527 of file signals.h.


The documentation for this class was generated from the following files:


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