StateUtilFunctions.h File Reference
#include <ArmarXCore/observers/variant/Variant.h>
#include <ArmarXCore/observers/Event.h>
#include <ArmarXCore/interface/statechart/StatechartIce.h>
#include <string>
+ Include dependency graph for StateUtilFunctions.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  TransitionError
 

Namespaces

 armarx
 This file offers overloads of toIce() and fromIce() functions for STL container types.
 
 armarx::StateUtilFunctions
 

Macros

#define DEFINEEVENT(NEWEVENT)
 this macro declares a new event-class derived vom Event, to have a compiletime check for typos in events More...
 

Enumerations

enum  TransitionErrorType { eTransitionErrorUndefined, eTransitionErrorUnexpectedEvent, eTransitionErrorInput, eTransitionNoError }
 

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

Macro Definition Documentation

◆ DEFINEEVENT

#define DEFINEEVENT (   NEWEVENT)
Value:
struct NEWEVENT : Event{ \
NEWEVENT(std::string eventReceiverName): \
Event(eventReceiverName, #NEWEVENT){ }\
};

this macro declares a new event-class derived vom Event, to have a compiletime check for typos in events

Definition at line 36 of file StateUtilFunctions.h.