A local time server that gets its time from the MasterTimeServer. More...

#include <ArmarXCore/core/time/LocalTimeServer.h>

Inheritance diagram for LocalTimeServer:

Public Member Functions
std::string	getDefaultName () const override

Ice::Float	getSpeed (const ::Ice::Current &=Ice::emptyCurrent) override

Ice::Int	getStepTimeMS (const ::Ice::Current &=Ice::emptyCurrent) override

Ice::Long	getTime (const ::Ice::Current &=Ice::emptyCurrent) override

void	registerTimer (IceUtil::Time endTime, CallbackReceiver *callback)
	register a callack to call at endTime

void	reportTime (::Ice::Long, const ::Ice::Current &=Ice::emptyCurrent) override

void	setSpeed (Ice::Float newSpeed, const ::Ice::Current &=Ice::emptyCurrent) override

void	start (const ::Ice::Current &=Ice::emptyCurrent) override

void	step (const ::Ice::Current &=Ice::emptyCurrent) override

void	stop (const ::Ice::Current &=Ice::emptyCurrent) override

void	unregisterTimer (CallbackReceiver *callback)
	unregister a timer

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)

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

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

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

IceManagerPtr	getIceManager () const
	Returns the IceManager.

VariantBasePtr	getMetaInfo (const std::string &id)

StringVariantBaseMap	getMetaInfoMap () const

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

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

ArmarXObjectSchedulerPtr	getObjectScheduler () const

PeriodicTaskPtr	getPeriodicTask (const std::string &name)

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

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.

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

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

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

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

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

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

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

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

	ManagedIceObject (ManagedIceObject const &other)

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

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.

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.

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

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

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

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.

MessageTypeT	getEffectiveLoggingLevel () const

	Logging ()

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

void	setTag (const LogTag &tag)

void	setTag (const std::string &tagName)

virtual	~Logging ()

Static Public Member Functions
static LocalTimeServerPtr	getApplicationTimeServer ()
	Get the applications LocalTimeServer instance.

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.

static std::string	GetObjectStateAsString (int state)

Protected Member Functions
	LocalTimeServer ()
	Please use LocalTimeServer::getApplicationtimeserver() to access your local timeserver.

void	onConnectComponent () override

void	onDisconnectComponent () override
	Hook for subclass.

void	onInitComponent () override

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.

virtual void	onExitComponent ()
	Hook for subclass.

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.

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

void	terminate ()
	Initiates termination of this IceManagedObject.

	~ManagedIceObject () override

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

const LogSenderPtr &	getLogSender () const
	Retrieve log sender.

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

Static Protected Member Functions
static void	setApplicationTimeServerName (const std::string &name)

Protected Attributes
std::vector< RegisteredTimer >	scheduledTasks

std::mutex	scheduledTasksMutex
	used for locking scheduledTasks

IceUtil::Time	time
	the current time

std::shared_mutex	timeMutex

TimeServerInterfacePrx	timeServerPrx
	a handle for the MasterTimeServer

TimeServerListenerPrx	timeTopicPrx
	a handle for the topic "Time"

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

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.

Detailed Description

A local time server that gets its time from the MasterTimeServer.

The LocalTimeServer runs as a component in every application and offers the time it gets from the MasterTimeServer to the other compnents.

Constructor & Destructor Documentation

◆ LocalTimeServer()

LocalTimeServer ( )

protected

Please use LocalTimeServer::getApplicationtimeserver() to access your local timeserver.

Member Function Documentation

◆ getApplicationTimeServer()

LocalTimeServerPtr getApplicationTimeServer ( )

static

Get the applications LocalTimeServer instance.

Returns: The applications LocalTimeServer instance

◆ getDefaultName()

std::string getDefaultName ( ) const

overridevirtual

See also: armarx::ManagedIceObject::getDefaultName()

Implements ManagedIceObject.

◆ getSpeed()

Ice::Float getSpeed ( const ::Ice::Current & = Ice::emptyCurrent )

override

◆ getStepTimeMS()

Ice::Int getStepTimeMS ( const ::Ice::Current & = Ice::emptyCurrent )

override

◆ getTime()

Ice::Long getTime ( const ::Ice::Current & = Ice::emptyCurrent )

override

◆ onConnectComponent()

void onConnectComponent ( )

overrideprotectedvirtual

See also: armarx::ManagedIceObject::onConnectComponent()

Implements ManagedIceObject.

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

◆ onInitComponent()

void onInitComponent ( )

overrideprotectedvirtual

See also: armarx::ManagedIceObject::onInitComponent()

Implements ManagedIceObject.

◆ registerTimer()

void registerTimer	(	IceUtil::Time	endTime,
		CallbackReceiver *	callback )

register a callack to call at endTime

Parameters

endTime	when to call
callback	whom to call (has to implement CallbackReceiver)

Register a callback that is called when the endTime is reached. Always takes at least one timeserver tick when virtual time is active

A registered timer must be unregistered if it is destroyed before the endTime is reached!

◆ reportTime()

void reportTime	(	::Ice::Long	,
		const ::Ice::Current &	= Ice::emptyCurrent )

override

◆ setApplicationTimeServerName()

void setApplicationTimeServerName ( const std::string & name )

staticprotected

◆ setSpeed()

void setSpeed	(	Ice::Float	newSpeed,
		const ::Ice::Current &	= Ice::emptyCurrent )

override

◆ start()

void start ( const ::Ice::Current & = Ice::emptyCurrent )

override

◆ step()

void step ( const ::Ice::Current & = Ice::emptyCurrent )

override

◆ stop()

void stop ( const ::Ice::Current & = Ice::emptyCurrent )

override

◆ unregisterTimer()

void unregisterTimer ( CallbackReceiver * callback )

unregister a timer

Parameters

the	CallbackReceiver to unregister

Cancels all scheduled callbacks registered by the given CallbackReceiver

Friends And Related Symbol Documentation

◆ ArmarXManager

friend class ArmarXManager

friend

Member Data Documentation

◆ scheduledTasks

std::vector<RegisteredTimer> scheduledTasks

protected

◆ scheduledTasksMutex

std::mutex scheduledTasksMutex

protected

used for locking scheduledTasks

◆ time

IceUtil::Time time

protected

the current time

◆ timeMutex

std::shared_mutex timeMutex

protected

◆ timeServerPrx

TimeServerInterfacePrx timeServerPrx

protected

a handle for the MasterTimeServer

◆ timeTopicPrx

TimeServerListenerPrx timeTopicPrx

protected

a handle for the topic "Time"

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

ArmarXCore/core/time/LocalTimeServer.h
ArmarXCore/core/time/LocalTimeServer.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LocalTimeServer()

Member Function Documentation

◆ getApplicationTimeServer()

◆ getDefaultName()

◆ getSpeed()

◆ getStepTimeMS()

◆ getTime()

◆ onConnectComponent()

◆ onDisconnectComponent()

◆ onInitComponent()

◆ registerTimer()

◆ reportTime()

◆ setApplicationTimeServerName()

◆ setSpeed()

◆ start()

◆ step()

◆ stop()

◆ unregisterTimer()

Friends And Related Symbol Documentation

◆ ArmarXManager

Member Data Documentation

◆ scheduledTasks

◆ scheduledTasksMutex

◆ time

◆ timeMutex

◆ timeServerPrx

◆ timeTopicPrx