OpenRTM-aist-Python 2.0.2
|
NameValue and NVList utility functions [詳解]
クラス | |
class | OpenRTM_aist.NVUtil.to_prop |
class | OpenRTM_aist.NVUtil.nv_find |
関数 | |
OpenRTM_aist.NVUtil.newNV (name, value) | |
OpenRTM_aist.NVUtil.copyFromProperties (nv, prop) | |
OpenRTM_aist.NVUtil.copyToProperties (prop, nvlist) | |
OpenRTM_aist.NVUtil.toProperties (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) | |
NameValue and NVList utility functions
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.
OpenRTM_aist.NVUtil.append | ( | dest, | |
src ) |
NVList に要素を追加する。
このオペレーションは dest で指定された NVList に src で指定された要素を 追加する。
dest | 追加される NVList |
src | 追加する NVList |
OpenRTM_aist.NVUtil.appendStringValue | ( | nv, | |
name, | |||
value ) |
指定された文字列を NVList の要素に追加する。
このオペレーションは name で指定された要素に value で指定された文字列を 追加する。 name で指定した要素に既に value の値が設定されている場合には何もしない。 name で指定した要素に value の値が設定されていない場合は、 「,」区切りで value の値を追加する。 指定された値を設定する。 name で指定した要素が存在しない場合は、 NVList の最後に新たな要素を追加し、 指定された値を設定する。
nv | 検索対象の NVList |
name | 追加対象要素名 |
value | 追加する文字列 |
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);
OpenRTM_aist.NVUtil.copyToProperties | ( | prop, | |
nvlist ) |
NVList を Properties へコピーする
このオペレーションは NVList を Properties へコピーする。
prop | NVList の値を格納する Properties |
nv | コピー元の NVList |
void copyToProperties(coil.Properties& prop, const SDOPackage.NVList& nv);
OpenRTM_aist.NVUtil.dump | ( | nv | ) |
NVList に設定されている内容を文字列として出力する。
指定された NVList に設定された内容を文字列として出力する。 なお、設定されている要素が文字列型以外の場合には、その旨(文字列ではない)を 出力する。
nv | 出力対象 NVList |
OpenRTM_aist.NVUtil.dump_to_stream | ( | out, | |
nv ) |
NVList に設定されている内容を文字列として出力する。 std.ostream& dump_to_stream(std.ostream& out, const SDOPackage.NVList& nv)
OpenRTM_aist.NVUtil.find | ( | nv, | |
name ) |
NVList から name で指定された value を返す
このオペレーションは name で指定された value を Any 型で返す。 指定した名称の要素が存在しない場合は例外を発生させる。
nv | 検索対象の NVList |
name | 検索する名前 |
OpenRTM_aist.NVUtil.find_index | ( | nv, | |
name ) |
name で指定された要素のインデックスを返す
このオペレーションは name で指定された要素が格納されている位置の インデックスを返す。
nv | 検索対象の NVList |
name | 検索する名前 |
OpenRTM_aist.NVUtil.isString | ( | nv, | |
name ) |
指定された name の value の型が string であるか検証する
このオペレーションは name で指定された value の型が CORBA.string かどうかを bool 値で返す。
nv | 検索対象の NVList |
name | 検索する名前 |
OpenRTM_aist.NVUtil.isStringValue | ( | nv, | |
name, | |||
value ) |
指定された name の value の型が指定した文字列と一致するか検証する
このオペレーションは name で指定された value の型が CORBA.string かどうかを判断し、 CORBA.string である場合には指定した文字列と一致するか をbool 値で返す。
nv | 検索対象の NVList |
name | 検索する名前 |
value | 比較対象文字列 |
OpenRTM_aist.NVUtil.newNV | ( | name, | |
value ) |
NameValue を生成する
このオペレーションはNameValueを作成する。
name | NameValue の name |
value | NameValue の value |
OpenRTM_aist.NVUtil.toProperties | ( | nv | ) |
NVList を Properties へ変換する
このオペレーションは NVList を Properties へ変換する。
nv | 変換元の NVList |
coil.Properties toProperties(const SDOPackage.NVList& nv);
OpenRTM_aist.NVUtil.toString | ( | nv, | |
name = None ) |
指定された name の NVList を string として返す。
このオペレーションは name で指定された NVList の値を string で返す。 もし、name で指定した value の値が CORBA.string でなければ、 空の文字列のstringを返す。
nv | 検索対象の NVList |
name | 検索する名前 |