roswrap::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. More...
ROSCPP_DECL std::string	clean (const std::string &name)
	Cleans a graph resource name: removes double slashes, trailing slash. More...
const ROSCPP_DECL M_string &	getRemappings ()
const ROSCPP_DECL M_string &	getUnresolvedRemappings ()
ROSCPP_DECL std::string	parentNamespace (const std::string &name)
	Get the parent namespace of a name. More...
ROSCPP_DECL std::string	remap (const std::string &name)
	Apply remappings to a name. More...
ROSCPP_DECL std::string	resolve (const std::string &name, bool remap=true)
	Resolve a graph resource name into a fully qualified graph resource name. More...
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. More...
ROSCPP_DECL bool	validate (const std::string &name, std::string &error)
	Validate a name against the name spec. More...

Detailed Description

Contains functions which allow you to manipulate ROS names.

Function Documentation

append()

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

Append one name to another.

clean()

ROSCPP_DECL std::string roswrap::names::clean

(

const std::string &

name

)

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

getRemappings()

const ROSCPP_DECL M_string& roswrap::names::getRemappings

(

)

getUnresolvedRemappings()

const ROSCPP_DECL M_string& roswrap::names::getUnresolvedRemappings

(

)

parentNamespace()

ROSCPP_DECL std::string roswrap::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

remap()

ROSCPP_DECL std::string roswrap::names::remap

(

const std::string &

name

)

Apply remappings to a name.

Exceptions

InvalidNameException

if the name passed is not a valid graph resource name

resolve() [1/2]

ROSCPP_DECL std::string roswrap::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

resolve() [2/2]

ROSCPP_DECL std::string roswrap::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

validate()

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

Validate a name against the name spec.