NVUtil Namespace Reference

Utility for NameValue. More...

Functions
template<class Value >
SDOPackage::NameValue	newNV (const char *name, Value value)
	Create NameValue.
SDOPackage::NameValue	newNVChar (const char *name, const CORBA::Char value)
	Create NameValue typed CORBA::Char.
SDOPackage::NameValue	newNVBool (const char *name, const CORBA::Boolean value)
	Create NameValue typed CORBA::Boolean.
SDOPackage::NameValue	newNVOctet (const char *name, const CORBA::Octet value)
	Create NameValue typed CORBA::Octet.
SDOPackage::NameValue	newNVAny (const char *name, const CORBA::Any &value)
	Create NameValue typed CORBA::Any.
void	copyFromProperties (SDOPackage::NVList &nv, const coil::Properties &prop)
	Copy the properties to NVList.
void	copyToProperties (coil::Properties &prop, const SDOPackage::NVList &nv)
	Copy NVList to the Proeprties.
coil::Properties	toProperties (const SDOPackage::NVList &nv)
	Transform NVList to the properties.
const CORBA::Any &	find (const SDOPackage::NVList &nv, const char *name)
	Return the value specified by name from NVList.
const CORBA::Long	find_index (const SDOPackage::NVList &nv, const char *name)
	Return the index of element specified by name from NVList.
bool	isString (const SDOPackage::NVList &nv, const char *name)
	Validate whether value type specified by name is string type.
bool	isStringValue (const SDOPackage::NVList &nv, const char name, const char value)
	Check whether the value of specified name matches the specified string.
std::string	toString (const SDOPackage::NVList &nv, const char *name)
	Get NVList of specifid name as string.
bool	appendStringValue (SDOPackage::NVList &nv, const char name, const char value)
	Append the specified string to element of NVList.
void	append (SDOPackage::NVList &dest, const SDOPackage::NVList &src)
	Append an element to NVList.
std::ostream &	dump (std::ostream &out, const SDOPackage::NVList &nv)
	Print information configured in NVList as string type.
void	dump (const SDOPackage::NVList &nv)
	Print information configured in NVList as a string type to Standard Outport.
std::string	toString (const SDOPackage::NVList &nv)
	Get information configured in NVList as a string type.

Detailed Description

Utility for NameValue.

This class provides the utility function of NameValue.

Function Documentation

void NVUtil::append	(	SDOPackage::NVList &	dest,
		const SDOPackage::NVList &	src
	)

Append an element to NVList.

This operation appends elements specified by src to NVList specified by dest.

Parameters:

	dest	NVList to be appended
	src	NVList to append

bool NVUtil::appendStringValue	(	SDOPackage::NVList &	nv,
		const char *	name,
		const char *	value
	)

Append the specified string to element of NVList.

This operation appends the string value specified by value to the element specified by name. Operate nothing when the 'value' value has already been set to the element specified by name. Add the 'value' value each separating by a comma "," when the 'value' value is not set to the element specified by name. Set the specified value. Add a new element at the end of NVList, and set the specified value, when the element specified by name does not exist.

Parameters:

	nv	The target NVList for the search
	name	The target element name for the appending
	value	String to append

Returns:: Append operation result

Referenced by RTC::PortBase::appendProperty().

void NVUtil::copyFromProperties	(	SDOPackage::NVList &	nv,
		const coil::Properties &	prop
	)

Copy the properties to NVList.

This operation copies the properties to NVList. All NVList's values are copied as CORBA::string.

Parameters:

	nv	NVList to store properties values
	prop	Properties that is copies from

void NVUtil::copyToProperties	(	coil::Properties &	prop,
		const SDOPackage::NVList &	nv
	)

Copy NVList to the Proeprties.

This operation copies NVList to properties.

Parameters:

	prop	Properties to store NVList values
	nv	NVList of copy source

void NVUtil::dump ( const SDOPackage::NVList & nv )

Print information configured in NVList as a string type to Standard Outport.

Parameters:

nv

The target NVList for the print

std::ostream& NVUtil::dump	(	std::ostream &	out,
		const SDOPackage::NVList &	nv
	)

Print information configured in NVList as string type.

