List of all members | Public Member Functions | Static Public Member Functions
Client Class Reference

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

+ Inheritance diagram for Client:

Public Member Functions

 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)
 
virtual Layer layer (std::string const &name) const
 
StagedCommit stage ()
 
void updateComponentName (std::string const &name)
 
virtual ~Client ()=default
 

Static Public Member Functions

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

Definition at line 116 of file Client.h.

Constructor & Destructor Documentation

◆ Client() [1/4]

Client ( )
default
+ Here is the caller graph for this function:

◆ Client() [2/4]

Client ( const Client & )
default
+ Here is the call graph for this function:

◆ Client() [3/4]

Client ( armarx::Component & component,
std::string const & topicNameProperty = "ArVizTopicName",
std::string const & storageNameProperty = "ArVizStorageName" )

Definition at line 8 of file Client.cpp.

◆ Client() [4/4]

Client ( ManagedIceObject & obj,
std::string const & topicName = "ArVizTopic",
std::string const & storageName = "ArVizStorage" )

Definition at line 28 of file Client.cpp.

+ Here is the call graph for this function:

◆ ~Client()

virtual ~Client ( )
virtualdefault
+ Here is the call graph for this function:

Member Function Documentation

◆ commit() [1/3]

void commit ( Layer const & layer)
inline

Definition at line 156 of file Client.h.

+ Here is the call graph for this function:

◆ commit() [2/3]

CommitResult commit ( StagedCommit const & commit)

Definition at line 89 of file Client.cpp.

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

◆ commit() [3/3]

void commit ( std::vector< Layer > const & layers)

Definition at line 110 of file Client.cpp.

+ Here is the call graph for this function:

◆ commitAsync()

CommitResultAsync commitAsync ( StagedCommit const & commit)

Definition at line 99 of file Client.cpp.

+ Here is the call graph for this function:

◆ commitDeleteLayer()

void commitDeleteLayer ( std::string const & name)
inline

Definition at line 184 of file Client.h.

+ Here is the call graph for this function:

◆ commitLayerContaining() [1/2]

void commitLayerContaining ( std::string const & name)
inline

Definition at line 166 of file Client.h.

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

◆ commitLayerContaining() [2/2]

template<typename ElementT>
void commitLayerContaining ( std::string const & name,
ElementT const & element )
inline

Definition at line 175 of file Client.h.

+ Here is the call graph for this function:

◆ createForGuiPlugin()

Client createForGuiPlugin ( armarx::Component & component,
std::string const & topicName = "ArVizTopic",
std::string const & storageName = "ArVizStorage" )
static

Definition at line 62 of file Client.cpp.

+ Here is the call graph for this function:

◆ createFromProxies()

Client createFromProxies ( std::string const & componentName,
armarx::viz::Topic::ProxyType const & topic,
armarx::viz::StorageAndTopicInterfacePrx const & storage )
static

Definition at line 50 of file Client.cpp.

+ Here is the call graph for this function:

◆ createFromTopic()

Client createFromTopic ( std::string const & componentName,
armarx::viz::Topic::ProxyType const & topic )
static

Definition at line 40 of file Client.cpp.

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

◆ layer()

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

Reimplemented in ScopedClient.

Definition at line 80 of file Client.cpp.

+ Here is the caller graph for this function:

◆ stage()

StagedCommit stage ( )
inline

Definition at line 146 of file Client.h.

+ Here is the caller graph for this function:

◆ updateComponentName()

void updateComponentName ( std::string const & name)
inline

Definition at line 193 of file Client.h.

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