#include <ArmarXCore/statechart/RemoteStateOfferer.h>

Inheritance diagram for RemoteStateOffererBase:

Classes
struct	RemoteStateData

Public Member Functions
RemoteStatePtr	addDynamicRemoteState (std::string instanceName) override
	Overridden so that the user cannot use it. More...

RemoteStatePtr	addRemoteState (std::string stateName, std::string proxyName, std::string instanceName) override
	Overridden so that the user cannot use it. More...

bool	breakActiveSubstateRemotely (int stateId, const EventBasePtr &evt, const ::Ice::Current &context=Ice::emptyCurrent) override

bool	breakRemoteState (int stateId, const EventBasePtr &evt, const ::Ice::Current &context=Ice::emptyCurrent) override

void	callRemoteState (int stateId, const StringVariantContainerBaseMap &properties, const Ice::Current &context=Ice::emptyCurrent) override

int	createRemoteStateInstance (const std::string &stateName, const RemoteStateIceBasePrx &remoteStatePrx, const std::string &parentStateItentifierStr, const std::string &instanceName, const Ice::Current &context=Ice::emptyCurrent) override

CreateRemoteStateInstanceOutput	createRemoteStateInstanceNew (CreateRemoteStateInstanceInput const &input, Ice::Current const &context) override

void	exitRemoteState (int stateId, const ::Ice::Current &context=Ice::emptyCurrent) override

StateIdNameMap	getAvailableStateInstances (const ::Ice::Current &context=Ice::emptyCurrent) override

Ice::StringSeq	getAvailableStates (const ::Ice::Current &context=Ice::emptyCurrent) override

std::map< int, StateBasePtr >	getChildStatesByName (int parentId, std::string stateName)

StateBasePtr	getGlobalInstancePtr (int globalId) const

RemoteStateData	getInstance (int stateId)

StateParameterMap	getRemoteInputParameters (const std::string &stateName, const ::Ice::Current &context=Ice::emptyCurrent) override

StateParameterMap	getRemoteInputParametersById (int stateId, const ::Ice::Current &context=Ice::emptyCurrent) override

StateParameterMap	getRemoteOutputParameters (const std::string &stateName, const ::Ice::Current &context=Ice::emptyCurrent) override

StateParameterMap	getRemoteOutputParametersById (int stateId, const ::Ice::Current &context=Ice::emptyCurrent) override

StateIceBasePtr	getStatechart (const std::string &stateName, const ::Ice::Current &context=Ice::emptyCurrent) override

StateIceBasePtr	getStatechartInstance (int stateId, const Ice::Current &=Ice::emptyCurrent) override

StateIceBasePtr	getStatechartInstanceByGlobalIdStr (const std::string &globalStateIdStr, const Ice::Current &=Ice::emptyCurrent) override

StateIceBasePtr	getStatechartInstanceByGlobalIdStrRecursive (const std::string &globalStateIdStr, StateBasePtr state, int &stateCounter)

virtual std::string	getStateOffererName () const =0
	Implement this function to specify the RemoteStateOfferer prefix. More...

virtual StateBasePtr	getStatePtr (const std::string &stateName) const

bool	hasActiveSubstateRemote (int stateId, const ::Ice::Current &context=Ice::emptyCurrent) override

bool	hasSubstatesRemote (const std::string &stateName, const ::Ice::Current &context=Ice::emptyCurrent) const override

void	initState (State &state)

bool	isHostOfStateByGlobalIdStr (const std::string &globalStateIdStr, const Ice::Current &=Ice::emptyCurrent) override

bool	isRemoteStateFinished (int stateId, const ::Ice::Current &context=Ice::emptyCurrent) override

void	issueEvent (int receivingStateId, const EventBasePtr &evt, const Ice::Current &=Ice::emptyCurrent) override

void	issueEventWithGlobalIdStr (const std::string &globalStateIdStr, const EventBasePtr &evt, const Ice::Current &=Ice::emptyCurrent) override

void	notifyEventBufferedDueToUnbreakableStateRemote (int stateId, bool eventBuffered, const ::Ice::Current &context=Ice::emptyCurrent) override

virtual void	onConnectRemoteStateOfferer ()
	Virtual function, in which the user can fetch some proxies. More...

void	onConnectStatechartImpl ()

virtual void	onExitRemoteStateOfferer ()
	Virtual function, in which the user can implement some clean up. More...

