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) const override
 
std::optional< ArticulatedObjectget (const std::string &name, const armem::Time &timestamp, const std::optional< std::string > &providerName) const override
 
std::string getProviderName () const
 
std::optional< robot_state::description::RobotDescriptionqueryDescription (const std::string &name, const armem::Time &timestamp, const std::optional< std::string > &providerName) const
 
std::vector< robot_state::description::RobotDescriptionqueryDescriptions (const armem::Time &timestamp, const std::optional< std::string > &providerName) const
 
std::optional< robot_state::RobotStatequeryState (const std::string &instanceName, const armem::Time &timestamp, const std::optional< std::string > &providerName) const
 
 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) const override
 
 ~Reader () override=default
 
- Public Member Functions inherited from ReaderInterface
virtual ~ReaderInterface ()=default
 

Protected Member Functions

std::optional< robot_state::RobotStategetArticulatedObjectState (const armarx::armem::wm::Memory &memory) const
 
std::optional< robot_state::description::RobotDescriptiongetRobotDescription (const armarx::armem::wm::Memory &memory) const
 
std::vector< robot_state::description::RobotDescriptiongetRobotDescriptions (const armarx::armem::wm::Memory &memory) const
 

Detailed Description

Definition at line 43 of file Reader.h.

Constructor & Destructor Documentation

◆ Reader()

Reader ( )
default

◆ ~Reader()

~Reader ( )
overridedefault

Member Function Documentation

◆ connect()

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

Definition at line 33 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 
) const
overridevirtual

Implements ReaderInterface.

Definition at line 123 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 
) const
overridevirtual

Implements ReaderInterface.

Definition at line 99 of file Reader.cpp.

+ Here is the call graph for this function:

◆ getArticulatedObjectState()

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

Definition at line 332 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_state::description::RobotDescription > getRobotDescription ( const armarx::armem::wm::Memory memory) const
protected

Definition at line 354 of file Reader.cpp.

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

◆ getRobotDescriptions()

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

Definition at line 375 of file Reader.cpp.

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

◆ queryDescription()

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

Definition at line 208 of file Reader.cpp.

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

◆ queryDescriptions()

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

Definition at line 164 of file Reader.cpp.

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

◆ queryState()

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

Definition at line 255 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 50 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 
) const
overridevirtual

Implements ReaderInterface.

Definition at line 141 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: