RobotWriter Class Reference

The RobotReader class. More...

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

+ Inheritance diagram for RobotWriter:

Classes

struct  Properties
 

Public Member Functions

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
 

Public Attributes

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 RobotReader class.

The purpose of this class is to synchronize the armem data structure armem::Robot with the memory.

Definition at line 43 of file RobotWriter.h.

Constructor & Destructor Documentation

◆ RobotWriter() [1/2]

RobotWriter ( )
default

◆ RobotWriter() [2/2]

RobotWriter ( const RobotWriter r)

Definition at line 37 of file RobotWriter.cpp.

◆ ~RobotWriter()

~RobotWriter ( )
overridedefault

Member Function Documentation

◆ connect()

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

Definition at line 50 of file RobotWriter.cpp.

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

◆ registerPropertyDefinitions()

void registerPropertyDefinitions ( ::armarx::PropertyDefinitionsPtr def)

Definition at line 45 of file RobotWriter.cpp.

+ Here is the caller graph for this function:

◆ storeDescription()

bool storeDescription ( const robot::RobotDescription description,
const armem::Time timestamp = armem::Time::Invalid() 
)
overridevirtual

Implements WriterInterface.

Definition at line 68 of file RobotWriter.cpp.

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

◆ storeLocalization()

bool storeLocalization ( const Eigen::Matrix4f &  globalRootPose,
const std::string &  robotName,
const std::string &  robotRootNodeName,
const armem::Time timestamp 
)

Definition at line 102 of file RobotWriter.cpp.

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

◆ storeProprioception()

bool storeProprioception ( const std::map< std::string, float > &  jointMap,
const std::string &  robotTypeName,
const std::string &  robotName,
const armem::Time timestamp 
)

Definition at line 146 of file RobotWriter.cpp.

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

◆ storeState()

bool storeState ( const robot::RobotState state,
const std::string &  robotTypeName,
const std::string &  robotName,
const std::string &  robotRootNodeName 
)
overridevirtual

Implements WriterInterface.

Definition at line 180 of file RobotWriter.cpp.

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

Member Data Documentation

◆ memoryWriter

armem::client::Writer memoryWriter

Definition at line 83 of file RobotWriter.h.

◆ memoryWriterMutex

std::mutex memoryWriterMutex
mutable

Definition at line 82 of file RobotWriter.h.

◆ properties

◆ propertyPrefix

const std::string propertyPrefix = "mem.robot_state."

Definition at line 80 of file RobotWriter.h.


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