RemoteGuiWidgetController Class Reference

RemoteGuiWidgetController brief one line description. More...

#include <ArmarXGui/gui-plugins/RemoteGuiPlugin/RemoteGuiWidgetController.h>

+ Inheritance diagram for RemoteGuiWidgetController:

Public Slots

void onCheckBoxGroupTabsClicked (bool checked)
 
void onComboBoxTabGroupsCurrentIndexChanged (const QString &group)
 
void onGuiStateChanged ()
 
void onSendButtonClicked ()
 
void onStateChanged (QString id)
 
void onTabChanged (QString id)
 
void onTabsChanged ()
 
void onWidgetChanged (QString id)
 
- Public Slots inherited from ArmarXWidgetController
void configAccepted ()
 
void configRejected ()
 
void enableMainWidget (bool enable)
 

Signals

void stateChanged (QString id)
 
void tabChanged (QString id)
 
void tabsChanged ()
 
void widgetChanged (QString id)
 
- Signals inherited from ArmarXWidgetController
void configAccepted (ArmarXWidgetControllerPtr widget)
 
void configRejected (ArmarXWidgetControllerPtr widget)
 

Public Member Functions

void configured () override
 This function must be implemented by the user, if he supplies a config dialog. More...
 
QPointer< QDialog > getConfigDialog (QWidget *parent=0) override
 getConfigDialog returns a pointer to the a configuration widget of this controller. More...
 
void loadSettings (QSettings *settings) override
 
void onConnectComponent () override
 Pure virtual hook for the subclass. More...
 
void onInitComponent () override
 Pure virtual hook for the subclass. More...
 
void onLockWidget () override
 
void onUnlockWidget () override
 
 RemoteGuiWidgetController ()
 Controller Constructor. More...
 
void reportStateChanged (const std::string &tab, const RemoteGui::ValueMap &delta, const Ice::Current &) override
 
void reportTabChanged (const std::string &tab, const Ice::Current &) override
 
void reportTabsRemoved (const Ice::Current &) override
 
void reportWidgetChanged (const std::string &tab, const RemoteGui::WidgetStateMap &widgetState, const Ice::Current &) override
 
void saveSettings (QSettings *settings) override
 
virtual ~RemoteGuiWidgetController ()
 Controller destructor. More...
 
- Public Member Functions inherited from ArmarXComponentWidgetControllerTemplate< RemoteGuiWidgetController >
QIcon getWidgetCategoryIcon () const final override
 Implement this function to supply an icon for the category. More...
 
QIcon getWidgetIcon () const final override
 Implement this function to supply an icon for the menu. More...
 
QString getWidgetName () const final override
 Implement this function to specify the default name of your Widget. More...
 
- Public Member Functions inherited from ArmarXComponentWidgetController
 ArmarXComponentWidgetController ()
 
std::string getDefaultName () const override
 Retrieve default name of component. More...
 
- Public Member Functions inherited from ArmarXWidgetController
 ArmarXWidgetController ()
 
void enableMainWidgetAsync (bool enable)
 This function enables/disables the main widget asynchronously (if called from a non qt thread). More...
 
virtual QPointer< QWidget > getCustomTitlebarWidget (QWidget *parent=0)
 getTitleToolbar returns a pointer to the a toolbar widget of this controller. More...
 
QString getInstanceName ()
 
virtual QMainWindow * getMainWindow ()
 Returns the ArmarX MainWindow. More...
 
virtual SoNode * getScene ()
 Reimplementing this function and returning a SoNode* will show this SoNode in the 3DViewerWidget, so that you do not need to implement a viewer yourself. More...
 
virtual QPointer< QDialog > getSceneConfigDialog (QWidget *parent=nullptr)
 Reimplementing this function and returning a QDialog* will enable a configuration button which opens the returned dialog. More...
 
QPointer< TipDialoggetTipDialog () const
 Returns the default instance for the TipDialog used by all widgets (if not set otherwise). More...
 
