#include <ArmarXGui/gui-plugins/StatechartViewerPlugin/StateWatcher.h>

Inheritance diagram for StateWatcher:

Classes
struct	StateListenerData

Public Types
using	StateListenerDataMap = std::map< std::string, StateListenerData >

Public Types inherited from ManagedIceObject
using	PeriodicTaskPtr = IceUtil::Handle< SimplePeriodicTask< std::function< void(void)> >>

Public Member Functions
void	clear ()

std::string	getDefaultName () const override
	Retrieve default name of component. More...

VariantPtr	getStateParameter (statechartmodel::StatePtr state, const std::string paramMapType) const

::armarx::StateParameterMap	getStateParameterMap (statechartmodel::StatePtr state, const std::string paramMapType) const

void	reportEvent (const ProfilerEvent &, const Ice::Current &) override

void	reportEventList (const ProfilerEventList &, const Ice::Current &) override

void	reportNetworkTraffic (const std::string &, const std::string &, Ice::Int, Ice::Int, const Ice::Current &) override

void	reportProcessCpuUsage (const ProfilerProcessCpuUsage &, const Ice::Current &) override

void	reportProcessCpuUsageList (const ProfilerProcessCpuUsageList &, const Ice::Current &) override

void	reportProcessMemoryUsage (const ProfilerProcessMemoryUsage &, const Ice::Current &) override

void	reportProcessMemoryUsageList (const ProfilerProcessMemoryUsageList &, const Ice::Current &) override

void	reportStatechartInputParameters (const ProfilerStatechartParameters &event, const Ice::Current &) override

void	reportStatechartInputParametersList (const ProfilerStatechartParametersList &data, const Ice::Current &) override

void	reportStatechartLocalParameters (const ProfilerStatechartParameters &event, const Ice::Current &) override

void	reportStatechartLocalParametersList (const ProfilerStatechartParametersList &, const Ice::Current &) override

void	reportStatechartOutputParameters (const ProfilerStatechartParameters &, const Ice::Current &) override

void	reportStatechartOutputParametersList (const ProfilerStatechartParametersList &, const Ice::Current &) override

void	reportStatechartTransition (const ProfilerStatechartTransition &event, const Ice::Current &) override

void	reportStatechartTransitionList (const ProfilerStatechartTransitionList &, const Ice::Current &) override

void	reportStatechartTransitionWithParameters (const ProfilerStatechartTransitionWithParameters &, const Ice::Current &) override

void	reportStatechartTransitionWithParametersList (const ProfilerStatechartTransitionWithParametersList &, const Ice::Current &) override

	StateWatcher ()

bool	subscribeToState (StateIceBasePtr iceState, statechartmodel::StatePtr state)

bool	subscribeToState (StateIceBasePtr iceState, StateItem *state)

bool	unsubscribeState (StateItem *state)

Public Member Functions inherited from ManagedIceObject
void	enableProfiler (bool enable)
	setProfiler allows setting ManagedIceObject::profiler to a new instance (if the new instance is actually not a null pointer) More...

std::string	generateSubObjectName (const std::string &subObjectName)
	Generates a unique name for a sub object from a general name. More...

ArmarXManagerPtr	getArmarXManager () const
	Returns the ArmarX manager used to add and remove components. More...

ManagedIceObjectConnectivity	getConnectivity () const
	Retrieve connectivity of the object (topcis as well as proxies) More...

IceManagerPtr	getIceManager () const
	Returns the IceManager. More...

VariantBasePtr	getMetaInfo (const std::string &id)

StringVariantBaseMap	getMetaInfoMap () const

std::string	getName () const
	Retrieve name of object. More...

Ice::ObjectAdapterPtr	getObjectAdapter () const
	Returns object's Ice adapter. More...

ArmarXObjectSchedulerPtr	getObjectScheduler () const

PeriodicTaskPtr	getPeriodicTask (const std::string &name)

Profiler::ProfilerPtr	getProfiler () const
	getProfiler returns an instance of armarx::Profiler More...

template<class ProxyTarg , class... Args>
void	getProxy (const char *name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&...args)

template<class ProxyType >
ProxyType	getProxy (const std::string &name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Retrieves a proxy object. More...

template<class ProxyTarg , class... Args>
void	getProxy (const std::string &name, IceInternal::ProxyHandle< ProxyTarg > &proxy, Args &&...args)

template<class ProxyTarg , class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const char *name, Args &&...args)

template<class ProxyTarg , class... Args>
void	getProxy (IceInternal::ProxyHandle< ProxyTarg > &proxy, const std::string &name, Args &&...args)
	Assigns a proxy to `proxy`. More...

Ice::ObjectPrx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const
	Returns the proxy of this object (optionally it waits for the proxy) More...

template<class Prx >
Prx	getProxy (long timeoutMs=0, bool waitForScheduler=true) const

