List of all members | Public Member Functions | Protected Member Functions
Reader Class Reference

#include <RobotAPI/libraries/armem_objects/client/articulated_object/Reader.h>

+ Inheritance diagram for Reader:

Public Member Functions

void connect (armem::client::MemoryNameSystem &memoryNameSystem)
 
ArticulatedObject get (const ArticulatedObjectDescription &description, const armem::Time &timestamp, const std::string &instanceName, const std::optional< std::string > &providerName) override
 
std::optional< ArticulatedObject > get (const std::string &name, const armem::Time &timestamp, const std::optional< std::string > &providerName) override
 
std::string getProviderName () const
 
std::optional< robot::RobotDescription > queryDescription (const std::string &name, const armem::Time &timestamp, const std::optional< std::string > &providerName)
 
std::vector< robot::RobotDescription > queryDescriptions (const armem::Time &timestamp, const std::optional< std::string > &providerName)
 
std::optional< robot::RobotState > queryState (const std::string &instanceName, const armem::Time &timestamp, const std::optional< std::string > &providerName)
 
 Reader ()=default
 
void registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &def)
 
void setProviderName (const std::string &providerName)
 
bool synchronize (ArticulatedObject &obj, const armem::Time &timestamp, const std::optional< std::string > &providerName) override
 
virtual ~Reader ()=default
 
- Public Member Functions inherited from ReaderInterface
virtual ~ReaderInterface ()=default
 

Protected Member Functions

std::optional< robot::RobotState > getArticulatedObjectState (const armarx::armem::wm::Memory &memory) const
 
std::optional< robot::RobotDescription > getRobotDescription (const armarx::armem::wm::Memory &memory) const
 
std::vector< robot::RobotDescription > getRobotDescriptions (const armarx::armem::wm::Memory &memory) const
 

Detailed Description

Definition at line 39 of file Reader.h.

Constructor & Destructor Documentation

◆ Reader()

Reader ( )
default

◆ ~Reader()

virtual ~Reader ( )
virtualdefault

Member Function Documentation

◆ connect()

void connect ( armem::client::MemoryNameSystem &  memoryNameSystem)

Definition at line 35 of file Reader.cpp.

+ Here is the call graph for this function:

◆ get() [1/2]

ArticulatedObject get ( const ArticulatedObjectDescription &  description,
const armem::Time &  timestamp,
const std::string &  instanceName,
const std::optional< std::string > &  providerName 
)
overridevirtual

Implements ReaderInterface.

Definition at line 125 of file Reader.cpp.

+ Here is the call graph for this function:

◆ get() [2/2]

std::optional< ArticulatedObject > get ( const std::string &  name,
const armem::Time &  timestamp,
const std::optional< std::string > &  providerName 
)
overridevirtual

Implements ReaderInterface.

Definition at line 101 of file Reader.cpp.

+ Here is the call graph for this function:

◆ getArticulatedObjectState()

std::optional< robot::RobotState > getArticulatedObjectState ( const armarx::armem::wm::Memory &  memory) const
protected

Definition at line 333 of file Reader.cpp.

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

◆ getProviderName()

std::string getProviderName ( ) const

◆ getRobotDescription()

std::optional< robot::RobotDescription > getRobotDescription ( const armarx::armem::wm::Memory &  memory) const
protected

Definition at line 355 of file Reader.cpp.

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

◆ getRobotDescriptions()

std::vector< robot::RobotDescription > getRobotDescriptions ( const armarx::armem::wm::Memory &  memory) const
protected

Definition at line 376 of file Reader.cpp.

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

◆ queryDescription()

std::optional< robot::RobotDescription > queryDescription ( const std::string &  name,
const armem::Time &  timestamp,
const std::optional< std::string > &  providerName 
)

Definition at line 210 of file Reader.cpp.

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

◆ queryDescriptions()

std::vector< robot::RobotDescription > queryDescriptions ( const armem::Time &  timestamp,
const std::optional< std::string > &  providerName 
)

Definition at line 166 of file Reader.cpp.

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

◆ queryState()

std::optional< robot::RobotState > queryState ( const std::string &  instanceName,
const armem::Time &  timestamp,
const std::optional< std::string > &  providerName 
)

Definition at line 257 of file Reader.cpp.

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

◆ registerPropertyDefinitions()

void registerPropertyDefinitions ( armarx::PropertyDefinitionsPtr &  def)
inline

Definition at line 46 of file Reader.h.

◆ setProviderName()

void setProviderName ( const std::string &  providerName)

◆ synchronize()

bool synchronize ( ArticulatedObject &  obj,
const armem::Time &  timestamp,
const std::optional< std::string > &  providerName 
)
overridevirtual

Implements ReaderInterface.

Definition at line 143 of file Reader.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: