NVUtil.py File Reference

NameValue and NVList utility functions. More...

Classes
class	OpenRTM_aist.NVUtil.to_prop
class	OpenRTM_aist.NVUtil.nv_find

Functions
	OpenRTM_aist.NVUtil.newNV (name, value)
	OpenRTM_aist.NVUtil.copyFromProperties (nv, prop)
	OpenRTM_aist.NVUtil.copyToProperties (prop, nvlist)
	OpenRTM_aist.NVUtil.toProperties (nv)
	coil::Properties toProperties(const SDOPackage::NVList& nv);
	OpenRTM_aist.NVUtil.find (nv, name)
	OpenRTM_aist.NVUtil.find_index (nv, name)
	OpenRTM_aist.NVUtil.isString (nv, name)
	OpenRTM_aist.NVUtil.isStringValue (nv, name, value)
	OpenRTM_aist.NVUtil.toString (nv, name=None)
	OpenRTM_aist.NVUtil.appendStringValue (nv, name, value)
	OpenRTM_aist.NVUtil.append (dest, src)
	OpenRTM_aist.NVUtil.dump_to_stream (out, nv)
	OpenRTM_aist.NVUtil.dump (nv)

Detailed Description

NameValue and NVList utility functions.

Date

Date

2007/09/11

Author

Noriaki Ando n-and.nosp@m.o@ai.nosp@m.st.go.nosp@m..jp and Shinji Kurihara

Copyright (C) 2006-2008 Noriaki Ando Task-intelligence Research Group, Intelligent Systems Research Institute, National Institute of Advanced Industrial Science and Technology (AIST), Japan All rights reserved.

Function Documentation

copyFromProperties()

copyFromProperties	(		nv,
			prop )

Copy to NVList from Proeprties

This operation copies Properties to NVList. Created NVList's values are CORBA::string.

Parameters

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

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

copyToProperties()

copyToProperties	(		prop,
			nvlist )

Copy to Proeprties from NVList

This operation copies NVList to Properties.

Parameters

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

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

dump_to_stream()

dump_to_stream	(		out,
			nv )

Print information configured in NVList as a string type std::ostream& dump_to_stream(std::ostream& out, const SDOPackage::NVList& nv)

find()

find	(		nv,
			name )

Get value in NVList specified by name

This operation returns Any type of value specified by name. Created NVList's values are CORBA::string.

Parameters

nv	NVList to be searched
prop	name to seartch in NVList

newNV()

newNV	(		name,
			value )

Create NameVale

This operation creates NameVale.

Parameters

name	name of NameValue
value	value of NameValue

Returns

NameValue

toString()

toString	(		nv,
			name = None )

Get string value in NVList specified by name

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	NVList to be searched
name	name to to serach

Returns

string value named by name