Utility functions for nxpath

Collaboration diagram for Utility functions for nxpath:

Functions
bool	pni::io::nx::match (const pni::core::string &a, const pni::core::string &b)
	check if two paths are matching More...
bool	pni::io::nx::match (const nxpath &a, const nxpath &b)
	check if paths are matching More...
bool	pni::io::nx::match (const nxpath::element_type &a, const nxpath::element_type &b)
	check if path elements match More...
nxpath::element_type	pni::io::nx::object_element (const pni::core::string &name, const pni::core::string &type)
	create object element More...

Detailed Description

Function Documentation

bool pni::io::nx::match	(	const pni::core::string &	a,
		const pni::core::string &	b
	)

See the users guide for details about when paths are considered as matching.

Parameters

a	path as string
b	path as string

Returns

true if the paths are matching, false otherwise

bool pni::io::nx::match	(	const nxpath &	a,
		const nxpath &	b
	)

See the users guide for details about when paths are considered as matching.

Parameters

a	reference to first path
b	reference to second path

Returns

true if paths are matching, false otherwise

bool pni::io::nx::match	(	const nxpath::element_type &	a,
		const nxpath::element_type &	b
	)

See the users guide for details about when paths elements are considered as matching.

Parameters

a	reference to first path element
b	reference to second path element

Returns

true if the elements are matching, false otherwise

nxpath::element_type pni::io::nx::object_element	(	const pni::core::string &	name,
		const pni::core::string &	type
	)

This utilty function creates an element for the object section of a Nexus path.

Exceptions

value_error

if both arguments are empty strings

Parameters

name	the name of the object
type	the type of the object

Returns

instance of object element