corbo::MatrixSignal Class Reference

Signal containing a simple matrix. More...

#include <signals.h>

Inheritance diagram for corbo::MatrixSignal:

Public Types
using	ConstPtr = std::shared_ptr< const MatrixSignal >
using	Ptr = std::shared_ptr< MatrixSignal >
Public Types inherited from corbo::SignalInterface
using	ConstPtr = std::shared_ptr< const SignalInterface >
using	Ptr = std::shared_ptr< SignalInterface >

Public Member Functions
int	getColDimension () const
const std::string &	getLabel () const
	Read access to the label. More...
std::string &	getLabelRef ()
	Write access to the label. More...
const Eigen::MatrixXd &	getMatrix () const
	Read access to the underlying matrix object. More...
Eigen::MatrixXd &	getMatrixRef ()
	Write access to the underlying matrix (use with care) More...
int	getRowDimension () const
SignalType	getType () const override
	Get the signal type according to enumeration SignalType. More...
bool	isEmpty () const
	Check if the underlying map is empty. More...
	MatrixSignal ()=default
	Default constructor. More...
	MatrixSignal (const Eigen::Ref< const Eigen::MatrixXd > &matrix, const std::string &label="")
	Construct with matrix. More...
void	set (const Eigen::Ref< const Eigen::MatrixXd > &matrix, const std::string &label="")
	Set matrix (overwrites internal matrix) 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::string	_label
Eigen::MatrixXd	_matrix

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

Detailed Description

Signal containing a simple matrix.

See also

MatrixSetSignal IndexedValuesSetSignal 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 539 of file signals.h.

Member Typedef Documentation

ConstPtr

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

Definition at line 543 of file signals.h.

Ptr

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

Definition at line 542 of file signals.h.

Constructor & Destructor Documentation

MatrixSignal() [1/2]

corbo::MatrixSignal::MatrixSignal ( )

default

Default constructor.

MatrixSignal() [2/2]

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

inlineexplicit

Construct with matrix.

Definition at line 548 of file signals.h.

Member Function Documentation

getColDimension()

int corbo::MatrixSignal::getColDimension ( ) const

inline

Definition at line 557 of file signals.h.

getLabel()

const std::string& corbo::MatrixSignal::getLabel ( ) const

inline

Read access to the label.

Definition at line 572 of file signals.h.

getLabelRef()

std::string& corbo::MatrixSignal::getLabelRef ( )

inline

Write access to the label.

Definition at line 574 of file signals.h.

getMatrix()

const Eigen::MatrixXd& corbo::MatrixSignal::getMatrix ( ) const

inline

Read access to the underlying matrix object.

Definition at line 567 of file signals.h.

getMatrixRef()

Eigen::MatrixXd& corbo::MatrixSignal::getMatrixRef ( )

inline

Write access to the underlying matrix (use with care)

Definition at line 569 of file signals.h.

getRowDimension()

int corbo::MatrixSignal::getRowDimension ( ) const

inline

Definition at line 556 of file signals.h.

getType()

SignalType corbo::MatrixSignal::getType ( ) const

inlineoverridevirtual

Get the signal type according to enumeration SignalType.

Implements corbo::SignalInterface.

Definition at line 554 of file signals.h.

isEmpty()

bool corbo::MatrixSignal::isEmpty ( ) const

inline

Check if the underlying map is empty.

Definition at line 551 of file signals.h.

set()

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

inline

Set matrix (overwrites internal matrix)

Definition at line 560 of file signals.h.

Member Data Documentation

_label

std::string corbo::MatrixSignal::_label

private

Definition at line 595 of file signals.h.

_matrix

Eigen::MatrixXd corbo::MatrixSignal::_matrix

private

Definition at line 594 of file signals.h.

---

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

• signals.h