ScopedClient Class Reference

viz::Client that will delete (clear) committed layers when destroyed. More...

#include <RobotAPI/components/ArViz/Client/ScopedClient.h>

+ Inheritance diagram for ScopedClient:

Public Member Functions

void clear ()
 
 Client ()=default
 
 Client (armarx::Component &component, std::string const &topicNameProperty="ArVizTopicName", std::string const &storageNameProperty="ArVizStorageName")
 
 Client (const Client &)=default
 
 Client (ManagedIceObject &obj, std::string const &topicName="ArVizTopic", std::string const &storageName="ArVizStorage")
 
Layer layer (std::string const &name) const
 
 ScopedClient (const Client &client)
 
virtual ~ScopedClient ()
 
- Public Member Functions inherited from Client
 Client ()=default
 
 Client (armarx::Component &component, std::string const &topicNameProperty="ArVizTopicName", std::string const &storageNameProperty="ArVizStorageName")
 
 Client (const Client &)=default
 
 Client (ManagedIceObject &obj, std::string const &topicName="ArVizTopic", std::string const &storageName="ArVizStorage")
 
void commit (Layer const &layer)
 
CommitResult commit (StagedCommit const &commit)
 
void commit (std::vector< Layer > const &layers)
 
CommitResultAsync commitAsync (StagedCommit const &commit)
 
void commitDeleteLayer (std::string const &name)
 
void commitLayerContaining (std::string const &name)
 
template<typename ElementT >
void commitLayerContaining (std::string const &name, ElementT const &element)
 
Layer layer (std::string const &name) const
 
StagedCommit stage ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Client
static Client createForGuiPlugin (armarx::Component &component, std::string const &topicName="ArVizTopic", std::string const &storageName="ArVizStorage")
 
static Client createFromProxies (std::string const &componentName, armarx::viz::Topic::ProxyType const &topic, armarx::viz::StorageAndTopicInterfacePrx const &storage)
 
static Client createFromTopic (std::string const &componentName, armarx::viz::Topic::ProxyType const &topic)
 

Detailed Description

viz::Client that will delete (clear) committed layers when destroyed.

Note that, as a consequence, a network call will be performed in the destructor.

This might be useful if you have a class MyTask perform visualizing while performing some task, but whose visualization should be removed when the task finished. In this case, MyTask can have a viz::ScopedClient (which can be created from a regular viz::Client). When destructing the instance of MyTask, all visualization done by MyTask will be cleared (as viz::ScopedClient will go out of scope as well).

Definition at line 42 of file ScopedClient.h.

Constructor & Destructor Documentation

◆ ScopedClient()

ScopedClient ( const Client client)

Definition at line 29 of file ScopedClient.cpp.

◆ ~ScopedClient()

~ScopedClient ( )
virtual

Definition at line 41 of file ScopedClient.cpp.

+ Here is the call graph for this function:

Member Function Documentation

◆ clear()

void clear ( )

Definition at line 48 of file ScopedClient.cpp.

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

◆ Client() [1/4]

Client
default

◆ Client() [2/4]

Definition at line 8 of file Client.cpp.

◆ Client() [3/4]

Client
default

◆ Client() [4/4]

Definition at line 26 of file Client.cpp.

◆ layer()

Layer layer ( std::string const &  name) const

Definition at line 34 of file ScopedClient.cpp.

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

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