VirtualRobotWriter Class Reference

The VirtualRobotReader class. More...

#include <RobotAPI/libraries/armem_robot_state/client/common/VirtualRobotWriter.h>

+ Inheritance diagram for VirtualRobotWriter:

Public Member Functions

void connect (armem::client::MemoryNameSystem &memoryNameSystem)
 
void registerPropertyDefinitions (::armarx::PropertyDefinitionsPtr &def)
 
bool storeDescription (const robot::RobotDescription &description, const armem::Time &timestamp=armem::Time::Invalid()) override
 
bool storeDescription (const VirtualRobot::Robot &robot, const armem::Time &timestamp=armem::Time::Invalid())
 
bool storeState (const robot::RobotState &state, const std::string &robotTypeName, const std::string &robotName, const std::string &robotRootNodeName) override
 
bool storeState (const VirtualRobot::Robot &robot, const armem::Time &timestamp)
 
 VirtualRobotWriter ()=default
 
 ~VirtualRobotWriter () override
 
- Public Member Functions inherited from RobotWriter
void connect (armem::client::MemoryNameSystem &memoryNameSystem)
 
void registerPropertyDefinitions (::armarx::PropertyDefinitionsPtr &def)
 
 RobotWriter ()=default
 
 RobotWriter (const RobotWriter &)
 
bool storeDescription (const robot::RobotDescription &description, const armem::Time &timestamp=armem::Time::Invalid()) override
 
bool storeLocalization (const Eigen::Matrix4f &globalRootPose, const std::string &robotName, const std::string &robotRootNodeName, const armem::Time &timestamp)
 
bool storeProprioception (const std::map< std::string, float > &jointMap, const std::string &robotTypeName, const std::string &robotName, const armem::Time &timestamp)
 
bool storeState (const robot::RobotState &state, const std::string &robotTypeName, const std::string &robotName, const std::string &robotRootNodeName) override
 
 ~RobotWriter () override
 
- Public Member Functions inherited from WriterInterface
virtual ~WriterInterface ()=default
 

Additional Inherited Members

- Public Attributes inherited from RobotWriter
armem::client::Writer memoryWriter
 
std::mutex memoryWriterMutex
 
struct armarx::armem::robot_state::RobotWriter::Properties properties
 
const std::string propertyPrefix = "mem.robot_state."
 

Detailed Description

The VirtualRobotReader class.

The aim of this class is to obtain a virtual robot instance and synchronize it with the data (joint positions, global pose, ...) stored in the working memory.

This is only a lightweight wrapper of

See also
RobotReader for Simox's VirtualRobot class.

Definition at line 42 of file VirtualRobotWriter.h.

Constructor & Destructor Documentation

◆ VirtualRobotWriter()

VirtualRobotWriter ( )
default

◆ ~VirtualRobotWriter()

~VirtualRobotWriter ( )
overridedefault

Member Function Documentation

◆ connect()

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

Definition at line 27 of file VirtualRobotWriter.cpp.

+ Here is the call graph for this function:

◆ registerPropertyDefinitions()

void registerPropertyDefinitions ( ::armarx::PropertyDefinitionsPtr def)

Definition at line 34 of file VirtualRobotWriter.cpp.

+ Here is the call graph for this function:

◆ storeDescription() [1/2]

bool storeDescription
override

Definition at line 68 of file RobotWriter.cpp.

◆ storeDescription() [2/2]

bool storeDescription ( const VirtualRobot::Robot &  robot,
const armem::Time timestamp = armem::Time::Invalid() 
)

Definition at line 48 of file VirtualRobotWriter.cpp.

+ Here is the call graph for this function:

◆ storeState() [1/2]

bool storeState
override

Definition at line 180 of file RobotWriter.cpp.

◆ storeState() [2/2]

bool storeState ( const VirtualRobot::Robot &  robot,
const armem::Time timestamp 
)

Definition at line 60 of file VirtualRobotWriter.cpp.

+ Here is the call graph for this function:

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