SlaveConfig Class Reference

#include <armarx/control/hardware_config/SlaveConfig.h>

Inheritance diagram for SlaveConfig:

Public Member Functions
bool	checkAllItemsRead (std::vector< std::string > &errors) const override
	This method is called once the device has read the configuration data it needs.
SlaveIdentifierConfig &	getIdentifier ()
std::optional< std::string >	getName () const
std::optional< std::string >	getType () const
void	onParsingFinished () override
	This method is called when the config is completely read form the HardwareConfig file.
void	print (std::stringstream &s, int indention) const override
	Print this configuration.
	SlaveConfig (SlaveIdentifierConfig identifier, std::optional< std::string > type, std::optional< std::string > name)
	SlaveConfig (SlaveIdentifierConfig identifier, std::optional< std::string > type, std::optional< std::string > name, std::shared_ptr< SlaveProfile > profile)
virtual	~SlaveConfig ()=default
Public Member Functions inherited from Config
	Config ()
bool	getBool (const std::string name)
	Get a Bool typed Config attribute by name.
std::list< bool >	getBoolList (const std::string name)
	Get a BoolList (std::list<bool>) typed Config attribute by name.
float	getFloat (const std::string name)
	Get a Float typed Config attribute by name.
std::list< float >	getFloatList (const std::string name)
	Get a FloatList (std::list<float>) typed Config attribute by name.
std::int32_t	getInt (const std::string name)
	Get a Int (std::int32_t) typed Config attribute by name.
std::list< std::int32_t >	getIntList (const std::string name)
	Get a IntList (std::list<std::int32_t>) typed Config attribute by name.
types::LinearConfig	getLinearConfig (const std::string name)
	Get a LinearConvertedValue typed Config attribute by name.
template<typename Type, int Rows, int Columns>
Eigen::Matrix< Type, Rows, Columns >	getMatrix (const std::string name)
	Get a Matrix by name.
types::ModularConvertedValueConfig	getModularConvertedValueConfig (const std::string &name)
	Get a ModularConvertedValue typed Config attribute by name.
std::string	getString (const std::string name)
	Get a String typed Config attribute by name.
std::uint32_t	getUint (const std::string name)
	Get a Uint (std::uint32_t) typed Config attribute by name.
std::list< std::uint32_t >	getUintList (const std::string name)
	Get a UIntList (std::list<std::uint32_t>) typed Config attribute by name.
virtual	~Config ()=default

Additional Inherited Members
Protected Member Functions inherited from Config
template<typename T>
T	get (const std::string name)
template<typename T>
std::optional< T >	get_nothrow (const std::string name)
template<class T>
void	set (const std::string name, T value, ConfigTag tag)
void	setBool (const std::string name, bool value, ConfigTag tag)
void	setBoolList (const std::string name, std::list< bool > value, ConfigTag tag)
void	setFloat (const std::string name, float value, ConfigTag tag)
void	setFloatList (const std::string name, std::list< float > value, ConfigTag tag)
void	setInt (const std::string name, std::int32_t value, ConfigTag tag)
void	setIntList (const std::string name, std::list< std::int32_t > value, ConfigTag tag)
void	setLinearConfig (const std::string name, types::LinearConfig &&value, ConfigTag tag)
void	setModularConvertedValueConfig (const std::string name, types::ModularConvertedValueConfig &&value, ConfigTag tag)
void	setString (const std::string name, std::string value, ConfigTag tag)
void	setUint (const std::string name, std::uint32_t value, ConfigTag tag)
void	setUintList (const std::string name, std::list< std::uint32_t > value, ConfigTag tag)
Protected Attributes inherited from Config
std::map< std::string, ConfigItemWithMetadata >	items

Constructor & Destructor Documentation

SlaveConfig() [1/2]

SlaveConfig	(	SlaveIdentifierConfig	identifier,
		std::optional< std::string >	type,
		std::optional< std::string >	name )

SlaveConfig() [2/2]

SlaveConfig	(	SlaveIdentifierConfig	identifier,
		std::optional< std::string >	type,
		std::optional< std::string >	name,
		std::shared_ptr< SlaveProfile >	profile )

~SlaveConfig()

virtual ~SlaveConfig ( )

virtualdefault

Member Function Documentation

checkAllItemsRead()

bool checkAllItemsRead ( std::vector< std::string > & errors ) const

overridevirtual

This method is called once the device has read the configuration data it needs.

In this method it should be checked, whether there are entries in this Config (including config objects that are stored in the Config).

Returns

true iff all items in this config have been read

Reimplemented from Config.

getIdentifier()

SlaveIdentifierConfig & getIdentifier

(

)

getName()

std::optional< std::string > getName

(

)

const

getType()

std::optional< std::string > getType

(

)

const

onParsingFinished()

void onParsingFinished ( )

overridevirtual

This method is called when the config is completely read form the HardwareConfig file.

It starts the tracking of which item is read from this Config object.

Reimplemented from Config.

print()

void print ( std::stringstream & s, int indention ) const

overridevirtual

Print this configuration.

Works recursively.

Parameters

s	the stream to append the output to
indention	the indentation (=level of recursion)

Reimplemented from Config.

---

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

• armarx/control/hardware_config/SlaveConfig.h
• armarx/control/hardware_config/SlaveConfig.cpp