ClassReader Class Reference

#include <RobotAPI/libraries/armem_objects/client/class/ClassReader.h>

+ Inheritance diagram for ClassReader:

Public Member Functions

 ClassReader ()=default
 
std::optional< armem::clazz::ObjectClassgetObjectClass (const std::string &providerName, const armarx::ObjectID &id)
 
std::map< armarx::ObjectID, armem::clazz::ObjectClassgetObjectClasses (const std::vector< armarx::ObjectID > &objectIDs)
 Get object class information for object class IDs. More...
 
- Public Member Functions inherited from SimpleReaderBase
virtual void connect (armarx::armem::client::MemoryNameSystem &mns)
 
const Propertiesproperties () const
 
void registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &def)
 
void setProperties (const Properties &p)
 
 SimpleReaderBase ()
 
virtual ~SimpleReaderBase ()=default
 

Protected Member Functions

Properties defaultProperties () const final
 
std::string propertyPrefix () const final
 
- Protected Member Functions inherited from SimpleReaderBase
const armem::client::ReadermemoryReader () const
 

Detailed Description

Definition at line 32 of file ClassReader.h.

Constructor & Destructor Documentation

◆ ClassReader()

ClassReader ( )
default

Member Function Documentation

◆ defaultProperties()

client::util::SimpleReaderBase::Properties defaultProperties ( ) const
finalprotectedvirtual

Implements SimpleReaderBase.

Definition at line 77 of file ClassReader.cpp.

◆ getObjectClass()

std::optional< armem::clazz::ObjectClass > getObjectClass ( const std::string &  providerName,
const armarx::ObjectID id 
)

Definition at line 10 of file ClassReader.cpp.

+ Here is the call graph for this function:

◆ getObjectClasses()

std::map< ObjectID, armem::clazz::ObjectClass > getObjectClasses ( const std::vector< armarx::ObjectID > &  objectIDs)

Get object class information for object class IDs.

Parameters
objectIDsThe object class IDs.
Returns
The corresponding object classes.
Exceptions
armarx::armem::error::QueryFailedIf the memory query failed.

Definition at line 35 of file ClassReader.cpp.

+ Here is the call graph for this function:

◆ propertyPrefix()

std::string propertyPrefix ( ) const
finalprotectedvirtual

Implements SimpleReaderBase.

Definition at line 71 of file ClassReader.cpp.


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