armarx::control::hardware_config Namespace Reference

Namespaces
	types

Classes
class	Config
	The Config class is the base class of all specialized configurations that have a direct key -> value mapping. More...
class	ConfigElementNotFoundError
	The ConfigElementNotFoundError class represents an error that is thrown when trying to get a config value that is not defined in the config. More...
class	ConfigInsertError
	The ConfigInsertError class represents an error that is thrown if an attempt is mode to set a config value but the value is already defined with the same tag. More...
struct	ConfigItemWithMetadata
	The ConfigItemWithMetadata struct packs the data together with the tag and a isRead flag. More...
class	ConfigParser
class	ControllerConfig
	Config with additional Config objects for controllers. More...
class	DeviceConfig
class	DeviceConfigBase
	A base class that does not have Subdevices or Slaves but can be used for Subdevices or DeviceProfiles. More...
class	HardwareConfig
	Root of the config structure. More...
struct	overloaded
class	ParserError
	The ParserError class represents a generic error that occurs during parsing. More...
class	SlaveConfig
class	SlaveIdentifierConfig
	Data structure holding the information necessary to create a SlaveIdentifier. More...
class	SlaveProfile

Typedefs
using	var_t = std::variant< bool, float, std::uint32_t, std::int32_t, std::list< bool >, std::list< float >, std::list< std::uint32_t >, std::list< std::int32_t >, types::LinearConfig, types::ModularConvertedValueConfig, std::string, Eigen::Matrix< float, Eigen::Dynamic, Eigen::Dynamic >, Eigen::Matrix< std::uint32_t, Eigen::Dynamic, Eigen::Dynamic >, Eigen::Matrix< std::int32_t, Eigen::Dynamic, Eigen::Dynamic > >
	The variant type of the config map. More...

Enumerations
enum	ConfigTag : int { Invalid = -1, TagProfile = 1, TagCustom = 2 }
	The ConfigTag is used when setting a config value. More...
enum	SlaveType { WithType, WithoutType }

Functions
std::string	createErrorMessageWithContext (std::string message, const Config &context)
	Create an error message that prints part of the current Config object to make it easiier to find the place with the erro rin the xml file. More...
std::string	createErrorMessageWithContext (std::string message, RapidXmlReaderNode &context)
template<class... Ts>
	overloaded (Ts...) -> overloaded< Ts... >
template<class T >
void	printList (std::stringstream &s, std::list< T > list)
std::string	tagName (ConfigTag tag)
template<typename T >
std::string	type_name ()

Typedef Documentation

var_t

using var_t = std::variant<bool, float, std::uint32_t, std::int32_t, std::list<bool>, std::list<float>, std::list<std::uint32_t>, std::list<std::int32_t>, types::LinearConfig, types::ModularConvertedValueConfig, std::string, Eigen::Matrix<float, Eigen::Dynamic, Eigen::Dynamic>, Eigen::Matrix<std::uint32_t, Eigen::Dynamic, Eigen::Dynamic>, Eigen::Matrix<std::int32_t, Eigen::Dynamic, Eigen::Dynamic> >

The variant type of the config map.

Definition at line 53 of file Config.h.

Enumeration Type Documentation

ConfigTag

enum ConfigTag : int

The ConfigTag is used when setting a config value.

It allows for checks whether the same config value is defined multiple times on the same hierarchy. The hierarchy is: Custom overwrites Profiles

Enumerator
Invalid
TagProfile
TagCustom

Definition at line 61 of file Config.h.

SlaveType

enum SlaveType

Enumerator
WithType
WithoutType

Definition at line 61 of file SlaveConfig.h.

Function Documentation

createErrorMessageWithContext() [1/2]

std::string createErrorMessageWithContext	(	std::string	message,
		const Config &	context
	)

Create an error message that prints part of the current Config object to make it easiier to find the place with the erro rin the xml file.

Parameters

message	The message that should be printed
context	The Config object that should serve as context

Returns

Definition at line 325 of file Config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

createErrorMessageWithContext() [2/2]

std::string createErrorMessageWithContext	(	std::string	message,
		RapidXmlReaderNode &	context
	)

Definition at line 8 of file ConfigParser.cpp.

Here is the call graph for this function:

overloaded()

armarx::control::hardware_config::overloaded

(

Ts...

)

-> overloaded< Ts... >

printList()

void armarx::control::hardware_config::printList	(	std::stringstream &	s,
		std::list< T >	list
	)

Definition at line 104 of file Config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

tagName()

std::string tagName

(

ConfigTag

tag

)

Definition at line 301 of file Config.cpp.

Here is the caller graph for this function:

type_name()

std::string armarx::control::hardware_config::type_name

(

)

Definition at line 26 of file Config.h.