RemoteGuiComponentPlugin Class Reference

#include <ArmarXGui/libraries/ArmarXGuiComponentPlugins/RemoteGuiComponentPlugin.h>

+ Inheritance diagram for RemoteGuiComponentPlugin:

Public Types

template<class T >
using enable_if_auto_gui_cfg = std::enable_if_t< meta::cfg::gui_definition_create< T >::value >
 
using TabTask = std::function< void(RemoteGui::TabProxy &)>
 

Public Member Functions

void createOrUpdateTab (const RemoteGui::WidgetPtr &widget, TabTask guiTaskFnc, unsigned long guiTaskPeriod=10)
 
void createOrUpdateTab (const std::string &name, const RemoteGui::WidgetPtr &widget, TabTask guiTaskFnc, unsigned long guiTaskPeriod=10)
 
void createOrUpdateTab (const std::string &name, const RemoteGui::WidgetPtr &widget, unsigned long guiTaskPeriod=10)
 
template<class T >
enable_if_auto_gui_cfg< TcreateOrUpdateTab (const std::string &name, T &data, unsigned long guiTaskPeriod=10)
 
template<class T , class LockableT >
enable_if_auto_gui_cfg< TcreateOrUpdateTab (const std::string &name, WriteBufferedTripleBuffer< T > &data, LockableT &mutex, unsigned long guiTaskPeriod=10)
 
template<class T >
enable_if_auto_gui_cfg< TcreateOrUpdateTab (const std::string &name, WriteBufferedTripleBuffer< T > &data, unsigned long guiTaskPeriod=10)
 
template<class T >
enable_if_auto_gui_cfg< TcreateOrUpdateTab (T &data, unsigned long guiTaskPeriod=10)
 
template<class T , class LockableT >
enable_if_auto_gui_cfg< TcreateOrUpdateTab (WriteBufferedTripleBuffer< T > &data, LockableT &mutex, unsigned long guiTaskPeriod=10)
 
template<class T >
enable_if_auto_gui_cfg< TcreateOrUpdateTab (WriteBufferedTripleBuffer< T > &data, unsigned long guiTaskPeriod=10)
 
const RemoteGuiInterfacePrx & getRemoteGui () const
 
RemoteGui::TabProxygetTab (const std::string &name="")
 
bool hasTab (const std::string &name="")
 
void removeTab (const std::string &name="")
 
- Public Member Functions inherited from ManagedIceObjectPlugin
ManagedIceObjectparent ()
 
template<class T >
Tparent ()
 
const ManagedIceObjectparent () const
 
template<class T >
const Tparent () const
 
template<class T >
bool parentDerives () const
 
virtual ~ManagedIceObjectPlugin ()=default
 

Protected Member Functions

void postCreatePropertyDefinitions (PropertyDefinitionsPtr &properties) override
 
void postOnConnectComponent () override
 
void postOnDisconnectComponent () override
 
void preOnConnectComponent () override
 
void preOnInitComponent () override
 
- Protected Member Functions inherited from ComponentPlugin
virtual void componentPropertiesUpdated (const std::set< std::string > &changedProperties)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
- Protected Member Functions inherited from ManagedIceObjectPlugin
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)
 
void addPluginDependency (ManagedIceObjectPlugin *dependedOn)
 
void addPluginDependency (std::experimental::observer_ptr< ManagedIceObjectPlugin > dependedOn)
 
std::string makePropertyName (const std::string &name)
 
 ManagedIceObjectPlugin (ManagedIceObject &parent, std::string pre)
 
virtual void postOnExitComponent ()
 
virtual void postOnInitComponent ()
 
const std::string & prefix () const
 
virtual void preOnDisconnectComponent ()
 
virtual void preOnExitComponent ()
 

Detailed Description

Definition at line 52 of file RemoteGuiComponentPlugin.h.

Member Typedef Documentation

◆ enable_if_auto_gui_cfg

using enable_if_auto_gui_cfg = std::enable_if_t<meta::cfg::gui_definition_create<T>::value>

Definition at line 57 of file RemoteGuiComponentPlugin.h.

◆ TabTask

using TabTask = std::function<void(RemoteGui::TabProxy&)>

Definition at line 59 of file RemoteGuiComponentPlugin.h.

Member Function Documentation

◆ createOrUpdateTab() [1/9]