virtual QPointer< QWidget > getWidget ()
 getWidget returns a pointer to the a widget of this controller. More...
 
virtual QIcon getWidgetCategoryIcon () const
 Implement this function to supply an icon for the category. More...
 
virtual QIcon getWidgetIcon () const
 Implement this function to supply an icon for the menu. More...
 
virtual QString getWidgetName () const =0
 Implement this function to specify the default name of your Widget. More...
 
virtual void postDocking ()
 postDocking is called after the widget has been docked into the main window. More...
 
bool setInstanceName (QString instanceName)
 sets the name of this instance. More...
 
virtual void setMainWindow (QMainWindow *mainWindow)
 
virtual void setMutex3D (RecursiveMutexPtr const &mutex3D)
 This mutex is used to protect 3d scene updates. Usually called by the ArmarXGui main window on creation of this controller. More...
 
void setTipDialog (QPointer< TipDialog > tipDialog)
 
 ~ArmarXWidgetController () override
 
- 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 ()
 
- Public Member Functions inherited from Component
virtual void componentPropertiesUpdated (const std::set< std::string > &changedProperties)
 Implement this function if you would like to react to changes in the properties. More...
 
void forceComponentCreatedByComponentCreateFunc ()
 forces the flag to be set to true that the object instance was created by the Component::create function More...
 
std::vector< PropertyUserPtrgetAdditionalPropertyUsers () const
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name)
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name) const
 
template<class T >
void getProperty (std::atomic< T > &val, const std::string &name) const
 
template<class T >
void getProperty (T &val, const std::string &name) const
 
template<class ProxyType >
ProxyType getProxyFromProperty (const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 Get a proxy whose name is specified by the given property. More...
 
template<class ProxyType >
void getProxyFromProperty (ProxyType &proxy, const std::string &propertyName, bool addToDependencies=false, const std::string &endpoints="", bool throwOnProxyError=true)
 
template<class TopicProxyType >
TopicProxyType getTopicFromProperty (const std::string &propertyName)
 Get a topic proxy whose name is specified by the given property. More...
 
template<class TopicProxyType >
void getTopicFromProperty (TopicProxyType &top, const std::string &propertyName)
 
void initializeProperties (const std::string &configName, Ice::PropertiesPtr const &properties, const std::string &configDomain)
 initializes the properties of this component. More...
 
void injectPropertyDefinitions (PropertyDefinitionsPtr &props) override
 
void offeringTopicFromProperty (const std::string &propertyName)
 Offer a topic whose name is specified by the given property. More...
 
virtual void preOnConnectComponent () override
 
virtual void preOnInitComponent () override
 
bool usingProxyFromProperty (const std::string &propertyName, const std::string &endpoints="")
 Use a proxy whose name is specified by the given property. More...
 
void usingTopicFromProperty (const std::string &propertyName, bool orderedPublishing=false)
 Use a topic whose name is specified by the given property. 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 PropertyUser
std::vector< std::string > getComponentProxyNames ()
 
Ice::PropertiesPtr getIceProperties () const
 Returns the set of Ice properties. More...
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name)
 Property creation and retrieval. More...
 
template<typename PropertyType >
Property< PropertyType > getProperty (const std::string &name) const
 Hack to allow using getProperty in const-modified methods. More...
 
template<class T >
void getProperty (std::atomic< T > &val, const std::string &name) const
 
template<class T >
void getProperty (T &val, const std::string &name) const
 
template<class T >
std::vector< TgetPropertyAsCSV (const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)
 
template<class ContainerT >
void getPropertyAsCSV (ContainerT &val, const std::string &name, const std::string &splitBy=",;", bool trimElements=true, bool removeEmptyElements=true)
 
PropertyDefinitionsPtr getPropertyDefinitions ()
 Returns the component's property definition container. More...
 
std::vector< std::string > getSubscribedTopicNames ()
 
std::vector< std::string > getTopicProxyNames ()
 
bool hasProperty (const std::string &name)
 
 PropertyUser ()
 
