This widget allows you to inspect the current state of the working memory. More...

#include <MemoryX/gui-plugins/WorkingMemoryGui/WorkingMemoryGuiPlugin.h>

Inheritance diagram for WorkingMemoryController:

Classes
struct	ObjectDefinition

struct	RobotDefinition

struct	SegmentTab

Public Slots
void	agentsRemoved ()
	agentsRemoved One or multiple agent(s) have been removed from memory. This method updates all Qt related things (visu/gui). More...

void	clearEntitiesData ()

void	clearEntitiesVisu (const std::string &segmentName="")

void	clearWorkingMemory ()
	clearWorkingMemory deletes the current contents of WorkingMemory More...

void	existenceCertaintyToggled (bool isChecked)

void	objectsRemoved ()
	objectsRemoved One or multiple object(s) have been removed from memory. This method updates all Qt related things (visu/gui). More...

void	rebuildVisualization ()

void	refetchEntitiesFromMemory ()

void	removeEntityInTree (const std::string entityId, const std::string entityType)

void	setupVisualization ()

void	showAgents (bool show)
	Sets the visibility for agents. More...

void	showPlane (bool show)

void	showVisuLayers (bool show)
	Sets the visibility for debugDrawer's visualization layers. More...

void	startTimerInGUIThread ()

void	treeItemDoubleClicked (QTreeWidgetItem *item, int column)

void	uncertaintyVisuToggled (bool isChecked)

void	updateEntityTree (memoryx::EntityBasePtr entity, QString entityType, bool isNew)

void	updateEntityVisu (memoryx::EntityBasePtr entity, QString entityType, bool isNew)

Public Slots inherited from ArmarXWidgetController
void	configAccepted ()

void	configRejected ()

void	enableMainWidget (bool enable)

Signals
void	entityChanged (memoryx::EntityBasePtr entity, QString entityType, bool isNew)

void	signalAgentsRemoved ()

void	signalClearEntities (const std::string &segmentName)

void	signalObjectRemoved ()

void	signalRebuildVisualization ()

void	signalRefetchEntities ()

void	signalRemoveTabs ()

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...

void	convertObjectInstanceToGlobalPose (ObjectInstance &obj)

QPointer< QDialog >	getConfigDialog (QWidget *parent=nullptr) override
	getConfigDialog returns a pointer to the a configuration widget of this controller. More...

QPointer< QWidget >	getCustomTitlebarWidget (QWidget *parent) override
	getTitleToolbar returns a pointer to the a toolbar widget of this controller. More...

SoNode *	getScene () override
	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...

QPointer< QDialog >	getSceneConfigDialog (QWidget *parent=nullptr) override
	Reimplementing this function and returning a QDialog* will enable a configuration button which opens the returned dialog. More...

void	loadSettings (QSettings *settings) override
	Implement to load the settings that are part of the GUI configuration. More...

void	onConnectComponent () override
	Pure virtual hook for the subclass. More...

void	onDisconnectComponent () override
	Hook for subclass. More...

void	onExitComponent () override
	Hook for subclass. More...

void	onInitComponent () override
	Pure virtual hook for the subclass. More...

void	reportEntityCreated (const std::string &segmentName, const ::memoryx::EntityBasePtr &entity, const ::Ice::Current &=Ice::emptyCurrent) override

void	reportEntityRemoved (const std::string &segmentName, const ::memoryx::EntityBasePtr &entity, const ::Ice::Current &=Ice::emptyCurrent) override

void	reportEntityUpdated (const std::string &segmentName, const ::memoryx::EntityBasePtr &entityBaseOld, const ::memoryx::EntityBasePtr &entityBaseNew, const ::Ice::Current &=Ice::emptyCurrent) override

void	reportMemoryCleared (const std::string &segmentName, const ::Ice::Current &=Ice::emptyCurrent) override

void	reportSnapshotCompletelyLoaded (const Ice::Current &c=Ice::emptyCurrent) override

void	reportSnapshotLoaded (const std::string &segmentName, const ::Ice::Current &=Ice::emptyCurrent) override

void	saveSettings (QSettings *settings) override
	Implement to save the settings as part of the GUI configuration. More...

void	setMutex3D (RecursiveMutexPtr const &mutex3D) override
	This mutex is used to protect 3d scene updates. Usually called by the ArmarXGui main window on creation of this controller. More...

	WorkingMemoryController ()

	~WorkingMemoryController () override

