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< T >	createOrUpdateTab (const std::string &name, T &data, unsigned long guiTaskPeriod=10)
template<class T, class LockableT>
enable_if_auto_gui_cfg< T >	createOrUpdateTab (const std::string &name, WriteBufferedTripleBuffer< T > &data, LockableT &mutex, unsigned long guiTaskPeriod=10)
template<class T>
enable_if_auto_gui_cfg< T >	createOrUpdateTab (const std::string &name, WriteBufferedTripleBuffer< T > &data, unsigned long guiTaskPeriod=10)
template<class T>
enable_if_auto_gui_cfg< T >	createOrUpdateTab (T &data, unsigned long guiTaskPeriod=10)
template<class T, class LockableT>
enable_if_auto_gui_cfg< T >	createOrUpdateTab (WriteBufferedTripleBuffer< T > &data, LockableT &mutex, unsigned long guiTaskPeriod=10)
template<class T>
enable_if_auto_gui_cfg< T >	createOrUpdateTab (WriteBufferedTripleBuffer< T > &data, unsigned long guiTaskPeriod=10)
const RemoteGuiInterfacePrx &	getRemoteGui () const
RemoteGui::TabProxy &	getTab (const std::string &name="")
bool	hasTab (const std::string &name="")
void	removeTab (const std::string &name="")
Public Member Functions inherited from ManagedIceObjectPlugin
ManagedIceObject &	parent ()
template<class T>
T &	parent ()
const ManagedIceObject &	parent () const
template<class T>
const T &	parent () 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 ()

Member Typedef Documentation

enable_if_auto_gui_cfg

template<class T>

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

TabTask

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

Member Function Documentation

createOrUpdateTab() [1/9]

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

createOrUpdateTab() [2/9]

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

createOrUpdateTab() [3/9]

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

createOrUpdateTab() [4/9]

template<class T>

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

inline

createOrUpdateTab() [5/9]

template<class T, class LockableT>

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

inline

createOrUpdateTab() [6/9]

template<class T>

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

inline

createOrUpdateTab() [7/9]

template<class T>

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

inline

createOrUpdateTab() [8/9]

template<class T, class LockableT>

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

inline

createOrUpdateTab() [9/9]

template<class T>

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

inline

getRemoteGui()

const RemoteGuiInterfacePrx & getRemoteGui

(

)

const

getTab()

RemoteGui::TabProxy & getTab

(

const std::string &

name = ""

)

hasTab()

bool hasTab

(

const std::string &

name = ""

)

postCreatePropertyDefinitions()

void postCreatePropertyDefinitions ( PropertyDefinitionsPtr & properties )

overrideprotectedvirtual

Reimplemented from ComponentPlugin.

postOnConnectComponent()

void postOnConnectComponent ( )

overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

postOnDisconnectComponent()

void postOnDisconnectComponent ( )

overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

preOnConnectComponent()

void preOnConnectComponent ( )

overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

preOnInitComponent()

void preOnInitComponent ( )

overrideprotectedvirtual

Reimplemented from ManagedIceObjectPlugin.

removeTab()

void removeTab

(

const std::string &

name = ""

)

---

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

• ArmarXGui/libraries/ArmarXGuiComponentPlugins/RemoteGuiComponentPlugin.h
• ArmarXGui/libraries/ArmarXGuiComponentPlugins/RemoteGuiComponentPlugin.cpp