virtual void setIceProperties (Ice::PropertiesPtr properties)
 Sets the Ice properties. More...
 
bool tryAddProperty (const std::string &propertyName, const std::string &value)
 
virtual void updateIceProperties (const std::map< std::string, std::string > &changes)
 
void updateProperties ()
 
void updateProxies (IceManagerPtr)
 
 ~PropertyUser () override
 

Static Public Member Functions

static QString GetWidgetName ()
 Returns the Widget name displayed in the ArmarXGui to create an instance of this class. More...
 
- Static Public Member Functions inherited from ArmarXComponentWidgetController
template<typename Class >
static ArmarXWidgetControllerPtr createInstance ()
 
- Static Public Member Functions inherited from ArmarXWidgetController
template<typename Class >
static ArmarXWidgetControllerPtr createInstance ()
 
static QIcon GetWidgetCategoryIcon ()
 Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()). More...
 
static QIcon GetWidgetIcon ()
 Implement this function to supply an icon for the menu (if you implemented static QString GetWidgetName()). More...
 
static int showMessageBox (const QString &msg)
 
- Static Public Member Functions inherited from Component
template<class T , class TPtr = IceInternal::Handle<T>>
static TPtr create (Ice::PropertiesPtr properties=Ice::createProperties(), const std::string &configName="", const std::string &configDomain="ArmarX")
 Factory method for a component. More...
 
- 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)
 

Additional Inherited Members

- Public Types inherited from ArmarXWidgetController
using RecursiveMutex = std::recursive_mutex
 
using RecursiveMutexLock = std::unique_lock< RecursiveMutex >
 
using RecursiveMutexLockPtr = std::shared_ptr< RecursiveMutexLock >
 
using RecursiveMutexPtr = std::shared_ptr< RecursiveMutex >
 
- 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. More...
 
- Protected Member Functions inherited from ArmarXComponentWidgetController
bool onClose () override
 If you overwrite this method, make sure to call this implementation at the end of your implementation with ArmarXComponentWidgetController::onClose(). More...
 
- 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 Member Functions inherited from Component
void addPropertyUser (const PropertyUserPtr &subPropertyUser)
 Add additional property users here that should show up in the application help text. More...
 
 Component ()
 Protected default constructor. Used for virtual inheritance. Use createManagedIceObject() instead. More...
 
PropertyDefinitionsPtr createPropertyDefinitions () override
 
std::string getConfigDomain ()
 Retrieve config domain for this component as set in constructor. More...
 
std::string getConfigIdentifier ()
 Retrieve config identifier for this component as set in constructor. More...
 
std::string getConfigName ()
 Retrieve config name for this component as set in constructor. More...
 
virtual void icePropertiesInitialized ()
 
- 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 onExitComponent ()
 Hook for subclass. More...
 
virtual void postOnConnectComponent ()
 
virtual void postOnDisconnectComponent ()
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 
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 Attributes inherited from ArmarXWidgetController
std::shared_ptr< std::recursive_mutex > mutex3D
 
- Protected Attributes inherited from Logging
MessageTypeT minimumLoggingLevel
 
SpamFilterDataPtr spamFilter
 
LogTag tag
 

Detailed Description

RemoteGuiWidgetController brief one line description.

Detailed description

Definition at line 62 of file RemoteGuiWidgetController.h.

Constructor & Destructor Documentation

◆ RemoteGuiWidgetController()

Controller Constructor.

Definition at line 79 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:

◆ ~RemoteGuiWidgetController()

Controller destructor.

Definition at line 112 of file RemoteGuiWidgetController.cpp.

Member Function Documentation

◆ configured()

void configured ( )
overridevirtual

This function must be implemented by the user, if he supplies a config dialog.

This function is then automatically called, when the dialog was accepted.

See also
getConfigDialog()

Reimplemented from ArmarXWidgetController.

Definition at line 127 of file RemoteGuiWidgetController.cpp.

◆ getConfigDialog()

