DebugObserverComponentPluginUser Class Reference
#include <ArmarXCore/libraries/ArmarXCoreComponentPlugins/DebugObserverComponentPlugin.h>
Inheritance diagram for DebugObserverComponentPluginUser:Public Types | |
| using | DebugObserverComponentPlugin = armarx::plugins::DebugObserverComponentPlugin |
| Public Types inherited from ManagedIceObject | |
| using | PeriodicTaskPtr = IceUtil::Handle< SimplePeriodicTask< std::function< void(void)> >> |
Public Member Functions | |
| DebugObserverComponentPluginUser () | |
| const DebugObserverInterfacePrx & | getDebugObserver () const |
| plugins::DebugObserverComponentPlugin & | getDebugObserverComponentPlugin () |
| void | removeAllDebugObserverChannels () const |
| void | removeDebugObserverChannel (const std::string &channelname) const |
| void | removeDebugObserverDatafield (const std::string &channelName, const std::string &datafieldName) const |
| void | sendDebugObserverBatch () |
| void | setDebugObserverBatchModeEnabled (bool enable) |
| void | setDebugObserverChannel (const std::string &channelName, StringVariantBaseMap valueMap) const |
| template<class... Ts> | |
| void | setDebugObserverDatafield (Ts &&...ts) const |
| 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... | |
| virtual std::string | getDefaultName () const =0 |
| Retrieve default name of component. 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 () |
Additional Inherited Members | |
| 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 | onConnectComponent ()=0 |
| Pure virtual hook for the subclass. More... | |
| virtual void | onDisconnectComponent () |
| Hook for subclass. More... | |
| virtual void | onExitComponent () |
| Hook for subclass. More... | |
| virtual void | onInitComponent ()=0 |
| Pure virtual hook for the 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 inherited from Logging | |
| MessageTypeT | minimumLoggingLevel |
| SpamFilterDataPtr | spamFilter |
| LogTag | tag |
Detailed Description
Definition at line 82 of file DebugObserverComponentPlugin.h.
Member Typedef Documentation
◆ DebugObserverComponentPlugin
Definition at line 86 of file DebugObserverComponentPlugin.h.
Constructor & Destructor Documentation
◆ DebugObserverComponentPluginUser()
Definition at line 80 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function:Member Function Documentation
◆ getDebugObserver()
| const DebugObserverInterfacePrx & getDebugObserver | ( | ) | const |
Definition at line 113 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ getDebugObserverComponentPlugin()
| plugins::DebugObserverComponentPlugin & getDebugObserverComponentPlugin | ( | ) |
Definition at line 85 of file DebugObserverComponentPlugin.cpp.
Here is the caller graph for this function:◆ removeAllDebugObserverChannels()
| void removeAllDebugObserverChannels | ( | ) | const |
Definition at line 108 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function:◆ removeDebugObserverChannel()
| void removeDebugObserverChannel | ( | const std::string & | channelname | ) | const |
Definition at line 96 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function:◆ removeDebugObserverDatafield()
| void removeDebugObserverDatafield | ( | const std::string & | channelName, |
| const std::string & | datafieldName | ||
| ) | const |
Definition at line 101 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function:◆ sendDebugObserverBatch()
| void sendDebugObserverBatch | ( | ) |
Definition at line 122 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ setDebugObserverBatchModeEnabled()
| void setDebugObserverBatchModeEnabled | ( | bool | enable | ) |
Definition at line 118 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function: Here is the caller graph for this function:◆ setDebugObserverChannel()
| void setDebugObserverChannel | ( | const std::string & | channelName, |
| StringVariantBaseMap | valueMap | ||
| ) | const |
Definition at line 90 of file DebugObserverComponentPlugin.cpp.
Here is the call graph for this function:◆ setDebugObserverDatafield()
|
inline |
Definition at line 97 of file DebugObserverComponentPlugin.h.
Here is the call graph for this function: Here is the caller graph for this function:The documentation for this class was generated from the following files:
- ArmarXCore/libraries/ArmarXCoreComponentPlugins/DebugObserverComponentPlugin.h
- ArmarXCore/libraries/ArmarXCoreComponentPlugins/DebugObserverComponentPlugin.cpp