void	onExitStatechartImpl ()

virtual void	onInitRemoteStateOfferer ()=0
	Pure virtual function, in which the states must be added, that should be remote-accessable. More...

StateIceBasePtr	refetchRemoteSubstates (int stateId, const ::Ice::Current &context=Ice::emptyCurrent) override

void	removeInstance (int stateId, const Ice::Current &=Ice::emptyCurrent) override

void	run () override
	Virtual function, that can be reimplemented to calculate complex operations. More...

void	updateGlobalStateIdRecursive (int stateId, const std::string &parentId, const Ice::Current &context=Ice::emptyCurrent) override

virtual void	waitUntilComponentStarted ()=0

Public Member Functions inherited from State
StateBasePtr	addState (StateBasePtr pNewState)

template<>
StatePtr	addState (std::string const &stateName)

template<>
StatePtr	addState (std::string const &stateName)

template<class derivedState >
IceInternal::Handle< derivedState >	addState (std::string const &stateName="")
	Function to add a new substate to this state. Should be called in the defineState()-function. More...

bool	addToInput (const std::string &key, const ContainerType &type, bool optional, VariantContainerBasePtr defaultValue=VariantContainerBasePtr())
	Adds a key,type-pair to the input parameters. More...

bool	addToInput (const std::string &key, VariantTypeId type, bool optional, VariantPtr defaultValue=VariantPtr())
	Adds a new parameter list to the input parameters with a specific type. More...

bool	addToLocal (const std::string &key, const ContainerType &type, VariantContainerBasePtr defaultValue=VariantContainerBasePtr())
	Adds a new parameter list to the local parameters with a specific type. More...

bool	addToLocal (const std::string &key, VariantTypeId type, VariantPtr defaultValue=VariantPtr())
	Adds a key,type-pair to the local parameters. More...

bool	addToOutput (const std::string &key, const ContainerType &type, bool optional)
	Adds a new parameter list to the output parameters with a specific type. More...

bool	addToOutput (const std::string &key, VariantTypeId type, bool optional)
	Adds a key,type-pair to the output parameters. More...

TransitionIceBase &	addTransition (EventPtr event, StateIceBasePtr sourceState, StateIceBasePtr destinationState, ParameterMappingIceBasePtr mappingToNextStatesInput=nullptr, ParameterMappingIceBasePtr mappingToParentStatesLocal=nullptr, ParameterMappingIceBasePtr mappingToParentStatesOutput=nullptr)

template<class EventType >
TransitionIceBase &	addTransition (StateIceBasePtr sourceState, StateIceBasePtr destinationState, ParameterMappingIceBasePtr mappingToNextStatesInput=nullptr, ParameterMappingIceBasePtr mappingToParentStatesLocal=nullptr, ParameterMappingIceBasePtr mappingToParentStatesOutput=nullptr)
	Function to add a new transition between to substates to this state. More...

template<class EventType >
TransitionIceBase &	addTransitionFromAllStates (StateIceBasePtr destinationState, ParameterMappingIceBasePtr mappingToNextStatesInput=nullptr, ParameterMappingIceBasePtr mappingToParentStatesLocal=nullptr, ParameterMappingIceBasePtr mappingToParentStatesOutput=nullptr)
	Function to add a new transition from all substates to `destinationState`. More...

