blockfactory::core::ParameterMetadata Class Reference

Class for storing parameter metadata. More...

#include <Parameter.h>

Detailed Description

Class for storing parameter metadata.

A metadata must be constructed with an index and a name, and they cannot be changed afterwards. Only bool, int, double or std::string types are currently supported.

See also

core::Parameter, core::ParameterType

Public Types
enum	{ DynamicSize = -1 }

Public Member Functions
	ParameterMetadata ()=delete
	~ParameterMetadata ()=default
	ParameterMetadata (const ParameterType &t, const unsigned &ParamIndex, const int &paramRows, const int &paramCols, const std::string &ParamName={})
	ParameterMetadata (const ParameterMetadata &paramMD)
	ParameterMetadata (ParameterMetadata &&paramMD)
ParameterMetadata &	operator= (const ParameterMetadata &paramMD)
ParameterMetadata &	operator= (ParameterMetadata &&paramMD)
bool	operator== (const ParameterMetadata &rhs) const
bool	operator!= (const ParameterMetadata &rhs) const

Public Attributes
const unsigned	index
const std::string	name
int	rows
int	cols
blockfactory::core::ParameterType	type

Member Enumeration Documentation

anonymous enum

Enumerator
DynamicSize

Constructor & Destructor Documentation

blockfactory::core::ParameterMetadata::ParameterMetadata ( )

delete

blockfactory::core::ParameterMetadata::~ParameterMetadata ( )

default

blockfactory::core::ParameterMetadata::ParameterMetadata	(	const ParameterType &	t,
		const unsigned &	ParamIndex,
		const int &	paramRows,
		const int &	paramCols,
		const std::string &	ParamName = {}
	)

blockfactory::core::ParameterMetadata::ParameterMetadata

(

const ParameterMetadata &

paramMD

)

blockfactory::core::ParameterMetadata::ParameterMetadata

(

ParameterMetadata &&

paramMD

)

Member Function Documentation

bool blockfactory::core::ParameterMetadata::operator!= ( const ParameterMetadata &  rhs ) const

inline

ParameterMetadata& blockfactory::core::ParameterMetadata::operator=

(

const ParameterMetadata &

paramMD

)

ParameterMetadata& blockfactory::core::ParameterMetadata::operator=

(

ParameterMetadata &&

paramMD

)

bool blockfactory::core::ParameterMetadata::operator==

(

const ParameterMetadata &

rhs

)

const

Member Data Documentation

int blockfactory::core::ParameterMetadata::cols

const unsigned blockfactory::core::ParameterMetadata::index

const std::string blockfactory::core::ParameterMetadata::name

int blockfactory::core::ParameterMetadata::rows

blockfactory::core::ParameterType blockfactory::core::ParameterMetadata::type

---

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

• /home/travis/build/robotology/blockfactory/sources/Core/include/BlockFactory/Core/Parameter.h