/home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/NVUtil.py ファイル

NameValue and NVList utility functions. [詳解]

クラス
class	OpenRTM_aist.NVUtil.to_prop
	NVList → Properties 変換用ファンクタ [詳解]
class	OpenRTM_aist.NVUtil.nv_find
	NVList 検索用ファンクタ [詳解]

関数
def	OpenRTM_aist.NVUtil.newNV (name, value)
	NameValue を生成する [詳解]
def	OpenRTM_aist.NVUtil.copyFromProperties (nv, prop)
	Properties を NVList へコピーする [詳解]
def	OpenRTM_aist.NVUtil.copyToProperties (prop, nvlist)
	NVList を Properties へコピーする [詳解]
def	OpenRTM_aist.NVUtil.toProperties (nv)
	NVList を Properties へ変換する [詳解]
def	OpenRTM_aist.NVUtil.find (nv, name)
	NVList から name で指定された value を返す [詳解]
def	OpenRTM_aist.NVUtil.find_index (nv, name)
	name で指定された要素のインデックスを返す [詳解]
def	OpenRTM_aist.NVUtil.isString (nv, name)
	指定された name の value の型が string であるか検証する [詳解]
def	OpenRTM_aist.NVUtil.isStringValue (nv, name, value)
	指定された name の value の型が指定した文字列と一致するか検証する [詳解]
def	OpenRTM_aist.NVUtil.toString (nv, name=None)
	指定された name の NVList を string として返す。 [詳解]
def	OpenRTM_aist.NVUtil.appendStringValue (nv, name, value)
	指定された文字列を NVList の要素に追加する。 [詳解]
def	OpenRTM_aist.NVUtil.append (dest, src)
	NVList に要素を追加する。 [詳解]
def	OpenRTM_aist.NVUtil.dump_to_stream (out, nv)
	NVList に設定されている内容を文字列として出力する。 std::ostream& dump_to_stream(std::ostream& out, const SDOPackage::NVList& nv)
def	OpenRTM_aist.NVUtil.dump (nv)
	NVList に設定されている内容を文字列として出力する。 [詳解]

詳解

NameValue and NVList utility functions.

日付

Date

2007/09/11

著者

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.

関数詳解

def OpenRTM_aist.NVUtil.append	(		dest,
			src
	)

NVList に要素を追加する。

このオペレーションは dest で指定された NVList に src で指定された要素を 追加する。

引数

dest	追加される NVList
src	追加する NVList

def OpenRTM_aist.NVUtil.appendStringValue	(		nv,
			name,
			value
	)

指定された文字列を NVList の要素に追加する。

このオペレーションは name で指定された要素に value で指定された文字列を 追加する。 name で指定した要素に既に value の値が設定されている場合には何もしない。 name で指定した要素に value の値が設定されていない場合は、 ｢,｣区切りで value の値を追加する。 指定された値を設定する。 name で指定した要素が存在しない場合は、 NVList の最後に新たな要素を追加し、 指定された値を設定する。

引数

nv	検索対象の NVList
name	追加対象要素名
value	追加する文字列

戻り値

追加操作結果

def OpenRTM_aist.NVUtil.copyFromProperties	(		nv,
			prop
	)

Properties を NVList へコピーする

このオペレーションは Properties を NVList へコピーする。 NVList の value は全て CORBA::string 型としてコピーする。

引数

nv	Properties の値を格納する NVList
prop	コピー元の Properties

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

def OpenRTM_aist.NVUtil.copyToProperties	(		prop,
			nvlist
	)

NVList を Properties へコピーする

このオペレーションは NVList を Properties へコピーする。

引数

prop	NVList の値を格納する Properties
nv	コピー元の NVList

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

def OpenRTM_aist.NVUtil.dump

(

nv

)

NVList に設定されている内容を文字列として出力する。

指定された NVList に設定された内容を文字列として出力する。 なお、設定されている要素が文字列型以外の場合には、その旨(文字列ではない)を 出力する。

引数

nv	出力対象 NVList

def OpenRTM_aist.NVUtil.find	(		nv,
			name
	)

NVList から name で指定された value を返す

このオペレーションは name で指定された value を Any 型で返す。 指定した名称の要素が存在しない場合は例外を発生させる。

引数

nv	検索対象の NVList
name	検索する名前

戻り値

検索結果

def OpenRTM_aist.NVUtil.find_index	(		nv,
			name
	)

name で指定された要素のインデックスを返す

このオペレーションは name で指定された要素が格納されている位置の インデックスを返す。

引数

nv	検索対象の NVList
name	検索する名前

戻り値

検索対象のインデックス

def OpenRTM_aist.NVUtil.isString	(		nv,
			name
	)

指定された name の value の型が string であるか検証する

このオペレーションは name で指定された value の型が CORBA::string かどうかを bool 値で返す。

引数

nv	検索対象の NVList
name	検索する名前

戻り値

string検証結果(string:true、それ以外:false)

def OpenRTM_aist.NVUtil.isStringValue	(		nv,
			name,
			value
	)

指定された name の value の型が指定した文字列と一致するか検証する

このオペレーションは name で指定された value の型が CORBA::string かどうかを判断し、 CORBA::string である場合には指定した文字列と一致するか をbool 値で返す。

引数

nv	検索対象の NVList
name	検索する名前
value	比較対象文字列

戻り値

検証結果(文字列と一致:true、非一致:false)

def OpenRTM_aist.NVUtil.newNV	(		name,
			value
	)

NameValue を生成する

このオペレーションはNameValueを作成する。

引数

name	NameValue の name
value	NameValue の value

戻り値

NameValue

def OpenRTM_aist.NVUtil.toProperties

(

nv

)

NVList を Properties へ変換する

このオペレーションは NVList を Properties へ変換する。

引数

nv	変換元の NVList

戻り値

変換結果Property

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

def OpenRTM_aist.NVUtil.toString	(		nv,
			name = None
	)

指定された name の NVList を string として返す。

このオペレーションは name で指定された NVList の値を string で返す。 もし、name で指定した value の値が CORBA::string でなければ、 空の文字列のstringを返す。

引数

nv	検索対象の NVList
name	検索する名前

戻り値

name に対応する値のstring型の値