Provides a ready-to-use ArViz client arviz as member variable. More...

#include <RobotAPI/libraries/RobotAPIComponentPlugins/ArVizComponentPlugin.h>

Public Member Functions
	ArVizComponentPluginUser ()

armarx::viz::Client	createArVizClient ()

armarx::viz::Client &	getArvizClient ()

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)

virtual std::string	getDefaultName () const =0
	Retrieve default name of component.

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

Public Attributes
armarx::viz::Client	arviz

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.

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.

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	onConnectComponent ()=0
	Pure virtual hook for the subclass.

virtual void	onDisconnectComponent ()
	Hook for subclass.

virtual void	onExitComponent ()
	Hook for subclass.

virtual void	onInitComponent ()=0
	Pure virtual hook for the 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

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Detailed Description

Provides a ready-to-use ArViz client arviz as member variable.

Definition at line 35 of file ArVizComponentPlugin.h.

Constructor & Destructor Documentation

◆ ArVizComponentPluginUser()

ArVizComponentPluginUser ( )

Definition at line 73 of file ArVizComponentPlugin.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ createArVizClient()

viz::Client createArVizClient ( )

Definition at line 79 of file ArVizComponentPlugin.cpp.

Here is the caller graph for this function:

◆ getArvizClient()

armarx::viz::Client & getArvizClient ( )

inline

Definition at line 45 of file ArVizComponentPlugin.h.

Here is the caller graph for this function:

Member Data Documentation

◆ arviz

armarx::viz::Client arviz

Definition at line 42 of file ArVizComponentPlugin.h.

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

RobotAPI/libraries/RobotAPIComponentPlugins/ArVizComponentPlugin.h
RobotAPI/libraries/RobotAPIComponentPlugins/ArVizComponentPlugin.cpp

Public Member Functions

Public Attributes

Additional Inherited Members