HardwareConfig Class Reference

Root of the config structure. More...

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

Public Member Functions

void addDeviceConfig (const std::string name, std::shared_ptr< DeviceConfig > config)
 Add a DeviceConfig.
 
bool checkAllItemsRead (std::vector< std::string > &errors) const
 This method is called when the config is completely read form the HardwareConfig file.
 
DeviceConfig & getDeviceConfig (std::string name)
 
 HardwareConfig ()
 
void onParsingFinished ()
 This method is called when the config is completely read form the HardwareConfig file.
 

Public Attributes

std::map< std::string, std::shared_ptr< DeviceConfig > > deviceConfigs
 

Friends

std::ostream & operator<< (std::ostream &stream, const HardwareConfig &rhs)
 Print a representation of the entire structure.
 

Detailed Description

Root of the config structure.

Constructor & Destructor Documentation

◆ HardwareConfig()

Member Function Documentation

◆ addDeviceConfig()

void addDeviceConfig ( const std::string name,
std::shared_ptr< DeviceConfig > config )

Add a DeviceConfig.

Parameters
namethe DeviceConfig name
configthe DeviceConfig object

◆ checkAllItemsRead()

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

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.

◆ getDeviceConfig()

DeviceConfig & getDeviceConfig ( std::string name)

◆ onParsingFinished()

void onParsingFinished ( )

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.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream & stream,
const HardwareConfig & rhs )
friend

Print a representation of the entire structure.

Parameters
stream
rhsthe HardwareConfig structure to be printed
Returns

Member Data Documentation

◆ deviceConfigs

std::map<std::string, std::shared_ptr<DeviceConfig> > deviceConfigs

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