FancySafeBot 0.0.1
A safe robotics library
Loading...
Searching...
No Matches
fsb::urdf::NameMap Class Reference

Detailed Description

Name map relating names to object indices.

#include <fsb_urdf_name_map.h>

Collaboration diagram for fsb::urdf::NameMap:
Collaboration graph

Public Member Functions

NameMapError add (size_t index, const std::string &name)
 Add named object with index.
 
size_t get_index (const std::string &name, NameMapError &err) const
 Get index of named object.
 
std::string get_name (size_t index, NameMapError &err) const
 Get name of indexed object.
 
bool name_exists (const std::string &name) const
 Check if name exists in map.
 
size_t size () const
 Get number of name-index pairs in map.
 

Member Function Documentation

◆ add()

NameMapError fsb::urdf::NameMap::add ( size_t  index,
const std::string &  name 
)
inline

Add named object with index.

Parameters
indexIndex of named object
nameName of object
Returns
Result of operation

◆ get_index()

size_t fsb::urdf::NameMap::get_index ( const std::string &  name,
NameMapError err 
) const
inline

Get index of named object.

Parameters
nameName of object
errError status of operation
Returns
Index of named object

◆ get_name()

std::string fsb::urdf::NameMap::get_name ( size_t  index,
NameMapError err 
) const
inline

Get name of indexed object.

Parameters
indexIndex
errError status of operation
Returns
Name of object at index

◆ name_exists()

bool fsb::urdf::NameMap::name_exists ( const std::string &  name) const
inline

Check if name exists in map.

Parameters
nameName of object in map
Returns
true if name exists in map, false otherwise

◆ size()

size_t fsb::urdf::NameMap::size ( ) const
inline

Get number of name-index pairs in map.

Returns
Number of objects in map

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