#include <ArmarXCore/core/services/tasks/ThreadList.h>

Inheritance diagram for ThreadList:

Classes
struct	Impl

Public Member Functions
void	addPeriodicTask (PeriodicTaskIceBase *threadPtr)
	add PeriodicTask instance to this thread list More...

void	addRunningTask (RunningTaskIceBase *threadPtr)
	add RunningTask instance to this thread list More...

double	getCpuUsage (const Ice::Current &c=Ice::emptyCurrent) override

Ice::StringSeq	getPeriodicTaskNames (const Ice::Current &c=Ice::emptyCurrent) override

PeriodicTaskList	getPeriodicTasks (const Ice::Current &c=Ice::emptyCurrent) override

Ice::StringSeq	getRunningTaskNames (const Ice::Current &c=Ice::emptyCurrent) override

RunningTaskList	getRunningTasks (const Ice::Current &c=Ice::emptyCurrent) override

bool	removePeriodicTask (PeriodicTaskIceBase *threadPtr)
	remove PeriodicTask instance from this thread list More...

bool	removeRunningTask (RunningTaskIceBase *threadPtr)
	remove RunningTask instance from this thread list More...

	ThreadList ()

	~ThreadList ()

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 ThreadListPtr	getApplicationThreadList ()
	getApplicationThreadList retrieves the ThreadList, that contains all TimerTasks and PeriodicTasks in this Application. More...

static int	GetHertz ()

static int	GetThreadJiffies (int threadId)

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 Member Functions
std::string	getDefaultName () const override
	Retrieve default name of component. More...

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	setApplicationThreadListName (const std::string &threadListName)

void	updateCPUUsage ()

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

Friends
class	ArmarXManager

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

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

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Detailed Description

Definition at line 44 of file ThreadList.h.

Constructor & Destructor Documentation

◆ ThreadList()

ThreadList ( )

Definition at line 45 of file ThreadList.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~ThreadList()

~ThreadList ( )

Definition at line 51 of file ThreadList.cpp.

Member Function Documentation

◆ addPeriodicTask()

void addPeriodicTask ( PeriodicTaskIceBase * threadPtr )

add PeriodicTask instance to this thread list

Parameters

threadPtr pointer to the PeriodicTask instance to add

Definition at line 164 of file ThreadList.cpp.

◆ addRunningTask()

void addRunningTask ( RunningTaskIceBase * threadPtr )

add RunningTask instance to this thread list

Parameters

threadPtr pointer to the RunningTask instance to add

Definition at line 137 of file ThreadList.cpp.

◆ getApplicationThreadList()

ThreadListPtr getApplicationThreadList ( )

static

getApplicationThreadList retrieves the ThreadList, that contains all TimerTasks and PeriodicTasks in this Application.

Returns

Definition at line 189 of file ThreadList.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCpuUsage()

double getCpuUsage ( const Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 101 of file ThreadList.cpp.

◆ getDefaultName()

std::string getDefaultName ( ) const

inlineoverrideprotectedvirtual

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 101 of file ThreadList.h.

◆ GetHertz()

static int GetHertz ( )

static

◆ getPeriodicTaskNames()

Ice::StringSeq getPeriodicTaskNames ( const Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 87 of file ThreadList.cpp.

◆ getPeriodicTasks()

PeriodicTaskList getPeriodicTasks ( const Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 122 of file ThreadList.cpp.

◆ getRunningTaskNames()

Ice::StringSeq getRunningTaskNames ( const Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 74 of file ThreadList.cpp.

◆ getRunningTasks()

RunningTaskList getRunningTasks ( const Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 107 of file ThreadList.cpp.

◆ GetThreadJiffies()

static int GetThreadJiffies ( int threadId )

static

◆ 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 60 of file ThreadList.cpp.

◆ 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 65 of file ThreadList.cpp.

◆ 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 56 of file ThreadList.cpp.

◆ removePeriodicTask()

bool removePeriodicTask ( PeriodicTaskIceBase * threadPtr )

remove PeriodicTask instance from this thread list

Parameters

threadPtr pointer to the PeriodicTask instance to remove

Definition at line 176 of file ThreadList.cpp.

◆ removeRunningTask()

bool removeRunningTask ( RunningTaskIceBase * threadPtr )

remove RunningTask instance from this thread list

Parameters

threadPtr pointer to the RunningTask instance to remove

Definition at line 150 of file ThreadList.cpp.

◆ setApplicationThreadListName()

void setApplicationThreadListName ( const std::string & threadListName )

protected

Definition at line 195 of file ThreadList.cpp.

Here is the call graph for this function:

◆ updateCPUUsage()

void updateCPUUsage ( )

protected

Definition at line 70 of file ThreadList.cpp.

Friends And Related Function Documentation

◆ ArmarXManager

friend class ArmarXManager

friend

Definition at line 96 of file ThreadList.h.

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

ArmarXCore/core/services/tasks/ThreadList.h
ArmarXCore/core/services/tasks/ThreadList.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ThreadList()

◆ ~ThreadList()

Member Function Documentation

◆ addPeriodicTask()

◆ addRunningTask()

◆ getApplicationThreadList()

◆ getCpuUsage()

◆ getDefaultName()

◆ GetHertz()

◆ getPeriodicTaskNames()

◆ getPeriodicTasks()

◆ getRunningTaskNames()

◆ getRunningTasks()

◆ GetThreadJiffies()

◆ onConnectComponent()

◆ onDisconnectComponent()

◆ onInitComponent()

◆ removePeriodicTask()

◆ removeRunningTask()

◆ setApplicationThreadListName()

◆ updateCPUUsage()

Friends And Related Function Documentation

◆ ArmarXManager