corbo::MatrixSetSignal Class Reference

Signal containing a set of matrices. More...

#include <signals.h>

Inheritance diagram for corbo::MatrixSetSignal:

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

Public Member Functions
void	add (MatrixSignal::Ptr &matrix_signal)
	Add matrix signal. More...
void	add (const Eigen::Ref< const Eigen::MatrixXd > &matrix, const std::string &label="")
	Add matrix from Eigen type. More...
void	clear ()
const std::vector< MatrixSignal::Ptr > &	getData () const
	Read access to the underlying map object. More...
std::vector< MatrixSignal::Ptr > &	getDataRef ()
	Write access to the underlying map (use with care) More...
SignalType	getType () const override
	Get the signal type according to enumeration SignalType. More...
bool	isEmpty () const
	Check if the underlying map is empty. More...
	MatrixSetSignal ()=default
	Default constructor. 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
std::vector< MatrixSignal::Ptr >	_matrix_set

Additional Inherited Members
Public Attributes inherited from corbo::SignalInterface
SignalHeader	header
	The header of the signal. More...

Detailed Description

Signal containing a set of matrices.

See also

MatrixSignal 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 607 of file signals.h.

Member Typedef Documentation

ConstPtr

using corbo::MatrixSetSignal::ConstPtr = std::shared_ptr<const MatrixSetSignal>

Definition at line 611 of file signals.h.

Map

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

Definition at line 612 of file signals.h.

Ptr

using corbo::MatrixSetSignal::Ptr = std::shared_ptr<MatrixSetSignal>

Definition at line 610 of file signals.h.

Constructor & Destructor Documentation

MatrixSetSignal()

corbo::MatrixSetSignal::MatrixSetSignal ( )

default

Default constructor.

Member Function Documentation

add() [1/2]

void corbo::MatrixSetSignal::add

(

MatrixSignal::Ptr &

matrix_signal

)

Add matrix signal.

Definition at line 252 of file signals.cpp.

add() [2/2]

void corbo::MatrixSetSignal::add	(	const Eigen::Ref< const Eigen::MatrixXd > &	matrix,
		const std::string &	label = ""
	)

Add matrix from Eigen type.

Definition at line 254 of file signals.cpp.

clear()

void corbo::MatrixSetSignal::clear ( )

inline

Definition at line 633 of file signals.h.

getData()

const std::vector<MatrixSignal::Ptr>& corbo::MatrixSetSignal::getData ( ) const

inline

Read access to the underlying map object.

Definition at line 629 of file signals.h.

getDataRef()

std::vector<MatrixSignal::Ptr>& corbo::MatrixSetSignal::getDataRef ( )

inline

Write access to the underlying map (use with care)

Definition at line 631 of file signals.h.

getType()

SignalType corbo::MatrixSetSignal::getType ( ) const

inlineoverridevirtual

Get the signal type according to enumeration SignalType.

Implements corbo::SignalInterface.

Definition at line 621 of file signals.h.

isEmpty()

bool corbo::MatrixSetSignal::isEmpty ( ) const

inline

Check if the underlying map is empty.

Definition at line 618 of file signals.h.

Member Data Documentation

_matrix_set

std::vector<MatrixSignal::Ptr> corbo::MatrixSetSignal::_matrix_set

private

Definition at line 653 of file signals.h.

---

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

• signals.h
• signals.cpp