void	cancelSubstates ()
	Use this function in the onEnter() function, if you want to avoid that the substates (i.e. More...

StateBasePtr	clone () const override
	Generates a new copy of this state with the same statename, substates, transitions, overidden functions etc. More...

StateBasePtr	createEmptyCopy () const override
	Generates a new copy of this state with the same overidden functions. stateName, substates, transition etc. are not set. More...

std::string	getGlobalIdString () const
	Getter for the global state identifier string. More...

unsigned int	getId () const
	Returns an id to this state, that is guaranteed to be unique in this process. More...

StateBasePtr	getInitState () const
	Getter for the initial state. The initial state is automatically entered, when this state is entered. More...

template<typename T >
std::enable_if_t< std::is_base_of_v< VariantDataClass, T >, IceInternal::Handle< T > >	getInput (const std::string &key) const
	getInput can be used to access a specific input parameter. More...

template<typename T >
std::enable_if_t< !(std::is_base_of_v< VariantDataClass, T >\|\|std::is_base_of_v< VariantContainerBase, T >), T >	getInput (const std::string &key) const
	getInput can be used to access a specific input parameter. More...

VariantPtr	getInput (const std::string &key) const
	getInput can be used to access a specific input parameter. More...

StateParameterMap	getInputParameters () override
	Returns a new copy of the inputparameters-dictionary, so that the caller cannot modify them (const won't work due to pointers). More...

template<typename T >
std::enable_if_t< std::is_base_of_v< VariantDataClass, T >, IceInternal::Handle< T > >	getLocal (const std::string &key) const
	getLocal can be used to access a specific input parameter. More...

template<typename T >
std::enable_if_t< !(std::is_base_of_v< VariantDataClass, T >\|\|std::is_base_of_v< VariantContainerBase, T >), T >	getLocal (const std::string &key) const
	getLocal can be used to access a specific input parameter. More...

VariantContainerBasePtr	getLocalContainer (std::string const &key)

StateParameterMap &	getLocalParameters ()
	Getter for the local parameter map. More...

template<typename T >
std::enable_if_t< std::is_base_of_v< VariantDataClass, T >, IceInternal::Handle< T > >	getOutput (const std::string &key) const
	getOutput can be used to access a specific input parameter. More...

template<typename T >
std::enable_if_t< !(std::is_base_of_v< VariantDataClass, T >\|\|std::is_base_of_v< VariantContainerBase, T >), T >	getOutput (const std::string &key) const
	getOutput can be used to access a specific input parameter. More...

StateParameterMap &	getOutputParameters () override
	getter function to get the map of output parameters More...

void	inheritInputFromSubstate (std::string stateName)

bool	init (StatechartContextInterface context, StatechartManager manager)
	Function to initialize this state. Must be called in the highest level of the hierarchy - and only there. More...

bool	isInputParameterSet (const std::string &key) const
	Checks whether a given input parameter is set or not. More...

bool	isLocalParameterSet (const std::string &key) const

bool	isOutputParameterSet (const std::string &key) const

bool	isUnbreakable () const

StateBasePtr	setInitState (StateBasePtr initState, ParameterMappingPtr initialStateMapping=ParameterMappingPtr())
	Sets the initial substate of this state. More...

void	setInput (std::string const &key, const Variant &value)
	setInput() sets an input parameter. More...

void	setInput (std::string const &key, const VariantContainerBase &valueList)
	setInput() sets an input parameter list. More...

void	setLocal (std::string const &key, const Variant &value)
	setLocal() sets a local parameter. More...

void	setLocal (std::string const &key, const VariantContainerBase &valueList)
	setLocal() sets a local parameter list. More...

void	setOutput (std::string const &key, const Variant &value)
	setOuput() sets an output parameter of this state. More...

void	setOutput (std::string const &key, const VariantContainerBase &valueList)
	setOuput() sets an output parameter LIST of this state. More...

void	setStateClassNameFromTypeName (const std::string &typeName)

void	setStateName (const std::string &newName)

void	setUnbreakable (bool setUnbreakable=true)
	With this function the state can be made unbreakable. More...

void	setUseRunFunction (bool useRunFuntion)
	setUseRunFunction can be used to configurate whether the thread with the async. More...

Public Member Functions inherited from StateUtility
template<class EventClass >
EventPtr	createEvent ()
	Utility function to create a new Event. More...

EventPtr	createEvent (const std::string &eventName, const StringVariantContainerBaseMap &properties=StringVariantContainerBaseMap())
	Utility function to create a new Event. More...

Public Member Functions inherited from StateController
bool	__applyMappings (const StateControllerPtr &srcState, const TransitionIceBase &t, const EventPtr &event, TransitionError &error)
	Apply the mappings during a transitions. More...

virtual bool	__breakActiveSubstate (const EventPtr event)

bool	__checkExistenceOfTransition (const TransitionIceBase &transition)

virtual void	__enqueueEvent (const EventPtr event)

virtual void	__finalize (const EventPtr event)
	Function that gets called, when a state enters a FinalSubstate. Virtual function, so that RemoteStateWrapper can override it. More...

bool	__findValidTransition (const EventPtr &event, const StateIceBasePtr &sourceState, TransitionIceBase &resultTransition, TransitionError &error) const

StateControllerPtr	__getParentState () const
	Getter function that automatically casts the parentState member of StateBase into StateControllerPtr. More...

virtual unsigned int	__getUnbreakableBufferSize () const

virtual bool	__getUnbreakableBufferStati () const
	Before:Function to get the unbreakable-buffer status of all parent state - recursively. More...

virtual void	__notifyEventBufferedDueToUnbreakableState (bool eventBuffered=true)

void	__printTransitionError (const TransitionError &transitionError, const EventPtr &event) const

virtual void	__processBufferedEvents ()
	Processes buffered events, that could not be processed immediately due to unbreakable substates. More...

virtual void	__processEvent (const EventPtr event, bool buffered=false)
	Main function to control the statemachine/state. More...

virtual void	__substatesFinished (const EventPtr ev)
	Function that gets called, when a state enters a FinalSubstate. Virtual function, so that RemoteStateWrapper can override it. More...

TransitionError	__validateTransition (const TransitionIceBase &transition, const EventPtr event, const StateIceBasePtr &sourceState, const StateIceBasePtr &destinationState) const

void	__waitForRemoteStates () const

virtual bool	_baseOnBreak (const EventPtr evt)
	Called by StateControllerprocessEvent()-function or parentstate. Must NOT be called by user. More...

virtual void	_baseOnEnter ()
	Called by StateControllerprocessEvent()-function or parentstate. More...

virtual void	_baseOnExit ()
	Called by StateController::processEvent()-function or parentstate. Must NOT be called by user. More...

virtual void	_baseRun ()

virtual void	_startRun ()

void	addProfilerRecursive (Profiler::ProfilerPtr profiler, int recursiveLevels=0)
	addProfilerRecursive recursively adds a new armarx::Profiler::Profiler object as armarx::StateController::localProfiler(the default one does not do anything at all). More...

void	addTransitionFunction (const TransitionIceBase &t, transitionFunction function)

void	disableRunFunction ()
	disableRunFunction sets useRunFunction to false and waits (blocking) for the current StateBase::run() function to complete. More...

void	disableStateReporting (bool disable=true)
	Disables the reporting to profilers for this states during state visits. More...

void	enter (const StringVariantContainerBaseMap &tempInputParameters=StringVariantContainerBaseMap())
	Function to set the statemachine in the first state and call OnEnter(). More...

bool	findTransition (const std::string &eventName, const std::string sourceStateName, TransitionIceBase &transition)

std::string	getTransitionID (const std::string &eventName, const std::string sourceStateName) const

std::string	getTransitionID (const TransitionIceBase &t) const

bool	isFinished () const

bool	isRunningTaskFinished () const
	Checks whether the run() function has already finished. More...

bool	isRunningTaskStopped () const
	isRunningTaskStopped checks whether the RunningTask, that executes run() is requested to stop. More...

void	removeProfilerRecursive (Profiler::ProfilerPtr profiler, int recursiveLevels=0)

	StateController ()

	StateController (const StateController &source)

void	waitForRunningTaskToFinish () const
	Waits until the run-function has finished. More...

void	waitForStateToFinish (int timeoutMs=-1) const
	waitForStateToFinish waits until this thread has finished (i.e. More...

	~StateController () override

Public Member Functions inherited from StateBase
void	__checkPhase (const std::vector< StatePhase > &allowedTypes, const char *functionName) const

void	__checkPhase (StatePhase allowedType, const char *functionName) const
	Helper function for checking if a function was called in valid position of the statechart. More...

void	__checkPhaseMin (StatePhase allowedType, const char *functionName) const

void	__copyDefaultValuesToInput ()

StringVariantContainerBaseMap	__getSetInputAndLocalParameters () const
	Combines both maps to one map and returns a new map of only the set parameters. More...

virtual bool	__hasActiveSubstate ()
	Virtual function to indicate wheter a state has an active substate or not. To be overridden by RemoteState to deligate the call to the real state. More...

virtual bool	__hasSubstates ()
	Virtual function to indicate wheter a state has substates or not. To be overridden by RemoteState to deligate the call to the real state. More...

void	__setParentState (StateBase *parentState)

void	__throwUnknownParameter (const StateParameterMap &paramMap, const std::string &key) const

void	__updateGlobalStateId ()

virtual void	__updateGlobalStateIdRecursive ()

bool	addParameter (StateParameterMap &paramMap, const std::string &key, VariantTypeId type, bool optional, VariantPtr defaultValue=VariantPtr()) const

bool	addParameterContainer (StateParameterMap &paramMap, const std::string &key, const ContainerType &containerType, bool optional, VariantContainerBasePtr defaultValue=VariantContainerBasePtr()) const

void	clearSelfPointer ()

virtual void	deepCopy (const StateBase &sourceState, bool reset=true)
	Function to copy the states with all it substates and transitions. More...

virtual void	defineParameters ()
	Virtual function, in which input/local/output parameters can be specified. More...

virtual void	defineState ()
	Virtual function, in which this state can be configured. More...

virtual void	defineSubstates ()
	Virtual function, in which substates, transition and mappings can be added. More...

StateBasePtr	findSubstateByName (const std::string &substateName)
	Utility function to find a substate of this state by the name. More...

template<typename ContextType >
ContextType *	getContext () const

StatechartContextInterface *	getContext (bool checkNULL=true) const

std::string	getGlobalHierarchyString () const

std::string	getLocalHierarchyString () const
	Function to get a string that contains als parent states and this state. (e.g. "Robot->Functional->Idling") More...

Ice::Int	getLocalUniqueId () const

void	getParameter (const StateParameterMap &paramMap, const std::string &key, VariantPtr &value) const

void	getParameterContainer (const StateParameterMap &paramMap, const std::string &key, VariantContainerBasePtr &valueContainer) const

const std::string &	getStateClassName () const

std::string	getStateName () const
	getStateName More...

StatePhase	getStatePhase () const

EventPtr	getTriggeredEndstateEvent () const
	This function returns the event that was triggered by entering an endstate. More...

void	inheritInputParameters ()

bool	init (StatechartContextInterface context, StatechartManager manager)
	Function to initialize this state. Must be called in the highest level of the hierarchy - and only there. More...

virtual bool	isInitialized () const
	Returns the status of this state. Only if a state is initialized, it can be used. More...

bool	isParameterSet (const StateParameterMap &paramMap, const std::string &key) const

virtual void	onBreak ()
	Virtual function, in which the behaviour of state is defined, when it is abnormally exited. Can be overridden, but it is optional. An abnormal exit only occurs in hierarchy-levels greater 1. When a parent state is left before the substates are finished, the OnBreak()-function is called in the active substate and in all it's active substates. If this function is not implemented, the normal OnExit()-function is called. More...

virtual void	onEnter ()
	Virtual function, in which the behaviour of state is defined, when it is entered. Can be overridden, but it is optional. More...

virtual void	onExit ()
	Virtual function, in which the behaviour of state is defined, when it is exited. Can be overridden, but it is optional. More...

StateBase &	operator= (const StateBase &source)

virtual void	refetchSubstates ()
	This functions updates the substates. More...

void	reset ()
	Function to reset the state: clear name, clear substatesList, clear transition etc. More...

void	setContext (StatechartContextInterface *context)

void	setInitialized (bool enable)

void	setParameter (StateParameterMap &paramMap, const std::string &key, const Variant &variant)

void	setParameterContainer (StateParameterMap &paramMap, const std::string &key, const VariantContainerBase &valueContainer)

void	setParameterContainer (StateParameterMap &paramMap, const std::string &key, const VariantContainerBasePtr &valueContainer)

void	setStateClassName (std::string className)
	setStateClassName() sets the string, that contains a stringrepresentation of this class. Should not be called usually. The classname gets automatically set in the constructor of the derived class StateTemplate<T>. More...

void	setStatePhase (StatePhase newPhase)

	StateBase ()

	StateBase (const StateBase &source)

virtual bool	waitForInitialization (int timeoutMS=-1) const

	~StateBase () override

Public Member Functions inherited from Logging
SpamFilterDataPtr	deactivateSpam (float deactivationDurationSec=10.0f, const std::string &identifier="", bool deactivate=true) const
	disables the logging for the current line for the given amount of seconds. More...

MessageTypeT	getEffectiveLoggingLevel () const

	Logging ()

void	setLocalMinimumLoggingLevel (MessageTypeT level)
	With setLocalMinimumLoggingLevel the minimum verbosity-level of log-messages can be set. More...

void	setTag (const LogTag &tag)

void	setTag (const std::string &tagName)

virtual	~Logging ()

Public Attributes
std::string	componentName

std::map< int, RemoteStateData >	stateInstanceList
	Holds the instances that where requested from remotely located states. More...

HiddenTimedMutex	stateInstanceListMutex

Public Attributes inherited from StateController
std::unique_ptr< Impl >	cimpl

Public Attributes inherited from StateBase
std::unique_ptr< Impl >	impl

Additional Inherited Members
Public Types inherited from StateController
using	transitionFunction = std::function< void(StateController *state, const StateIceBasePtr &nextState, const StateIceBasePtr &previousState)>

using	TransitionFunctionMap = std::map< std::string, transitionFunction >

Public Types inherited from StateBase
enum	StatePhase { ePreDefined, eStatechartDefinitions, eSubstatesDefinitions, eParametersDefinitions, eDefined, eEntering, eEntered, eBreaking, eExiting, eExited }
	enum that specifies the phase in which the state is currently in used to control the usage of state-functions in the correct context More...

Static Public Member Functions inherited from StateBase
static std::vector< StateBasePtr >	GetActiveStateLeafs (StateBasePtr toplevelState)

Protected Member Functions inherited from State
State &	operator= (const State &source)

	State ()

	State (const State &source)

	~State () override

Protected Member Functions inherited from StateUtility
ConditionIdentifier	installCondition (const Term &condition, const EventPtr evt, const std::string &desc="")
	Utility function to install a condition on the distributed conditionhandler. More...

template<class Eventclass >
ConditionIdentifier	installCondition (const Term &condition, const std::string &desc="")
	Utility function to install a condition on the distributed conditionhandler. More...

void	removeCondition (ConditionIdentifier conditionId)
	Utility function to remove an installed condition on the distributed conditionhandler. More...

void	removeCounterEvent (const ActionEventIdentifier &id)

void	removeTimeoutEvent (const ActionEventIdentifier &id)

void	sendEvent (const EventPtr event, StateBasePtr eventProcessor=nullptr)
	Function to send an event to a specific state from an onEnter()-function. Must not be called anywhere else. The event is processed after the onEnter()-function of this and all initial substates have returned. Use of this function should be avoided since this statemachine is blocked until this event and all subsequent sendEvents() are processed. More...

template<class Event >
void	sendEvent (StateBasePtr eventProcessor=nullptr)

ActionEventIdentifier	setCounterEvent (int counterThreshold, const EventPtr &evt, int initialValue=0)

template<class Eventclass >
ActionEventIdentifier	setCounterEvent (int counterThreshold, int initialValue=0)

template<class Eventclass >
ActionEventIdentifier	setTimeoutEvent (int timeoutDurationMs)

ActionEventIdentifier	setTimeoutEvent (int timeoutDurationMs, const EventPtr &evt)
	Utility function to start a timer on the systemObserver and register an event on the conditionHandler. The condition is automatically removed, when the state is left. More...

Protected Member Functions inherited from Logging
bool	checkLogLevel (MessageTypeT level) const

const LogSenderPtr &	getLogSender () const
	Retrieve log sender. More...

LogSenderPtr	loghelper (const char file, int line, const char function) const

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Detailed Description

Definition at line 46 of file RemoteStateOfferer.h.

Member Function Documentation

◆ addDynamicRemoteState()

RemoteStatePtr addDynamicRemoteState ( std::string instanceName )

overridevirtual

Overridden so that the user cannot use it.

Reimplemented from State.

Definition at line 463 of file RemoteStateOfferer.cpp.

◆ addRemoteState()

RemoteStatePtr addRemoteState	(	std::string	stateName,
		std::string	proxyName,
		std::string	instanceName
	)

overridevirtual

Overridden so that the user cannot use it.

Reimplemented from State.

Definition at line 458 of file RemoteStateOfferer.cpp.

◆ breakActiveSubstateRemotely()

bool breakActiveSubstateRemotely	(	int	stateId,
		const EventBasePtr &	evt,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 212 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ breakRemoteState()

bool breakRemoteState	(	int	stateId,
		const EventBasePtr &	evt,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 187 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ callRemoteState()

void callRemoteState	(	int	stateId,
		const StringVariantContainerBaseMap &	properties,
		const Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 170 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ createRemoteStateInstance()

int createRemoteStateInstance	(	const std::string &	stateName,
		const RemoteStateIceBasePrx &	remoteStatePrx,
		const std::string &	parentStateItentifierStr,
		const std::string &	instanceName,
		const Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 92 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ createRemoteStateInstanceNew()

CreateRemoteStateInstanceOutput createRemoteStateInstanceNew	(	CreateRemoteStateInstanceInput const &	input,
		Ice::Current const &	context
	)

override

Definition at line 16 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ exitRemoteState()

void exitRemoteState	(	int	stateId,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 182 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getAvailableStateInstances()

StateIdNameMap getAvailableStateInstances ( const ::Ice::Current & context = Ice::emptyCurrent )

override

Definition at line 286 of file RemoteStateOfferer.cpp.

◆ getAvailableStates()

Ice::StringSeq getAvailableStates ( const ::Ice::Current & context = Ice::emptyCurrent )

override

Definition at line 274 of file RemoteStateOfferer.cpp.

◆ getChildStatesByName()

std::map< int, StateBasePtr > getChildStatesByName	(	int	parentId,
		std::string	stateName
	)

Definition at line 535 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getGlobalInstancePtr()

StateBasePtr getGlobalInstancePtr ( int globalId ) const

Definition at line 491 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstance()

RemoteStateOffererBase::RemoteStateData getInstance ( int stateId )

Definition at line 468 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRemoteInputParameters()

StateParameterMap getRemoteInputParameters	(	const std::string &	stateName,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 234 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getRemoteInputParametersById()

StateParameterMap getRemoteInputParametersById	(	int	stateId,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 246 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getRemoteOutputParameters()

StateParameterMap getRemoteOutputParameters	(	const std::string &	stateName,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 240 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getRemoteOutputParametersById()

StateParameterMap getRemoteOutputParametersById	(	int	stateId,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 251 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getStatechart()

StateIceBasePtr getStatechart	(	const std::string &	stateName,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 300 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getStatechartInstance()

StateIceBasePtr getStatechartInstance	(	int	stateId,
		const Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 307 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ getStatechartInstanceByGlobalIdStr()

StateIceBasePtr getStatechartInstanceByGlobalIdStr	(	const std::string &	globalStateIdStr,
		const Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 314 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatechartInstanceByGlobalIdStrRecursive()

StateIceBasePtr getStatechartInstanceByGlobalIdStrRecursive	(	const std::string &	globalStateIdStr,
		StateBasePtr	state,
		int &	stateCounter
	)

Definition at line 569 of file RemoteStateOfferer.cpp.

Here is the caller graph for this function:

◆ getStateOffererName()

virtual std::string getStateOffererName ( ) const

pure virtual

Implement this function to specify the RemoteStateOfferer prefix.

Note: Do not override getDefaultName()!

Implemented in RobotControl, XMLRemoteStateOfferer< ContextType >, and RemoteAccessableState.

Here is the caller graph for this function:

◆ getStatePtr()

StateBasePtr getStatePtr ( const std::string & stateName ) const

virtual

Definition at line 508 of file RemoteStateOfferer.cpp.

Here is the caller graph for this function:

◆ hasActiveSubstateRemote()

bool hasActiveSubstateRemote	(	int	stateId,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 269 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ hasSubstatesRemote()

bool hasSubstatesRemote	(	const std::string &	stateName,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)		const

override

Definition at line 257 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ initState()

void initState ( State & state )

Definition at line 636 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ isHostOfStateByGlobalIdStr()

bool isHostOfStateByGlobalIdStr	(	const std::string &	globalStateIdStr,
		const Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 361 of file RemoteStateOfferer.cpp.

◆ isRemoteStateFinished()

bool isRemoteStateFinished	(	int	stateId,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 207 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ issueEvent()

void issueEvent	(	int	receivingStateId,
		const EventBasePtr &	evt,
		const Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 418 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ issueEventWithGlobalIdStr()

void issueEventWithGlobalIdStr	(	const std::string &	globalStateIdStr,
		const EventBasePtr &	evt,
		const Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 445 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ notifyEventBufferedDueToUnbreakableStateRemote()

void notifyEventBufferedDueToUnbreakableStateRemote	(	int	stateId,
		bool	eventBuffered,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 217 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ onConnectRemoteStateOfferer()

void onConnectRemoteStateOfferer ( )

virtual

Virtual function, in which the user can fetch some proxies.

Reimplemented in RobotControl.

Definition at line 8 of file RemoteStateOfferer.cpp.

Here is the caller graph for this function:

◆ onConnectStatechartImpl()

void onConnectStatechartImpl ( )

Definition at line 597 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ onExitRemoteStateOfferer()

void onExitRemoteStateOfferer ( )

virtual

Virtual function, in which the user can implement some clean up.

Reimplemented in RobotControl.

Definition at line 12 of file RemoteStateOfferer.cpp.

Here is the caller graph for this function:

◆ onExitStatechartImpl()

void onExitStatechartImpl ( )

Definition at line 603 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ onInitRemoteStateOfferer()

virtual void onInitRemoteStateOfferer ( )

pure virtual

Pure virtual function, in which the states must be added, that should be remote-accessable.

Implemented in RobotControl, and RemoteAccessableState.

◆ refetchRemoteSubstates()

StateIceBasePtr refetchRemoteSubstates	(	int	stateId,
		const ::Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 224 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ removeInstance()

void removeInstance	(	int	stateId,
		const Ice::Current &	= `Ice::emptyCurrent`
	)

override

Definition at line 401 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

void run ( )

overridevirtual

Virtual function, that can be reimplemented to calculate complex operations.

It runs in it's own thread.

This function is called after onEnter(). This function can continue to run even if the state has been left (onExit() has been called), but all calculations will be discarded (Output- and Localparameters will be reseted).
Calls to external components will still be executed!
Calls to sendEvent() will be ignored, after the state has been left.

Note: Before re-entering this state, the state waits for this function from the last state-visit to complete. The implementation of run should constantly check, if StateController::isRunningTaskStopped() returns true and exit the run-function in that case.

Reimplemented from StateBase.

Definition at line 632 of file RemoteStateOfferer.cpp.

◆ updateGlobalStateIdRecursive()

void updateGlobalStateIdRecursive	(	int	stateId,
		const std::string &	parentId,
		const Ice::Current &	context = `Ice::emptyCurrent`
	)

override

Definition at line 158 of file RemoteStateOfferer.cpp.

Here is the call graph for this function:

◆ waitUntilComponentStarted()

virtual void waitUntilComponentStarted ( )

pure virtual

Here is the caller graph for this function:

Member Data Documentation

◆ componentName

std::string componentName

Definition at line 162 of file RemoteStateOfferer.h.

◆ stateInstanceList

std::map<int, RemoteStateData> stateInstanceList

Holds the instances that where requested from remotely located states.

Definition at line 161 of file RemoteStateOfferer.h.

◆ stateInstanceListMutex

HiddenTimedMutex stateInstanceListMutex

Definition at line 159 of file RemoteStateOfferer.h.

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

ArmarXCore/statechart/RemoteStateOfferer.h
ArmarXCore/statechart/RemoteStateOfferer.cpp

Classes

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addDynamicRemoteState()

◆ addRemoteState()

◆ breakActiveSubstateRemotely()

◆ breakRemoteState()

◆ callRemoteState()

◆ createRemoteStateInstance()

◆ createRemoteStateInstanceNew()

◆ exitRemoteState()

◆ getAvailableStateInstances()

◆ getAvailableStates()

◆ getChildStatesByName()

◆ getGlobalInstancePtr()

◆ getInstance()

◆ getRemoteInputParameters()

◆ getRemoteInputParametersById()

◆ getRemoteOutputParameters()

◆ getRemoteOutputParametersById()

◆ getStatechart()

◆ getStatechartInstance()

◆ getStatechartInstanceByGlobalIdStr()

◆ getStatechartInstanceByGlobalIdStrRecursive()

◆ getStateOffererName()

◆ getStatePtr()

◆ hasActiveSubstateRemote()

◆ hasSubstatesRemote()

◆ initState()

◆ isHostOfStateByGlobalIdStr()

◆ isRemoteStateFinished()

◆ issueEvent()

◆ issueEventWithGlobalIdStr()

◆ notifyEventBufferedDueToUnbreakableStateRemote()

◆ onConnectRemoteStateOfferer()

◆ onConnectStatechartImpl()

◆ onExitRemoteStateOfferer()

◆ onExitStatechartImpl()

◆ onInitRemoteStateOfferer()

◆ refetchRemoteSubstates()

◆ removeInstance()

◆ run()

◆ updateGlobalStateIdRecursive()

◆ waitUntilComponentStarted()

Member Data Documentation

◆ componentName

◆ stateInstanceList

◆ stateInstanceListMutex