template<class ProxyType >
void	getProxy (ProxyType &proxy, const char *name, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
	Overload to allow using string literals as name (solve ambiguous overload). More...

template<class Prx >
void	getProxy (Prx &prx, long timeoutMs=0, bool waitForScheduler=true) const

int	getState () const
	Retrieve current state of the ManagedIceObject. More...

template<class TopicProxyType >
TopicProxyType	getTopic (const std::string &name)
	Returns a proxy of the specified topic. More...

template<class TopicProxyType >
void	getTopic (TopicProxyType &topicProxy, const std::string &name)
	Assigns a proxy of the specified topic to `topicProxy`. More...

std::vector< std::string >	getUnresolvedDependencies () const
	returns the names of all unresolved dependencies More...

	ManagedIceObject (ManagedIceObject const &other)

void	offeringTopic (const std::string &name)
	Registers a topic for retrival after initialization. More...

void	preambleGetTopic (std::string const &name)

void	setMetaInfo (const std::string &id, const VariantBasePtr &value)
	Allows to set meta information that can be queried live via Ice interface on the ArmarXManager. More...

void	startPeriodicTask (const std::string &uniqueName, std::function< void(void)> f, int periodMs, bool assureMeanInterval=false, bool forceSystemTime=true)

bool	stopPeriodicTask (const std::string &name)

bool	unsubscribeFromTopic (const std::string &name)
	Unsubscribe from a topic. More...

bool	usingProxy (const std::string &name, const std::string &endpoints="")
	Registers a proxy for retrieval after initialization and adds it to the dependency list. More...

void	usingTopic (const std::string &name, bool orderedPublishing=false)
	Registers a proxy for subscription after initialization. More...

void	waitForObjectScheduler ()
	Waits until the ObjectScheduler could resolve all dependencies. More...

void	waitForProxy (std::string const &name, bool addToDependencies)

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 ()

Static Public Member Functions
static std::string	ExtractStateName (const std::string globalIdString)

Static Public Member Functions inherited from ManagedIceObject
static std::string	generateSubObjectName (const std::string &superObjectName, const std::string &subObjectName)
	Generates a unique name for a sub object from a general name and unique name. More...

static std::string	GetObjectStateAsString (int state)

Protected Types
using	SubscriptionMap = std::vector< std::pair< StateIceBasePtr, std::pair< statechartmodel::StatePtr, StateItem * > > >

Protected Member Functions
void	onConnectComponent () override
	Pure virtual hook for the subclass. More...

void	onDisconnectComponent () override
	Hook for subclass. More...

void	onInitComponent () override
	Pure virtual hook for the subclass. More...

void	subscriptionFunction ()

Protected Member Functions inherited from ManagedIceObject
template<class PluginT , class... ParamsT>
PluginT *	addPlugin (const std::string prefix="", ParamsT &&...params)

template<class PluginT , class... ParamsT>
void	addPlugin (PluginT *&targ, const std::string prefix="", ParamsT &&...params)

template<class PluginT , class... ParamsT>
void	addPlugin (std::experimental::observer_ptr< PluginT > &targ, const std::string prefix="", ParamsT &&...params)

Ice::CommunicatorPtr	getCommunicator () const

std::unique_ptr< ManagedIceObjectPlugin > &	getPluginPointer (std::type_info const &type, std::string const &prefix)

	ManagedIceObject ()
	Protected default constructor. More...

virtual void	onExitComponent ()
	Hook for subclass. More...

virtual void	postOnConnectComponent ()

virtual void	postOnDisconnectComponent ()

virtual void	postOnExitComponent ()

virtual void	postOnInitComponent ()

virtual void	preOnConnectComponent ()

virtual void	preOnDisconnectComponent ()

virtual void	preOnExitComponent ()

virtual void	preOnInitComponent ()

bool	removeProxyDependency (const std::string &name)
	This function removes the dependency of this object on the in parameter name specified object. More...

void	setName (std::string name)
	Override name of well-known object. More...

void	terminate ()
	Initiates termination of this IceManagedObject. More...

	~ManagedIceObject () override

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
ConditionHandlerInterfacePrx	conditionHandler

std::mutex	mapMutex

ProfilerObserverInterfacePrx	profilerObserver

StateListenerDataMap	stateMap

SubscriptionMap	subscriptionQueue

PeriodicTask< StateWatcher >::pointer_type	subscriptionTask

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Additional Inherited Members
Static Public Attributes inherited from ManagedIceObject
static const ManagedIceObjectPtr	NullPtr
	A nullptr to be used when a const ref to a nullptr is required. More...

Detailed Description

Definition at line 36 of file StateWatcher.h.

Member Typedef Documentation

◆ StateListenerDataMap

using StateListenerDataMap = std::map<std::string, StateListenerData>

Definition at line 52 of file StateWatcher.h.

◆ SubscriptionMap

using SubscriptionMap = std::vector<std::pair<StateIceBasePtr, std::pair<statechartmodel::StatePtr, StateItem*> > >

protected

Definition at line 77 of file StateWatcher.h.

Constructor & Destructor Documentation

◆ StateWatcher()

StateWatcher ( )

Definition at line 40 of file StateWatcher.cpp.

Member Function Documentation

◆ clear()

void clear ( )

Definition at line 243 of file StateWatcher.cpp.

Here is the caller graph for this function:

◆ ExtractStateName()

std::string ExtractStateName ( const std::string globalIdString )

static

Definition at line 250 of file StateWatcher.cpp.

Here is the caller graph for this function:

◆ getDefaultName()

std::string getDefaultName ( ) const

overridevirtual

Retrieve default name of component.

Implement this method in each IceManagedObject. The default name of a is used if no name is specified in the factory method.

Returns: default name of the component (e.g. "KinematicUnit")

Implements ManagedIceObject.

Definition at line 260 of file StateWatcher.cpp.

◆ getStateParameter()

VariantPtr getStateParameter	(	statechartmodel::StatePtr	state,
		const std::string	paramMapType
	)		const

Definition at line 181 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ getStateParameterMap()

armarx::StateParameterMap getStateParameterMap	(	statechartmodel::StatePtr	state,
		const std::string	paramMapType
	)		const

Definition at line 208 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ onConnectComponent()

void onConnectComponent ( )

overrideprotectedvirtual

Pure virtual hook for the subclass.

Is called once all dependencies of the object have been resolved and Ice connection is established. This hook is called whenever the dependencies are found. That means if the a depedency crashes or shuts down, the ManagedIceObject goes into disconnected state. When the dependencies are found again, this hook is called again.

See also: onDisconnectComponent()

Implements ManagedIceObject.

Definition at line 50 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ onDisconnectComponent()

void onDisconnectComponent ( )

overrideprotectedvirtual

Hook for subclass.

Is called if a dependency of the object got lost (crash, network error, stopped, ...). This hook should be the inverse to onConnectComponent(). So that onDisconnectComponent() and onConnectComponent() can be called alternatingly and the ManagedIceObject remains in valid states. *

See also: onConnectComponent

Reimplemented from ManagedIceObject.

Definition at line 59 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ onInitComponent()

void onInitComponent ( )

overrideprotectedvirtual

Pure virtual hook for the subclass.

Is called once initialization of the ManagedIceObject is done. This hook is called in the implenting class once and never again during the lifecyle of the object. This function is called as soon as the ManagedIceObject was added to the ArmarXManager. Called in an own thread and not the thread it was created in.

Implements ManagedIceObject.

Definition at line 45 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ reportEvent()

void reportEvent	(	const ProfilerEvent &	event,
		const Ice::Current &
	)

override

Definition at line 270 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ reportEventList()

void reportEventList	(	const ProfilerEventList &	,
		const Ice::Current &
	)

override

Definition at line 459 of file StateWatcher.cpp.

◆ reportNetworkTraffic()

void reportNetworkTraffic	(	const std::string &	,
		const std::string &	,
		Ice::Int	,
		Ice::Int	,
		const Ice::Current &
	)

override

Definition at line 266 of file StateWatcher.cpp.

◆ reportProcessCpuUsage()

void reportProcessCpuUsage	(	const ProfilerProcessCpuUsage &	,
		const Ice::Current &
	)

override

Definition at line 451 of file StateWatcher.cpp.

◆ reportProcessCpuUsageList()

void reportProcessCpuUsageList	(	const ProfilerProcessCpuUsageList &	,
		const Ice::Current &
	)

override

Definition at line 495 of file StateWatcher.cpp.

◆ reportProcessMemoryUsage()

void reportProcessMemoryUsage	(	const ProfilerProcessMemoryUsage &	,
		const Ice::Current &
	)

override

Definition at line 455 of file StateWatcher.cpp.

◆ reportProcessMemoryUsageList()

void reportProcessMemoryUsageList	(	const ProfilerProcessMemoryUsageList &	,
		const Ice::Current &
	)

override

Definition at line 499 of file StateWatcher.cpp.

◆ reportStatechartInputParameters()

void reportStatechartInputParameters	(	const ProfilerStatechartParameters &	event,
		const Ice::Current &
	)

override

Definition at line 429 of file StateWatcher.cpp.

Here is the caller graph for this function:

◆ reportStatechartInputParametersList()

void reportStatechartInputParametersList	(	const ProfilerStatechartParametersList &	data,
		const Ice::Current &	c
	)

override

Definition at line 471 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ reportStatechartLocalParameters()

void reportStatechartLocalParameters	(	const ProfilerStatechartParameters &	event,
		const Ice::Current &
	)

override

Definition at line 436 of file StateWatcher.cpp.

Here is the caller graph for this function:

◆ reportStatechartLocalParametersList()

void reportStatechartLocalParametersList	(	const ProfilerStatechartParametersList &	data,
		const Ice::Current &	c
	)

override

Definition at line 479 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ reportStatechartOutputParameters()

void reportStatechartOutputParameters	(	const ProfilerStatechartParameters &	event,
		const Ice::Current &
	)

override

Definition at line 443 of file StateWatcher.cpp.

Here is the caller graph for this function:

◆ reportStatechartOutputParametersList()

void reportStatechartOutputParametersList	(	const ProfilerStatechartParametersList &	data,
		const Ice::Current &	c
	)

override

Definition at line 487 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ reportStatechartTransition()

void reportStatechartTransition	(	const ProfilerStatechartTransition &	event,
		const Ice::Current &
	)

override

Definition at line 305 of file StateWatcher.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reportStatechartTransitionList()

void reportStatechartTransitionList	(	const ProfilerStatechartTransitionList &	data,
		const Ice::Current &	c
	)

override

Definition at line 463 of file StateWatcher.cpp.

Here is the call graph for this function:

◆ reportStatechartTransitionWithParameters()

void reportStatechartTransitionWithParameters	(	const ProfilerStatechartTransitionWithParameters &	,
		const Ice::Current &
	)

inlineoverride

Definition at line 100 of file StateWatcher.h.

◆ reportStatechartTransitionWithParametersList()

void reportStatechartTransitionWithParametersList	(	const ProfilerStatechartTransitionWithParametersList &	,
		const Ice::Current &
	)

inlineoverride

Definition at line 101 of file StateWatcher.h.

◆ subscribeToState() [1/2]

bool subscribeToState	(	StateIceBasePtr	iceState,
		statechartmodel::StatePtr	state
	)

Definition at line 129 of file StateWatcher.cpp.

◆ subscribeToState() [2/2]

bool subscribeToState	(	StateIceBasePtr	iceState,
		StateItem *	state
	)

Definition at line 164 of file StateWatcher.cpp.

◆ subscriptionFunction()

void subscriptionFunction ( )

protected

Definition at line 72 of file StateWatcher.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unsubscribeState()

bool unsubscribeState ( StateItem * state )

Definition at line 147 of file StateWatcher.cpp.

Member Data Documentation

◆ conditionHandler

ConditionHandlerInterfacePrx conditionHandler

protected

Definition at line 75 of file StateWatcher.h.

◆ mapMutex

std::mutex mapMutex

mutableprotected

Definition at line 74 of file StateWatcher.h.

◆ profilerObserver

ProfilerObserverInterfacePrx profilerObserver

protected

Definition at line 76 of file StateWatcher.h.

◆ stateMap

StateListenerDataMap stateMap

protected

Definition at line 73 of file StateWatcher.h.

◆ subscriptionQueue

SubscriptionMap subscriptionQueue

protected

Definition at line 78 of file StateWatcher.h.

◆ subscriptionTask

PeriodicTask<StateWatcher>::pointer_type subscriptionTask

protected

Definition at line 79 of file StateWatcher.h.

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

ArmarXGui/gui-plugins/StatechartViewerPlugin/StateWatcher.h
ArmarXGui/gui-plugins/StatechartViewerPlugin/StateWatcher.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ StateListenerDataMap

◆ SubscriptionMap

Constructor & Destructor Documentation

◆ StateWatcher()

Member Function Documentation

◆ clear()

◆ ExtractStateName()

◆ getDefaultName()

◆ getStateParameter()

◆ getStateParameterMap()

◆ onConnectComponent()

◆ onDisconnectComponent()

◆ onInitComponent()

◆ reportEvent()

◆ reportEventList()

◆ reportNetworkTraffic()

◆ reportProcessCpuUsage()

◆ reportProcessCpuUsageList()

◆ reportProcessMemoryUsage()

◆ reportProcessMemoryUsageList()

◆ reportStatechartInputParameters()

◆ reportStatechartInputParametersList()

◆ reportStatechartLocalParameters()

◆ reportStatechartLocalParametersList()

◆ reportStatechartOutputParameters()

◆ reportStatechartOutputParametersList()

◆ reportStatechartTransition()

◆ reportStatechartTransitionList()

◆ reportStatechartTransitionWithParameters()

◆ reportStatechartTransitionWithParametersList()

◆ subscribeToState() [1/2]

◆ subscribeToState() [2/2]

◆ subscriptionFunction()

◆ unsubscribeState()

Member Data Documentation

◆ conditionHandler

◆ mapMutex

◆ profilerObserver

◆ stateMap

◆ subscriptionQueue

◆ subscriptionTask