Public Member Functions inherited from ArmarXComponentWidgetControllerTemplate< WorkingMemoryController >
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...

QString	getInstanceName ()

virtual QMainWindow *	getMainWindow ()
	Returns the ArmarX MainWindow. More...

QPointer< TipDialog >	getTipDialog () 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	onLockWidget ()

virtual void	onUnlockWidget ()

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)

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< PropertyUserPtr >	getAdditionalPropertyUsers () 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< T >	getPropertyAsCSV (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 QIcon	GetWidgetIcon ()

static QString	GetWidgetName ()

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)

Protected Types
using	EntityEntryMap = std::map< std::string, ObjectDefinition >

Protected Member Functions
bool	addAgent (const AgentInstancePtr agent)

int	addTab (std::string segmentName)

void	connectSlots ()

void	createAgentVisualisation (const std::string entityId)

bool	createEntity (memoryx::EntityBasePtr entity, const std::string &entityType)
	createEntity Updates currentEntities or currentAgents with data. More...

void	createObjectVisualization (ObjectDefinition &o)

void	exportToVRML ()

void	processPackages (const std::string &packages)

void	removeTab (std::string segmentName)

void	removeTabs ()

void	setupEntityVisu (const ObjectDefinition &objWrapper)

void	timerEvent (QTimerEvent *) override

void	updateAgentVisualisation (const EntityBasePtr entity)

void	updateAgentVisualisation (const std::string entityId)

void	updateObjectData (const ObjectInstancePtr obj)

void	updateVisualization (const EntityWrappers::SimoxObjectWrapperPtr objWrapper)

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 LogSenderPtr &	getLogSender () 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	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
SoSeparator *	agentsVisu

EntityEntryMap	currentEntities

DebugLayerControlWidget *	debugLayerControlWidget

SoSeparator *	debugLayerVisu

EntityEntryMap	deletedEntities

SoSeparator *	objectsVisu

SoSeparator *	planeVisu

SoSeparator *	rootVisu

memoryx::NameList	segmentNames

std::map< std::string, struct SegmentTab >	segmentTabs

bool	show3DViewer

std::atomic< bool >	showObjInstanceUncertainties

Ui::WorkingMemoryGuiPlugin	ui

bool	verbose

Protected Attributes inherited from ArmarXWidgetController
std::shared_ptr< std::recursive_mutex >	mutex3D

Protected Attributes inherited from Logging
MessageTypeT	minimumLoggingLevel

SpamFilterDataPtr	spamFilter

LogTag	tag

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...

Detailed Description

This widget allows you to inspect the current state of the working memory.

See also: WorkingMemoryGuiPlugin

Definition at line 170 of file WorkingMemoryGuiPlugin.h.

Member Typedef Documentation

◆ EntityEntryMap

using EntityEntryMap = std::map<std::string, ObjectDefinition>

protected

Definition at line 371 of file WorkingMemoryGuiPlugin.h.

Constructor & Destructor Documentation

◆ WorkingMemoryController()

WorkingMemoryController ( )

Definition at line 147 of file WorkingMemoryGuiPlugin.cpp.

◆ ~WorkingMemoryController()

~WorkingMemoryController ( )

override

Definition at line 176 of file WorkingMemoryGuiPlugin.cpp.

Member Function Documentation

◆ addAgent()

bool addAgent ( const AgentInstancePtr agent )

protected

Updates an entity of type AgentInstance in the agents map.

Parameters

entity Pointer to the entity instance.

Returns: True on success.

Definition at line 1922 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ addTab()

int addTab ( std::string segmentName )

protected

At tab for a given segment name if the tab does not already exist.

Parameters

segmentName segment name.

Returns: index of new tab

Definition at line 1807 of file WorkingMemoryGuiPlugin.cpp.

◆ agentsRemoved

void agentsRemoved ( )

slot

agentsRemoved One or multiple agent(s) have been removed from memory. This method updates all Qt related things (visu/gui).

Definition at line 1679 of file WorkingMemoryGuiPlugin.cpp.

◆ clearEntitiesData

void clearEntitiesData ( )

slot

Clears all entity data in the current agents and current entities maps. All cleared entities/agents are stored to the deletedAgents/deletedEntities map.

Definition at line 1292 of file WorkingMemoryGuiPlugin.cpp.

