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. More...
 
bool checkAllItemsRead (std::vector< std::string > &errors) const
 This method is called when the config is completely read form the HardwareConfig file. More...
 
DeviceConfiggetDeviceConfig (std::string name)
 
 HardwareConfig ()
 
void onParsingFinished ()
 This method is called when the config is completely read form the HardwareConfig file. More...
 

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. More...
 

Detailed Description

Root of the config structure.

Definition at line 14 of file HardwareConfig.h.

Constructor & Destructor Documentation

◆ HardwareConfig()

Definition at line 5 of file HardwareConfig.cpp.

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

Definition at line 31 of file HardwareConfig.cpp.

+ Here is the caller graph for this function:

◆ 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.

Definition at line 42 of file HardwareConfig.cpp.

◆ getDeviceConfig()

DeviceConfig & getDeviceConfig ( std::string  name)

Definition at line 10 of file HardwareConfig.cpp.

◆ 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.

Definition at line 22 of file HardwareConfig.cpp.

+ Here is the caller graph for this function:

Friends And Related Function 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

Definition at line 29 of file HardwareConfig.h.

Member Data Documentation

◆ deviceConfigs

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

Definition at line 59 of file HardwareConfig.h.


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