List of all members | Public Member Functions | Friends
DeviceConfig Class Reference

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

+ Inheritance diagram for DeviceConfig:

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.
 
 DeviceConfig (std::string type, std::string name)
 
 DeviceConfig (std::string type, std::string name, std::shared_ptr< DeviceConfigBase > profile)
 
SlaveConfig & getOnlySlaveConfig ()
 
SlaveConfig & getSlaveConfig (const std::string type, const std::string name="")
 
SlaveConfig & getSlaveConfig (const std::uint32_t vendorID, const std::uint32_t productCode, const std::uint32_t serialNumber)
 
DeviceConfigBase & getSubdeviceConfig (const std::string &subDeviceName)
 
std::list< std::reference_wrapper< DeviceConfigBase > > getSubDeviceConfigsWithType (const std::string subDeviceType)
 
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.
 
 ~DeviceConfig ()=default
 
- Public Member Functions inherited from DeviceConfigBase
 DeviceConfigBase (std::string type, std::string name)
 
 DeviceConfigBase (std::string type, std::string name, std::shared_ptr< DeviceConfigBase > profile)
 
std::string getName () const
 
std::string getType () const
 
void print (std::stringstream &s, int indention) const override
 Print this configuration.
 
 ~DeviceConfigBase ()=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
 
- Public Member Functions inherited from ControllerConfig
 ControllerConfig ()
 
Config & getControllerConfig (const std::string controllerName)
 

Friends

class ConfigParser
 

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 Member Functions inherited from ControllerConfig
void addControllerConfig (const std::string controllerName, std::shared_ptr< Config > controllerConfig)
 Add a Config for a controller with name.
 
 ControllerConfig (const ControllerConfig &orig)
 
- Protected Attributes inherited from Config
std::map< std::string, ConfigItemWithMetadata > items
 
- Protected Attributes inherited from ControllerConfig
std::map< std::string, std::shared_ptr< Config > > controllerConfigs
 

Constructor & Destructor Documentation

◆ DeviceConfig() [1/2]

DeviceConfig ( std::string type,
std::string name )

◆ DeviceConfig() [2/2]

DeviceConfig ( std::string type,
std::string name,
std::shared_ptr< DeviceConfigBase > profile )

◆ ~DeviceConfig()

~DeviceConfig ( )
default

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.

◆ getOnlySlaveConfig()

SlaveConfig & getOnlySlaveConfig ( )

◆ getSlaveConfig() [1/2]

SlaveConfig & getSlaveConfig ( const std::string type,
const std::string name = "" )

◆ getSlaveConfig() [2/2]

SlaveConfig & getSlaveConfig ( const std::uint32_t vendorID,
const std::uint32_t productCode,
const std::uint32_t serialNumber )

◆ getSubdeviceConfig()

DeviceConfigBase & getSubdeviceConfig ( const std::string & subDeviceName)

◆ getSubDeviceConfigsWithType()

std::list< std::reference_wrapper< DeviceConfigBase > > getSubDeviceConfigsWithType ( const std::string subDeviceType)

◆ 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
sthe stream to append the output to
indentionthe indentation (=level of recursion)

Reimplemented from Config.

Friends And Related Symbol Documentation

◆ ConfigParser

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