◆ clearEntitiesVisu

void clearEntitiesVisu ( const std::string & segmentName = "" )

slot

Clears all visu data of deletedAgents/deletedEntites all items in the tree widget.

Definition at line 1314 of file WorkingMemoryGuiPlugin.cpp.

◆ clearWorkingMemory

void clearWorkingMemory ( )

slot

clearWorkingMemory deletes the current contents of WorkingMemory

Definition at line 1206 of file WorkingMemoryGuiPlugin.cpp.

◆ 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 446 of file WorkingMemoryGuiPlugin.cpp.

◆ connectSlots()

void connectSlots ( )

protected

Connects signals to the slots.

Definition at line 549 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ convertObjectInstanceToGlobalPose()

void convertObjectInstanceToGlobalPose ( ObjectInstance & obj )

Definition at line 745 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ createAgentVisualisation()

void createAgentVisualisation ( const std::string entityId )

protected

Creates visualisation for entities of type AgentInstance.

Parameters

entityId Entity ID.

Definition at line 1897 of file WorkingMemoryGuiPlugin.cpp.

◆ createEntity()

bool createEntity	(	memoryx::EntityBasePtr	entity,
		const std::string &	entityType
	)

protected

createEntity Updates currentEntities or currentAgents with data.

Parameters

entity
entityType

Returns

Definition at line 882 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ createObjectVisualization()

void createObjectVisualization ( ObjectDefinition & o )

protected

Creates visualisation for entities of type ObjectInstance.

Parameters

objWrapper Simox wrapper of the entity.

Definition at line 1047 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ entityChanged

void entityChanged	(	memoryx::EntityBasePtr	entity,
		QString	entityType,
		bool	isNew
	)

signal

◆ existenceCertaintyToggled

void existenceCertaintyToggled ( bool isChecked )

slot

Definition at line 1418 of file WorkingMemoryGuiPlugin.cpp.

◆ exportToVRML()

void exportToVRML ( )

protected

Definition at line 584 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ getConfigDialog()

QPointer< QDialog > getConfigDialog ( QWidget * parent = nullptr )

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

parent Pointer 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 412 of file WorkingMemoryGuiPlugin.cpp.

◆ getCustomTitlebarWidget()

QPointer< QWidget > getCustomTitlebarWidget ( QWidget * parent )

overridevirtual

getTitleToolbar returns a pointer to the a toolbar widget of this controller.

It is optional. It must return the same instance on all calls.

The returned toolbar is displayed in the titlebar of the parent dockwidget. Use this to show button that should always be visible in the widget, but should not take up space in the widget. Keep the size of the toolbar to a minimum, so that it is not wider than the widget itself.

Reimplemented from ArmarXWidgetController.

Definition at line 1875 of file WorkingMemoryGuiPlugin.cpp.

◆ getScene()

SoNode * getScene ( )

overridevirtual

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.

Returns

Reimplemented from ArmarXWidgetController.

Definition at line 513 of file WorkingMemoryGuiPlugin.cpp.

◆ getSceneConfigDialog()

QPointer< QDialog > getSceneConfigDialog ( QWidget * parent = nullptr )

overridevirtual

Reimplementing this function and returning a QDialog* will enable a configuration button which opens the returned dialog.

Parameters

parent The parent widget which should be used as parent of the dialog

Returns: The dialog to open wehen the configuration button is clicked

Reimplemented from ArmarXWidgetController.

Definition at line 524 of file WorkingMemoryGuiPlugin.cpp.

◆ GetWidgetIcon()

static QIcon GetWidgetIcon ( )

inlinestatic

Definition at line 191 of file WorkingMemoryGuiPlugin.h.

◆ GetWidgetName()

static QString GetWidgetName ( )

inlinestatic

Definition at line 187 of file WorkingMemoryGuiPlugin.h.

◆ loadSettings()

void loadSettings ( QSettings * settings )

overridevirtual

Implement to load the settings that are part of the GUI configuration.

These settings are NOT loaded automatically on widget startup, but when a GUI config is loaded (instead of the optional config dialog).

Implements ArmarXWidgetController.

Definition at line 461 of file WorkingMemoryGuiPlugin.cpp.

◆ objectsRemoved

void objectsRemoved ( )

slot

objectsRemoved One or multiple object(s) have been removed from memory. This method updates all Qt related things (visu/gui).

