The SimulatorTimeServerProxy class forwards TimeserverInterface calls to the simulator This is a hack to allow offering the proxies "Simulator" and "MasterTimeServer" at once. More...

#include <ArmarXSimulation/components/Simulator/SimulatorTimeServerProxy.h>

Inheritance diagram for SimulatorTimeServerProxy:

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

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

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

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

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

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

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

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

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

	SimulatorTimeServerProxy (Simulator *sim)

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

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

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

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

Protected Attributes
SimulatorPtr	simulator

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

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

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)

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

Detailed Description

The SimulatorTimeServerProxy class forwards TimeserverInterface calls to the simulator This is a hack to allow offering the proxies "Simulator" and "MasterTimeServer" at once.

Definition at line 42 of file SimulatorTimeServerProxy.h.

Constructor & Destructor Documentation

◆ SimulatorTimeServerProxy()

SimulatorTimeServerProxy ( Simulator * sim )

Definition at line 30 of file SimulatorTimeServerProxy.cpp.

Member Function Documentation

◆ 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 67 of file SimulatorTimeServerProxy.cpp.

◆ getSpeed()

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

override

Definition at line 47 of file SimulatorTimeServerProxy.cpp.

◆ getStepTimeMS()

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

override

Definition at line 62 of file SimulatorTimeServerProxy.cpp.

◆ getTime()

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

override

Definition at line 52 of file SimulatorTimeServerProxy.cpp.

◆ onConnectComponent()

void onConnectComponent ( )

inlineoverridevirtual

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 61 of file SimulatorTimeServerProxy.h.

◆ onDisconnectComponent()

void onDisconnectComponent ( )

inlineoverridevirtual

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 62 of file SimulatorTimeServerProxy.h.

◆ onExitComponent()

void onExitComponent ( )

inlineoverridevirtual

Hook for subclass.

Is called once the component terminates. Use for cleanup. Only called once.

Reimplemented from ManagedIceObject.

Definition at line 63 of file SimulatorTimeServerProxy.h.

◆ onInitComponent()

void onInitComponent ( )

inlineoverridevirtual

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 60 of file SimulatorTimeServerProxy.h.

◆ setSpeed()

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

override

Definition at line 42 of file SimulatorTimeServerProxy.cpp.

◆ start()

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

override

Definition at line 37 of file SimulatorTimeServerProxy.cpp.

◆ step()

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

override

Definition at line 57 of file SimulatorTimeServerProxy.cpp.

◆ stop()

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

override

Definition at line 32 of file SimulatorTimeServerProxy.cpp.

Member Data Documentation

◆ simulator

SimulatorPtr simulator

protected

Definition at line 66 of file SimulatorTimeServerProxy.h.

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

ArmarXSimulation/components/Simulator/SimulatorTimeServerProxy.h
ArmarXSimulation/components/Simulator/SimulatorTimeServerProxy.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimulatorTimeServerProxy()

Member Function Documentation

◆ getDefaultName()

◆ getSpeed()

◆ getStepTimeMS()

◆ getTime()

◆ onConnectComponent()

◆ onDisconnectComponent()

◆ onExitComponent()

◆ onInitComponent()

◆ setSpeed()

◆ start()

◆ step()

◆ stop()

Member Data Documentation

◆ simulator