QPointer< QDialog > getConfigDialog ( QWidget *  parent = 0)
overridevirtual

getConfigDialog returns a pointer to the a configuration widget of this controller.

It is optional.

If you need your widget configured, before it is shown, you should implement this function and return a QDialog derived class.

Parameters
parentPointer to the object, that should own this dialog.
Returns
pointer to a QDialog derived class, that should be used to configure your widget.
Note
When the dialog gets accepted (emit SIGNAL accepted()), the function configured() is called, which must be implemented as well.
See also
configured(), getWidget()

Reimplemented from ArmarXWidgetController.

Definition at line 117 of file RemoteGuiWidgetController.cpp.

◆ GetWidgetName()

static QString GetWidgetName ( )
inlinestatic

Returns the Widget name displayed in the ArmarXGui to create an instance of this class.

Definition at line 97 of file RemoteGuiWidgetController.h.

◆ loadSettings()

void loadSettings ( QSettings *  settings)
overridevirtual

◆ onCheckBoxGroupTabsClicked

void onCheckBoxGroupTabsClicked ( bool  checked)
slot

Definition at line 591 of file RemoteGuiWidgetController.cpp.

+ Here is the caller graph for this function:

◆ onComboBoxTabGroupsCurrentIndexChanged

void onComboBoxTabGroupsCurrentIndexChanged ( const QString &  group)
slot

Definition at line 598 of file RemoteGuiWidgetController.cpp.

+ Here is the caller graph for this function:

◆ onConnectComponent()

void onConnectComponent ( )
overridevirtual

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 150 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:

◆ onGuiStateChanged

void onGuiStateChanged ( )
slot

Definition at line 264 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:

◆ onInitComponent()

void onInitComponent ( )
overridevirtual

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 144 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:

◆ onLockWidget()

void onLockWidget ( )
overridevirtual

Reimplemented from ArmarXWidgetController.

Definition at line 571 of file RemoteGuiWidgetController.cpp.

◆ onSendButtonClicked

void onSendButtonClicked ( )
slot

Definition at line 308 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onStateChanged

void onStateChanged ( QString  id)
slot

Definition at line 257 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onTabChanged

void onTabChanged ( QString  id)
slot

Definition at line 218 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onTabsChanged

void onTabsChanged ( )
slot

Definition at line 231 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ onUnlockWidget()

void onUnlockWidget ( )
overridevirtual

Reimplemented from ArmarXWidgetController.

Definition at line 577 of file RemoteGuiWidgetController.cpp.

◆ onWidgetChanged

void onWidgetChanged ( QString  id)
slot

Definition at line 247 of file RemoteGuiWidgetController.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ reportStateChanged()

void reportStateChanged ( const std::string &  tab,
const RemoteGui::ValueMap delta,
const Ice::Current &   
)
override

Definition at line 204 of file RemoteGuiWidgetController.cpp.

◆ reportTabChanged()

void reportTabChanged ( const std::string &  tab,
const Ice::Current &   
)
override

Definition at line 169 of file RemoteGuiWidgetController.cpp.

◆ reportTabsRemoved()

void reportTabsRemoved ( const Ice::Current &  )
override

Definition at line 182 of file RemoteGuiWidgetController.cpp.

◆ reportWidgetChanged()

void reportWidgetChanged ( const std::string &  tab,
const RemoteGui::WidgetStateMap &  widgetState,
const Ice::Current &   
)
override

Definition at line 194 of file RemoteGuiWidgetController.cpp.

◆ saveSettings()

void saveSettings ( QSettings *  settings)
overridevirtual

◆ stateChanged

void stateChanged ( QString  id)
signal
+ Here is the caller graph for this function:

◆ tabChanged

void tabChanged ( QString  id)
signal
+ Here is the caller graph for this function:

◆ tabsChanged

void tabsChanged ( )
signal
+ Here is the caller graph for this function:

◆ widgetChanged

void widgetChanged ( QString  id)
signal
+ Here is the caller graph for this function:

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