Print configured information as string type in specified NVList. Also, print the reason (this is not string type) if the configured element is other than string type.

Parameters:

nv

The target NVList for the print

const CORBA::Any& NVUtil::find	(	const SDOPackage::NVList &	nv,
		const char *	name
	)

Return the value specified by name from NVList.

This operation returns Any type of value specified by name. When an element of specified name doesn't exist, the exception will occur.

Parameters:

	nv	The target NVList for the find
	name	Name for the find

Returns:: Find result

const CORBA::Long NVUtil::find_index	(	const SDOPackage::NVList &	nv,
		const char *	name
	)

Return the index of element specified by name from NVList.

This operation returns the index at the position where the element specified by name is stored.

Parameters:

	nv	The target NVList for the find
	name	Name for the find

Returns:: Index of target object for the find

bool NVUtil::isString	(	const SDOPackage::NVList &	nv,
		const char *	name
	)

Validate whether value type specified by name is string type.

This operation returns the bool value by checking whether the type of value specified with name is CORBA::string.

Parameters:

	nv	The target NVList for the search
	name	Name for the search

Returns:: String validation result (String:true, Else:false)

bool NVUtil::isStringValue	(	const SDOPackage::NVList &	nv,
		const char *	name,
		const char *	value
	)

Check whether the value of specified name matches the specified string.

This operation checks whether the value specified with name is CORBA::string and returns the bool value which matches spcified string.

Parameters:

	nv	The target NVList for the search
	name	Name for the search
	value	String value to compare

Returns:: Check result (Match:true, Unmatch:false)

template<class Value >

SDOPackage::NameValue NVUtil::newNV	(	const char *	name,
		Value	value
	)			`[inline]`

Create NameValue.

This operation creates NameValue. CORBA::Char, CORBA::Boolean, CORBA::Octet creation is not supported. These type of NameValue should be created by using newNVChar(), newNVBool(), newNVOctet() functions.

Parameters:

	name	Name of NameValue
	value	The value of NameValue

Returns:: NameValue

Referenced by RTC::PortBase::addProperty().

SDOPackage::NameValue NVUtil::newNVAny	(	const char *	name,
		const CORBA::Any &	value
	)

Create NameValue typed CORBA::Any.

This operation creates NameValue typed CORBA::Any.

Parameters:

	name	Name of NameValue
	value	The value of NameValue

Returns:: NameValue

SDOPackage::NameValue NVUtil::newNVBool	(	const char *	name,
		const CORBA::Boolean	value
	)

Create NameValue typed CORBA::Boolean.

This operation creates NameValue typed CORBA::Boolean.

Parameters:

	name	Name of NameValue
	value	The value of NameValue

Returns:: NameValue

SDOPackage::NameValue NVUtil::newNVChar	(	const char *	name,
		const CORBA::Char	value
	)

Create NameValue typed CORBA::Char.

This operation creates NameValue typed CORBA::Char.

Parameters:

	name	Name of NameValue
	value	The value of NameValue

Returns:: NameValue

SDOPackage::NameValue NVUtil::newNVOctet	(	const char *	name,
		const CORBA::Octet	value
	)

Create NameValue typed CORBA::Octet.

This operation creates NameValue typed CORBA::Octet.

Parameters:

	name	Name of NameValue
	value	The value of NameValue

Returns:: NameValue

coil::Properties NVUtil::toProperties ( const SDOPackage::NVList & nv )

Transform NVList to the properties.

This operation transforms NVList to properties

Parameters:

nv

NVList of tranformation source

Returns:: Transformation result Property

std::string NVUtil::toString ( const SDOPackage::NVList & nv )

Get information configured in NVList as a string type.

Parameters:

nv

The target NVList for the print

std::string NVUtil::toString	(	const SDOPackage::NVList &	nv,
		const char *	name
	)

Get NVList of specifid name as string.

This operation returns string value in NVList specified by name. If the value in NVList specified by name is not CORBA::string type this operation returns empty string value.

Parameters:

	nv	The target NVList for the search
	name	Name for the search

Returns:: String value corresponding to name

NVUtil Namespace Reference

Functions

Detailed Description

Function Documentation