A config-dialog containing one (or multiple) proxy finders. More...

#include <ArmarXGui/libraries/SimpleConfigDialog/SimpleConfigDialog.h>

Inheritance diagram for SimpleConfigDialog:

Classes
struct	EntryData

Public Member Functions
void	addLineEdit (const std::string &name, const std::string &label, const std::string &defaultValue="")

template<class ProxyType >
void	addProxyFinder (const EntryData &entryData)

template<class ProxyType >
void	addProxyFinder (const std::string &name, const std::string &description, const std::string &mask)

template<class... ProxyTypes>
void	addProxyFinder (const std::vector< EntryData > &entryData)

std::string	get (const std::string &entryName) const

std::string	get (const std::string &entryName, const std::string &def) const

QVBoxLayout *	getLayout ()

std::string	getLineEditText (const std::string &entryName) const

std::string	getProxyName (const std::string &entryName) const

std::string	getProxyName (const std::string &entryName, const std::string &def) const

bool	hasLineEdit (const std::string &entryName) const

bool	hasProxyName (const std::string &entryName) const

	SimpleConfigDialog (QWidget *parent=nullptr)
	ctor More...

	~SimpleConfigDialog () override
	dtor 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 ()

Protected Member Functions
std::string	getDefaultName () const override
	Returns the dialog's default name. More...

void	onConnectComponent () override
	noop More...

void	onInitComponent () override
	Initializes the proxy finder. 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	onExitComponent ()
	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 LogSenderPtr &	getLogSender () const
	Retrieve log sender. More...

LogSenderPtr	loghelper (const char file, int line, const char function) const

Friends
template<class... ProxyTs>
struct	SimpleConfigDialogAdder

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 Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

Detailed Description

A config-dialog containing one (or multiple) proxy finders.

To use it in your gui: Include

#include <ArmarXGui/libraries/SimpleConfigDialog/SimpleConfigDialog.h>

and link against SimpleConfigDialog from ArmarXGui

Add this member to your WidgetController

QPointer<SimpleConfigDialog> dialog;

Override the function

virtual QPointer<QDialog> getConfigDialog(QWidget *parent) override
{
   if (!dialog)
   {
       dialog = new SimpleConfigDialog(parent);
       dialog->addProxyFinder<ProxyType1>({"Accessname1", "Description text 1", "SearchMask1"});
       dialog->addProxyFinder<ProxyType2>({"Accessname2", "Description text 2", "SearchMask2"});
       dialog->getLayout()->addWidget(new QLabel{"i am a label"};
       //or add multiple at once
       dialog->addProxyFinder<ProxyType3,ProxyType4>({{"Accessname3", "Description text 3", "SearchMask3"}, {"Accessname4", "Description text 4", "SearchMask4"}});
   }
   return qobject_cast<SimpleConfigDialog*>(dialog);
}

Where you want to access the proxy names:

dialog->getProxyName("Accessname1");

Definition at line 84 of file SimpleConfigDialog.h.

Constructor & Destructor Documentation

◆ SimpleConfigDialog()

SimpleConfigDialog ( QWidget * parent = nullptr )

explicit

ctor

Parameters

parent the dialog's parent

Definition at line 35 of file SimpleConfigDialog.cpp.

◆ ~SimpleConfigDialog()

~SimpleConfigDialog ( )

override

dtor

Definition at line 41 of file SimpleConfigDialog.cpp.

Member Function Documentation

◆ addLineEdit()

void addLineEdit	(	const std::string &	name,
		const std::string &	label,
		const std::string &	defaultValue = `""`
	)

Definition at line 87 of file SimpleConfigDialog.cpp.

◆ addProxyFinder() [1/3]

void addProxyFinder ( const EntryData & entryData )

inline

Definition at line 110 of file SimpleConfigDialog.h.

◆ addProxyFinder() [2/3]

void addProxyFinder	(	const std::string &	name,
		const std::string &	description,
		const std::string &	mask
	)

inline

Definition at line 117 of file SimpleConfigDialog.h.

◆ addProxyFinder() [3/3]

void addProxyFinder ( const std::vector< EntryData > & entryData )

inline

Definition at line 103 of file SimpleConfigDialog.h.

Here is the caller graph for this function:

◆ get() [1/2]

std::string get ( const std::string & entryName ) const

Definition at line 113 of file SimpleConfigDialog.cpp.

◆ get() [2/2]

std::string get	(	const std::string &	entryName,
		const std::string &	def
	)		const

Definition at line 123 of file SimpleConfigDialog.cpp.

◆ getDefaultName()

std::string getDefaultName ( ) const

overrideprotectedvirtual

Returns the dialog's default name.

Returns: The dialog's default name.

Implements ManagedIceObject.

Definition at line 75 of file SimpleConfigDialog.cpp.

◆ getLayout()

QVBoxLayout * getLayout ( )

Definition at line 81 of file SimpleConfigDialog.cpp.

◆ getLineEditText()

std::string getLineEditText ( const std::string & entryName ) const

Definition at line 101 of file SimpleConfigDialog.cpp.

◆ getProxyName() [1/2]

std::string getProxyName ( const std::string & entryName ) const

Definition at line 47 of file SimpleConfigDialog.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProxyName() [2/2]

std::string getProxyName	(	const std::string &	entryName,
		const std::string &	def
	)		const

Definition at line 53 of file SimpleConfigDialog.cpp.

◆ hasLineEdit()

bool hasLineEdit ( const std::string & entryName ) const

Definition at line 107 of file SimpleConfigDialog.cpp.

◆ hasProxyName()

bool hasProxyName ( const std::string & entryName ) const

Definition at line 59 of file SimpleConfigDialog.cpp.

Here is the call graph for this function:

◆ onConnectComponent()

void onConnectComponent ( )

inlineoverrideprotectedvirtual

noop

Implements ManagedIceObject.

Definition at line 222 of file SimpleConfigDialog.h.

◆ onInitComponent()

void onInitComponent ( )

overrideprotectedvirtual

Initializes the proxy finder.

Implements ManagedIceObject.

Definition at line 65 of file SimpleConfigDialog.cpp.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ SimpleConfigDialogAdder

friend struct SimpleConfigDialogAdder

friend

Definition at line 193 of file SimpleConfigDialog.h.

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

ArmarXGui/libraries/SimpleConfigDialog/SimpleConfigDialog.h
ArmarXGui/libraries/SimpleConfigDialog/SimpleConfigDialog.cpp

Classes

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SimpleConfigDialog()

◆ ~SimpleConfigDialog()

Member Function Documentation

◆ addLineEdit()

◆ addProxyFinder() [1/3]

◆ addProxyFinder() [2/3]

◆ addProxyFinder() [3/3]

◆ get() [1/2]

◆ get() [2/2]

◆ getDefaultName()

◆ getLayout()

◆ getLineEditText()

◆ getProxyName() [1/2]

◆ getProxyName() [2/2]

◆ hasLineEdit()

◆ hasProxyName()

◆ onConnectComponent()

◆ onInitComponent()

Friends And Related Function Documentation

◆ SimpleConfigDialogAdder