Definition at line 1660 of file WorkingMemoryGuiPlugin.cpp.

◆ 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 291 of file WorkingMemoryGuiPlugin.cpp.

◆ onDisconnectComponent()

void onDisconnectComponent ( )

overridevirtual

Hook for subclass.

Is called if a dependency of the object got lost (crash, network error, stopped, ...). This hook should be the inverse to onConnectComponent(). So that onDisconnectComponent() and onConnectComponent() can be called alternatingly and the ManagedIceObject remains in valid states. *

See also: onConnectComponent

Reimplemented from ManagedIceObject.

Definition at line 337 of file WorkingMemoryGuiPlugin.cpp.

◆ onExitComponent()

void onExitComponent ( )

overridevirtual

Hook for subclass.

Is called once the component terminates. Use for cleanup. Only called once.

Reimplemented from ManagedIceObject.

Definition at line 358 of file WorkingMemoryGuiPlugin.cpp.

◆ 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 227 of file WorkingMemoryGuiPlugin.cpp.

◆ processPackages()

void processPackages ( const std::string & packages )

protected

Definition at line 432 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ rebuildVisualization

void rebuildVisualization ( )

slot

Rebuilds the visualisation for all entities.

Definition at line 1359 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ refetchEntitiesFromMemory

void refetchEntitiesFromMemory ( )

slot

Fetches all entities stored in the objectInstances, agentInstances and worldState segments in the working memory.

Definition at line 656 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ removeEntityInTree

void removeEntityInTree	(	const std::string	entityId,
		const std::string	entityType
	)

slot

Removes the item corresponding to an entity from the tree widget.

Parameters

entityId	Entity ID.
entityType	Entity type.

Definition at line 1770 of file WorkingMemoryGuiPlugin.cpp.

◆ removeTab()

void removeTab ( std::string segmentName )

protected

Removes a single tab for a given segment name.

Parameters

segmentName segment name.

Definition at line 1848 of file WorkingMemoryGuiPlugin.cpp.

◆ removeTabs()

void removeTabs ( )

protected

Removes all segment-tabs.

Definition at line 1865 of file WorkingMemoryGuiPlugin.cpp.

◆ reportEntityCreated()

