Functions
bool	addToDictionary (EventPtr event, const std::string key, const SingleTypeVariantListPtr &valueList)

bool	addToDictionary (EventPtr event, const std::string key, const Variant &value)
	Adds the (key,defaulfValue) pair to the event-dictionary. More...

bool	checkForCompleteParameters (const StateParameterMap &paramMap, std::string *logOutput=nullptr)

void	copyDictionary (const StateParameterMap &source, StateParameterMap &destination)
	Clears the destination map and copies the parameters of the source in it. More...

void	copyDictionary (const StateParameterMap &source, StringVariantContainerBaseMap &destination)
	Clears the destination map and copies the parameters of the source in it. More...

void	copyDictionary (const StringVariantContainerBaseMap &source, StateParameterMap &destination)
	Clears the destination map and copies the parameters of the source in it. More...

void	copyDictionary (const StringVariantContainerBaseMap &source, StringVariantContainerBaseMap &destination)
	Clears the destination map and copies the parameters of the source in it. More...

bool	equalKeys (const StateParameterMap &dict1, const StateParameterMap &dict2)
	Checks whether the maps have equal keys and equal Types. More...

bool	equalKeys (const StringVariantContainerBaseMap &dict1, const StringVariantContainerBaseMap &dict2)
	Checks whether the maps have equal keys and equal Types. More...

void	fillDictionary (const StringVariantContainerBaseMap &source, StateParameterMap &destination)
	Tries to fill the destination map with matching entries of the source map. Entries that could not be found, are not changed. More...

void	fillDictionary (const StringVariantContainerBaseMap &source, StringVariantContainerBaseMap &destination)
	Tries to fill the destination map with matching entries of the source map. Entries that could not be found, are not changed. More...

std::string	getDictionaryString (const StateParameterMap &mymap)
	Converts the map into a string-representation. More...

std::string	getDictionaryString (const StringVariantContainerBaseMap &mymap)
	Converts the map into a string-representation. More...

StringVariantContainerBaseMap	getSetValues (const StateParameterMap &paramMap)

StringVariantContainerBaseMap	getValues (const StateParameterMap &paramMap)

std::string	getVariantString (const VariantBasePtr &var, const std::string &name="")

std::string	getVariantString (const VariantPtr &var, const std::string &name="")

std::string	transitionErrorToString (TransitionErrorType type)

void	unsetParameters (StateParameterMap &paramMap)
	Sets all entries of the given dictionary to the stored default values. More...

bool	waitForChannelRefs (const StateParameterMap &paramMap)
	Waits for all ChannelRefs to be initialized in the given Map. More...

Function Documentation

◆ addToDictionary() [1/2]

bool addToDictionary	(	EventPtr	event,
		const std::string	key,
		const SingleTypeVariantListPtr &	valueList
	)

Definition at line 101 of file StateUtilFunctions.cpp.

◆ addToDictionary() [2/2]

bool addToDictionary	(	EventPtr	event,
		const std::string	key,
		const Variant &	value
	)

Adds the (key,defaulfValue) pair to the event-dictionary.

The type of the entry is determined with defaultValue.

Definition at line 85 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkForCompleteParameters()

bool checkForCompleteParameters	(	const StateParameterMap &	paramMap,
		std::string *	logOutput = `nullptr`
	)

Definition at line 372 of file StateUtilFunctions.cpp.

Here is the caller graph for this function:

◆ copyDictionary() [1/4]

void copyDictionary	(	const StateParameterMap &	source,
		StateParameterMap &	destination
	)

Clears the destination map and copies the parameters of the source in it.

The copies have their own memory.

Definition at line 210 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ copyDictionary() [2/4]

void copyDictionary	(	const StateParameterMap &	source,
		StringVariantContainerBaseMap &	destination
	)

Clears the destination map and copies the parameters of the source in it.

The copies have their own memory.

Definition at line 221 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ copyDictionary() [3/4]

void copyDictionary	(	const StringVariantContainerBaseMap &	source,
		StateParameterMap &	destination
	)

Clears the destination map and copies the parameters of the source in it.

The copies have their own memory.

Definition at line 233 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ copyDictionary() [4/4]

void copyDictionary	(	const StringVariantContainerBaseMap &	source,
		StringVariantContainerBaseMap &	destination
	)

Clears the destination map and copies the parameters of the source in it.

The copies have their own memory.

Definition at line 197 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ equalKeys() [1/2]

bool equalKeys	(	const StateParameterMap &	dict1,
		const StateParameterMap &	dict2
	)

Checks whether the maps have equal keys and equal Types.

Definition at line 120 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ equalKeys() [2/2]

bool equalKeys	(	const StringVariantContainerBaseMap &	dict1,
		const StringVariantContainerBaseMap &	dict2
	)

Checks whether the maps have equal keys and equal Types.

Definition at line 143 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ fillDictionary() [1/2]

void fillDictionary	(	const StringVariantContainerBaseMap &	source,
		StateParameterMap &	destination
	)

Tries to fill the destination map with matching entries of the source map. Entries that could not be found, are not changed.

Definition at line 180 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ fillDictionary() [2/2]

void fillDictionary	(	const StringVariantContainerBaseMap &	source,
		StringVariantContainerBaseMap &	destination
	)

Tries to fill the destination map with matching entries of the source map. Entries that could not be found, are not changed.

Definition at line 164 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDictionaryString() [1/2]

std::string getDictionaryString ( const StateParameterMap & mymap )

Converts the map into a string-representation.

Definition at line 303 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ getDictionaryString() [2/2]

std::string getDictionaryString ( const StringVariantContainerBaseMap & mymap )

Converts the map into a string-representation.

Definition at line 251 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSetValues()

StringVariantContainerBaseMap getSetValues ( const StateParameterMap & paramMap )

Definition at line 56 of file StateUtilFunctions.cpp.

Here is the caller graph for this function:

◆ getValues()

StringVariantContainerBaseMap getValues ( const StateParameterMap & paramMap )

Definition at line 72 of file StateUtilFunctions.cpp.

◆ getVariantString() [1/2]

std::string armarx::StateUtilFunctions::getVariantString	(	const VariantBasePtr &	var,
		const std::string &	name = `""`
	)

Here is the caller graph for this function:

◆ getVariantString() [2/2]

std::string getVariantString	(	const VariantPtr &	var,
		const std::string &	name = `""`
	)

Definition at line 487 of file StateUtilFunctions.cpp.

Here is the call graph for this function:

◆ transitionErrorToString()

std::string transitionErrorToString ( TransitionErrorType type )

Definition at line 38 of file StateUtilFunctions.cpp.

Here is the caller graph for this function:

◆ unsetParameters()

void unsetParameters ( StateParameterMap & paramMap )

Sets all entries of the given dictionary to the stored default values.

Definition at line 470 of file StateUtilFunctions.cpp.

Here is the caller graph for this function:

◆ waitForChannelRefs()

bool waitForChannelRefs ( const StateParameterMap & paramMap )

Waits for all ChannelRefs to be initialized in the given Map.

Times out after some delay.

Parameters

paramMap parameter map, that is to be checked for initialized ChannelRefs

Returns: true if all ChannelRef are initialized

Definition at line 408 of file StateUtilFunctions.cpp.

Here is the call graph for this function: