$search

ros::names Namespace Reference

Contains functions which allow you to manipulate ROS names. More...

Functions

ROSCPP_DECL std::string append (const std::string &left, const std::string &right)
 Append one name to another.
ROSCPP_DECL std::string clean (const std::string &name)
 Cleans a graph resource name: removes double slashes, trailing slash.
ROSCPP_DECL const M_stringgetRemappings ()
ROSCPP_DECL const M_stringgetUnresolvedRemappings ()
void init (const M_string &remappings)
bool isValidCharInName (char c)
ROSCPP_DECL std::string parentNamespace (const std::string &name)
 Get the parent namespace of a name.
ROSCPP_DECL std::string remap (const std::string &name)
 Apply remappings to a name.
ROSCPP_DECL std::string resolve (const std::string &ns, const std::string &name, bool remap=true)
 Resolve a graph resource name into a fully qualified graph resource name.
ROSCPP_DECL std::string resolve (const std::string &name, bool remap=true)
 Resolve a graph resource name into a fully qualified graph resource name.
ROSCPP_DECL bool validate (const std::string &name, std::string &error)
 Validate a name against the name spec.

Variables

M_string g_remappings
M_string g_unresolved_remappings

Detailed Description

Contains functions which allow you to manipulate ROS names.


Function Documentation

std::string ros::names::append ( const std::string &  left,
const std::string &  right 
)

Append one name to another.

Definition at line 118 of file names.cpp.

std::string ros::names::clean ( const std::string &  name  ) 

Cleans a graph resource name: removes double slashes, trailing slash.

Definition at line 99 of file names.cpp.

const M_string & ros::names::getRemappings (  ) 

Definition at line 46 of file names.cpp.

const M_string & ros::names::getUnresolvedRemappings (  ) 

Definition at line 51 of file names.cpp.

void ros::names::init ( const M_string remappings  ) 
bool ros::names::isValidCharInName ( char  c  ) 

Definition at line 56 of file names.cpp.

std::string ros::names::parentNamespace ( const std::string &  name  ) 

Get the parent namespace of a name.

Parameters:
name The namespace of which to get the parent namespace.
Exceptions:
InvalidNameException if the name passed is not a valid graph resource name

Definition at line 206 of file names.cpp.

std::string ros::names::remap ( const std::string &  name  ) 

Apply remappings to a name.

Exceptions:
InvalidNameException if the name passed is not a valid graph resource name

Definition at line 123 of file names.cpp.

std::string ros::names::resolve ( const std::string &  ns,
const std::string &  name,
bool  remap = true 
)

Resolve a graph resource name into a fully qualified graph resource name.

See http://www.ros.org/wiki/Names for more details

Parameters:
ns Namespace to use in resolution
name Name to resolve
remap Whether or not to apply remappings to the name
Exceptions:
InvalidNameException if the name passed is not a valid graph resource name

Definition at line 142 of file names.cpp.

std::string ros::names::resolve ( const std::string &  name,
bool  remap = true 
)

Resolve a graph resource name into a fully qualified graph resource name.

See http://www.ros.org/wiki/Names for more details

Parameters:
name Name to resolve
remap Whether or not to apply remappings to the name
Exceptions:
InvalidNameException if the name passed is not a valid graph resource name

Definition at line 136 of file names.cpp.

bool ros::names::validate ( const std::string &  name,
std::string &  error 
)

Validate a name against the name spec.

Definition at line 66 of file names.cpp.


Variable Documentation

Definition at line 43 of file names.cpp.

Definition at line 44 of file names.cpp.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


roscpp
Author(s): Morgan Quigley mquigley@cs.stanford.edu, Josh Faust jfaust@willowgarage.com, Brian Gerkey gerkey@willowgarage.com, Troy Straszheim straszheim@willowgarage.com
autogenerated on Sat Mar 2 13:23:33 2013