ros::names Namespace Reference

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

Functions
std::string	append (const std::string &left, const std::string &right)
	Append one name to another.
std::string	clean (const std::string &name)
	Cleans a graph resource name: removes double slashes, trailing slash.
const M_string &	getRemappings ()
const M_string &	getUnresolvedRemappings ()
void	init (const M_string &remappings)
bool	isValidCharInName (char c)
std::string	parentNamespace (const std::string &name)
	Get the parent namespace of a name.
std::string	remap (const std::string &name)
	Apply remappings to a name.
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.
std::string	resolve (const std::string &name, bool remap=true)
	Resolve a graph resource name into a fully qualified graph resource name.
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 117 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 98 of file names.cpp.

const M_string & ros::names::getRemappings

(

)

Definition at line 45 of file names.cpp.

const M_string & ros::names::getUnresolvedRemappings

(

)

Definition at line 50 of file names.cpp.

void ros::names::init

(

const M_string &

remappings

)

bool ros::names::isValidCharInName

(

char

c

)

Definition at line 55 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 203 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 122 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 140 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 135 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 65 of file names.cpp.

---

Variable Documentation

M_string ros::names::g_remappings

Definition at line 42 of file names.cpp.

M_string ros::names::g_unresolved_remappings

Definition at line 43 of file names.cpp.