SceneEditorConfigDialog Class Reference

This class provides a dialog derived from Qt::QDialog and armarx::ManagedIceObject. More...

#include <MemoryX/gui-plugins/SceneEditor/gui/dialog/SceneEditorConfigDialog.h>

+ Inheritance diagram for SceneEditorConfigDialog:

Public Member Functions

std::string getDefaultName () const override
 Reimplemented armarx::ManagedIceObject:getDefaultName(). More...
 
std::string getPriorMemoryName ()
 Returns selected PriorKnowledge name. More...
 
QString getSettingsFilePath ()
 Returns the full path to the selected settings file. More...
 
std::string getWorkingMemoryName ()
 Returns selected WorkingMemory name. More...
 
std::string getWorkingMemoryUpdatesTopic ()
 Returns selected WorkingMemory updates topic. More...
 
void onConnectComponent () override
 Reimplemented armarx::ManagedIceObject:onConnectComponent(). More...
 
void onExitComponent () override
 Reimplemented armarx::ManagedIceObject:onExitComponent(). More...
 
void onInitComponent () override
 Reimplemented armarx::ManagedIceObject:onInitComponent(). More...
 
void retranslate ()
 Translates all translatable strings in this dialog. More...
 
 SceneEditorConfigDialog (QWidget *parent=0)
 Constructor. More...
 
void setIceObjectName ()
 Sets unic name for this widget. More...
 
 ~SceneEditorConfigDialog () override
 Destructor. More...
 
- 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 ()
 

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

This class provides a dialog derived from Qt::QDialog and armarx::ManagedIceObject.

In this dialog the user has to set the necessary settings to start the plugin.

See also
armarx::ManagedIceObject

Definition at line 50 of file SceneEditorConfigDialog.h.

Constructor & Destructor Documentation

◆ SceneEditorConfigDialog()

SceneEditorConfigDialog ( QWidget *  parent = 0)
explicit

Constructor.

Creates an instance of SceneEditorConfigDialog.

Parameters
parentparent widget

Definition at line 45 of file SceneEditorConfigDialog.cpp.

◆ ~SceneEditorConfigDialog()

~SceneEditorConfigDialog ( )
override

Destructor.

Destroys the initial config dialog.

Definition at line 78 of file SceneEditorConfigDialog.cpp.

Member Function Documentation

◆ getDefaultName()

std::string getDefaultName ( ) const
overridevirtual

◆ getPriorMemoryName()

std::string getPriorMemoryName ( )

Returns selected PriorKnowledge name.

Returns
PriorMemory name

Definition at line 120 of file SceneEditorConfigDialog.cpp.

◆ getSettingsFilePath()

QString getSettingsFilePath ( )

Returns the full path to the selected settings file.

Returns
file path to settings file

Definition at line 158 of file SceneEditorConfigDialog.cpp.

◆ getWorkingMemoryName()

std::string getWorkingMemoryName ( )

Returns selected WorkingMemory name.

Returns
WorkingMemory name

Definition at line 110 of file SceneEditorConfigDialog.cpp.

◆ getWorkingMemoryUpdatesTopic()

std::string getWorkingMemoryUpdatesTopic ( )

Returns selected WorkingMemory updates topic.

Returns
WorkingMemory updates topic

Definition at line 115 of file SceneEditorConfigDialog.cpp.

◆ onConnectComponent()

void onConnectComponent ( )
overridevirtual

◆ onExitComponent()

void onExitComponent ( )
overridevirtual

◆ onInitComponent()

void onInitComponent ( )
overridevirtual

◆ retranslate()

void retranslate ( )

Translates all translatable strings in this dialog.

Definition at line 153 of file SceneEditorConfigDialog.cpp.

◆ setIceObjectName()

void setIceObjectName ( )

Sets unic name for this widget.

Definition at line 105 of file SceneEditorConfigDialog.cpp.


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