void createOrUpdateTab ( const RemoteGui::WidgetPtr &  widget,
RemoteGuiComponentPlugin::TabTask  guiTaskFnc,
unsigned long  guiTaskPeriod = 10 
)

Definition at line 30 of file RemoteGuiComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ createOrUpdateTab() [2/9]

void createOrUpdateTab ( const std::string &  name,
const RemoteGui::WidgetPtr &  widget,
RemoteGuiComponentPlugin::TabTask  guiTaskFnc,
unsigned long  guiTaskPeriod = 10 
)

Definition at line 38 of file RemoteGuiComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ createOrUpdateTab() [3/9]

void createOrUpdateTab ( const std::string &  name,
const RemoteGui::WidgetPtr &  widget,
unsigned long  guiTaskPeriod = 10 
)

Definition at line 61 of file RemoteGuiComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ createOrUpdateTab() [4/9]

enable_if_auto_gui_cfg<T> createOrUpdateTab ( const std::string &  name,
T data,
unsigned long  guiTaskPeriod = 10 
)
inline

Definition at line 77 of file RemoteGuiComponentPlugin.h.

+ Here is the call graph for this function:

◆ createOrUpdateTab() [5/9]

enable_if_auto_gui_cfg<T> createOrUpdateTab ( const std::string &  name,
WriteBufferedTripleBuffer< T > &  data,
LockableT &  mutex,
unsigned long  guiTaskPeriod = 10 
)
inline

Definition at line 148 of file RemoteGuiComponentPlugin.h.

+ Here is the call graph for this function:

◆ createOrUpdateTab() [6/9]

enable_if_auto_gui_cfg<T> createOrUpdateTab ( const std::string &  name,
WriteBufferedTripleBuffer< T > &  data,
unsigned long  guiTaskPeriod = 10 
)
inline

Definition at line 111 of file RemoteGuiComponentPlugin.h.

+ Here is the call graph for this function:

◆ createOrUpdateTab() [7/9]

enable_if_auto_gui_cfg<T> createOrUpdateTab ( T data,
unsigned long  guiTaskPeriod = 10 
)
inline

Definition at line 103 of file RemoteGuiComponentPlugin.h.

+ Here is the call graph for this function:

◆ createOrUpdateTab() [8/9]

enable_if_auto_gui_cfg<T> createOrUpdateTab ( WriteBufferedTripleBuffer< T > &  data,
LockableT &  mutex,
unsigned long  guiTaskPeriod = 10 
)
inline

Definition at line 181 of file RemoteGuiComponentPlugin.h.

◆ createOrUpdateTab() [9/9]

enable_if_auto_gui_cfg<T> createOrUpdateTab ( WriteBufferedTripleBuffer< T > &  data,
unsigned long  guiTaskPeriod = 10 
)
inline

Definition at line 139 of file RemoteGuiComponentPlugin.h.

+ Here is the call graph for this function:

◆ getRemoteGui()

const RemoteGuiInterfacePrx & getRemoteGui ( ) const

Definition at line 104 of file RemoteGuiComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ getTab()

RemoteGui::TabProxy & getTab ( const std::string &  name = "")

Definition at line 80 of file RemoteGuiComponentPlugin.cpp.

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

◆ hasTab()

bool hasTab ( const std::string &  name = "")

Definition at line 87 of file RemoteGuiComponentPlugin.cpp.

+ Here is the caller graph for this function:

◆ postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( PropertyDefinitionsPtr properties)
overrideprotectedvirtual

Reimplemented from ComponentPlugin.

Definition at line 153 of file RemoteGuiComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ postOnConnectComponent()

void postOnConnectComponent ( )
overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 124 of file RemoteGuiComponentPlugin.cpp.

◆ postOnDisconnectComponent()

void postOnDisconnectComponent ( )
overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 138 of file RemoteGuiComponentPlugin.cpp.

◆ preOnConnectComponent()

void preOnConnectComponent ( )
overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 117 of file RemoteGuiComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ preOnInitComponent()

void preOnInitComponent ( )
overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

Definition at line 109 of file RemoteGuiComponentPlugin.cpp.

+ Here is the call graph for this function:

◆ removeTab()

void removeTab ( const std::string &  name = "")

Definition at line 93 of file RemoteGuiComponentPlugin.cpp.

+ Here is the caller graph for this function:

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