void reportEntityCreated	(	const std::string &	segmentName,
		const ::memoryx::EntityBasePtr &	entity,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

◆ reportEntityRemoved()

void reportEntityRemoved	(	const std::string &	segmentName,
		const ::memoryx::EntityBasePtr &	entity,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

◆ reportEntityUpdated()

void reportEntityUpdated	(	const std::string &	segmentName,
		const ::memoryx::EntityBasePtr &	entityBaseOld,
		const ::memoryx::EntityBasePtr &	entityBaseNew,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

◆ reportMemoryCleared()

void reportMemoryCleared	(	const std::string &	segmentName,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

◆ reportSnapshotCompletelyLoaded()

void reportSnapshotCompletelyLoaded ( const Ice::Current & c = Ice::emptyCurrent )

override

Definition at line 1706 of file WorkingMemoryGuiPlugin.cpp.

◆ reportSnapshotLoaded()

void reportSnapshotLoaded	(	const std::string &	segmentName,
		const ::Ice::Current &	= `Ice::emptyCurrent`
	)

override

◆ saveSettings()

void saveSettings ( QSettings * settings )

overridevirtual

Implement to save the settings as part of the GUI configuration.

These settings are NOT saved automatically when closing the widget, but when a GUI config is saved.

Implements ArmarXWidgetController.

Definition at line 492 of file WorkingMemoryGuiPlugin.cpp.

◆ setMutex3D()

void setMutex3D ( RecursiveMutexPtr const & mutex3D )

overridevirtual

This mutex is used to protect 3d scene updates. Usually called by the ArmarXGui main window on creation of this controller.

Parameters

mutex3D

Reimplemented from ArmarXWidgetController.

Definition at line 1758 of file WorkingMemoryGuiPlugin.cpp.

◆ setupEntityVisu()

void setupEntityVisu ( const ObjectDefinition & objWrapper )

protected

Setups visualisation for entities of type ObjectInstance.

Parameters

objWrapper Simox wrapper of the entity.

Definition at line 1445 of file WorkingMemoryGuiPlugin.cpp.

◆ setupVisualization

void setupVisualization ( )

slot

Setups the visualisation for all entities stored in currentEntities.

Definition at line 1425 of file WorkingMemoryGuiPlugin.cpp.

◆ showAgents

void showAgents ( bool show )

slot

Sets the visibility for agents.

Parameters

show	Whether they should be visible.

Definition at line 1240 of file WorkingMemoryGuiPlugin.cpp.

◆ showPlane

void showPlane ( bool show )

slot

Definition at line 1266 of file WorkingMemoryGuiPlugin.cpp.

◆ showVisuLayers

void showVisuLayers ( bool show )

slot

Sets the visibility for debugDrawer's visualization layers.

Parameters

show	Whether they should be visible.

Definition at line 1224 of file WorkingMemoryGuiPlugin.cpp.

◆ signalAgentsRemoved

void signalAgentsRemoved ( )

signal

◆ signalClearEntities

void signalClearEntities ( const std::string & segmentName )

signal

◆ signalObjectRemoved

void signalObjectRemoved ( )

signal

◆ signalRebuildVisualization

void signalRebuildVisualization ( )

signal

◆ signalRefetchEntities

void signalRefetchEntities ( )

signal

◆ signalRemoveTabs

void signalRemoveTabs ( )

signal

◆ startTimerInGUIThread

void startTimerInGUIThread ( )

slot

Definition at line 737 of file WorkingMemoryGuiPlugin.cpp.

◆ timerEvent()

void timerEvent ( QTimerEvent * )

overrideprotected

Updates joint values for all agents.

Parameters

event QTimerEvent.

Definition at line 629 of file WorkingMemoryGuiPlugin.cpp.

◆ treeItemDoubleClicked

void treeItemDoubleClicked	(	QTreeWidgetItem *	item,
		int	column
	)

slot

Shows information about a double-clicked item in the tree widget.

Parameters

item	Double-clicked item.
column	Double-clicked column.

Definition at line 641 of file WorkingMemoryGuiPlugin.cpp.

◆ uncertaintyVisuToggled

void uncertaintyVisuToggled ( bool isChecked )

slot

Setups visualisation for all entities stored in currentEntities if the uncertainty visualisation is checked.

Parameters

isChecked TRUE if the uncertainty visualisation option is checked.

Definition at line 1408 of file WorkingMemoryGuiPlugin.cpp.

◆ updateAgentVisualisation() [1/2]

void updateAgentVisualisation ( const EntityBasePtr entity )

protected

Definition at line 2045 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ updateAgentVisualisation() [2/2]

void updateAgentVisualisation ( const std::string entityId )

protected

Updates visualisation for entities of type AgentInstance.

Parameters

entityId Entity ID.

Definition at line 2037 of file WorkingMemoryGuiPlugin.cpp.

◆ updateEntityTree

void updateEntityTree	(	memoryx::EntityBasePtr	entity,
		QString	entityType,
		bool	isNew
	)

slot

Updates the item corresponding to an entity in the tree widget.

Parameters

entityId	Entity ID.
entityType	Entity type. Supported options are: objectInstances, agentInstances and worldState.
isNew	TRUE if it is a new entity.

Definition at line 1123 of file WorkingMemoryGuiPlugin.cpp.

◆ updateEntityVisu

void updateEntityVisu	(	memoryx::EntityBasePtr	entity,
		QString	entityType,
		bool	isNew
	)

slot

Updates the visualisation for an entity.

Parameters

entityID	Entity ID.
entityType	Entity type. Supported options are: objectInstances, agentInstances and worldState.

Definition at line 962 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ updateObjectData()

void updateObjectData ( const ObjectInstancePtr obj )

protected

Updates an entity of type ObjectInstance in the current entities map. obj Pointer to the entity instance.

Definition at line 812 of file WorkingMemoryGuiPlugin.cpp.

Here is the call graph for this function:

◆ updateVisualization()

void updateVisualization ( const EntityWrappers::SimoxObjectWrapperPtr objWrapper )

protected

Updates visualisation for entities of type AgentInstance.

Parameters

objWrapper Simox wrapper of the entity.

Definition at line 1099 of file WorkingMemoryGuiPlugin.cpp.

Member Data Documentation

◆ agentsVisu

SoSeparator* agentsVisu

protected

agent visualisation node.

Definition at line 384 of file WorkingMemoryGuiPlugin.h.

◆ currentEntities

EntityEntryMap currentEntities

protected

Current entities of type ObjectInstance.

Definition at line 376 of file WorkingMemoryGuiPlugin.h.

◆ debugLayerControlWidget

DebugLayerControlWidget* debugLayerControlWidget

protected

Definition at line 388 of file WorkingMemoryGuiPlugin.h.

◆ debugLayerVisu

SoSeparator* debugLayerVisu

protected

Definition at line 385 of file WorkingMemoryGuiPlugin.h.

◆ deletedEntities

EntityEntryMap deletedEntities

protected

Entities that have been deleted (during last loop) of type ObjectInstance.

Definition at line 377 of file WorkingMemoryGuiPlugin.h.

◆ objectsVisu

SoSeparator* objectsVisu

protected

object visualisation node.

Definition at line 383 of file WorkingMemoryGuiPlugin.h.

◆ planeVisu

SoSeparator* planeVisu

protected

Definition at line 386 of file WorkingMemoryGuiPlugin.h.

◆ rootVisu

SoSeparator* rootVisu

protected

Root visualisation node.

Definition at line 382 of file WorkingMemoryGuiPlugin.h.

◆ segmentNames

memoryx::NameList segmentNames

protected

Name of current segments.

Definition at line 374 of file WorkingMemoryGuiPlugin.h.

◆ segmentTabs

std::map<std::string, struct SegmentTab> segmentTabs

protected

Current segment tabs.

Definition at line 373 of file WorkingMemoryGuiPlugin.h.

◆ show3DViewer

bool show3DViewer

protected

Definition at line 379 of file WorkingMemoryGuiPlugin.h.

◆ showObjInstanceUncertainties

std::atomic<bool> showObjInstanceUncertainties

protected

Definition at line 380 of file WorkingMemoryGuiPlugin.h.

◆ ui

Ui::WorkingMemoryGuiPlugin ui

protected

Definition at line 339 of file WorkingMemoryGuiPlugin.h.

◆ verbose

bool verbose

protected

Definition at line 341 of file WorkingMemoryGuiPlugin.h.

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

MemoryX/gui-plugins/WorkingMemoryGui/WorkingMemoryGuiPlugin.h
MemoryX/gui-plugins/WorkingMemoryGui/WorkingMemoryGuiPlugin.cpp

Classes

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ EntityEntryMap

Constructor & Destructor Documentation

◆ WorkingMemoryController()

◆ ~WorkingMemoryController()

Member Function Documentation

◆ addAgent()

◆ addTab()

◆ agentsRemoved

◆ clearEntitiesData

◆ clearEntitiesVisu

◆ clearWorkingMemory

◆ configured()

◆ connectSlots()

◆ convertObjectInstanceToGlobalPose()

◆ createAgentVisualisation()

◆ createEntity()

◆ createObjectVisualization()

◆ entityChanged

◆ existenceCertaintyToggled

◆ exportToVRML()

◆ getConfigDialog()

◆ getCustomTitlebarWidget()

◆ getScene()

◆ getSceneConfigDialog()

◆ GetWidgetIcon()

◆ GetWidgetName()

◆ loadSettings()

◆ objectsRemoved

◆ onConnectComponent()

◆ onDisconnectComponent()

◆ onExitComponent()

◆ onInitComponent()

◆ processPackages()

◆ rebuildVisualization

◆ refetchEntitiesFromMemory

◆ removeEntityInTree

◆ removeTab()

◆ removeTabs()

◆ reportEntityCreated()

◆ reportEntityRemoved()

◆ reportEntityUpdated()

◆ reportMemoryCleared()

◆ reportSnapshotCompletelyLoaded()

◆ reportSnapshotLoaded()

◆ saveSettings()

◆ setMutex3D()

◆ setupEntityVisu()

◆ setupVisualization

◆ showAgents

◆ showPlane

◆ showVisuLayers

◆ signalAgentsRemoved

◆ signalClearEntities

◆ signalObjectRemoved

◆ signalRebuildVisualization

◆ signalRefetchEntities

◆ signalRemoveTabs

◆ startTimerInGUIThread

◆ timerEvent()

◆ treeItemDoubleClicked

◆ uncertaintyVisuToggled

◆ updateAgentVisualisation() [1/2]

◆ updateAgentVisualisation() [2/2]

◆ updateEntityTree

◆ updateEntityVisu

◆ updateObjectData()

◆ updateVisualization()

Member Data Documentation

◆ agentsVisu