ネームスペース NVUtil

NameValue 用ユーティリティ. [詳細]

関数
template<class Value >
SDOPackage::NameValue	newNV (const char *name, Value value)
	NameValue を生成する.
SDOPackage::NameValue	newNVChar (const char *name, const CORBA::Char value)
	value が CORBA::Char の NameValue を生成する
SDOPackage::NameValue	newNVBool (const char *name, const CORBA::Boolean value)
	value が CORBA::Boolean の NameValue を生成する
SDOPackage::NameValue	newNVOctet (const char *name, const CORBA::Octet value)
	value が CORBA::Octet の NameValue を生成する
SDOPackage::NameValue	newNVAny (const char *name, const CORBA::Any &value)
	value が CORBA::Any の NameValue を生成する
void	copyFromProperties (SDOPackage::NVList &nv, const coil::Properties &prop)
	Properties を NVList へコピーする.
void	copyToProperties (coil::Properties &prop, const SDOPackage::NVList &nv)
	NVList を Properties へコピーする.
coil::Properties	toProperties (const SDOPackage::NVList &nv)
	NVList を Properties へ変換する.
const CORBA::Any &	find (const SDOPackage::NVList &nv, const char *name)
	NVList から name で指定された value を返す.
const CORBA::Long	find_index (const SDOPackage::NVList &nv, const char *name)
	name で指定された要素のインデックスを返す
bool	isString (const SDOPackage::NVList &nv, const char *name)
	指定された name の value の型が string であるか検証する
bool	isStringValue (const SDOPackage::NVList &nv, const char *name, const char *value)
	指定された name の value の値が指定した文字列と一致するか検証する
std::string	toString (const SDOPackage::NVList &nv, const char *name)
	指定された name の NVList を string として返す。
bool	appendStringValue (SDOPackage::NVList &nv, const char *name, const char *value)
	指定された文字列を NVList の要素に追加する。
void	append (SDOPackage::NVList &dest, const SDOPackage::NVList &src)
	NVList に要素を追加する。.
std::ostream &	dump (std::ostream &out, const SDOPackage::NVList &nv)
	NVList に設定されている内容を文字列として出力する。.
void	dump (const SDOPackage::NVList &nv)
	NVList に設定されている内容を文字列として標準出力する。.
std::string	toString (const SDOPackage::NVList &nv)
	NVList に設定されている内容を文字列にする.

---

説明

NameValue 用ユーティリティ.

NameValue に対してのユーティリティ関数を提供する。

---

関数

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

NVList に要素を追加する。.

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

引数:

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

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

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

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

引数:

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

戻り値:

追加操作結果

参照元 RTC::PortBase::appendProperty().

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

Properties を NVList へコピーする.

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

引数:

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

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

NVList を Properties へコピーする.

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

引数:

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

void NVUtil::dump

(

const SDOPackage::NVList &

nv

)

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

引数:

nv

出力対象 NVList

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

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

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

引数:

nv

出力対象 NVList

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

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

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

引数:

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

戻り値:

検索結果

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

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

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

引数:

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

戻り値:

検索対象のインデックス

参照元 RTC::OutPort< DataType >::OutPort().

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

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

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

引数:

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

戻り値:

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

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

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

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

引数:

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

戻り値:

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

template<class Value >

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

NameValue を生成する.

このオペレーションはNameValueを作成する。 CORBA::Char, CORBA::Boolean, CORBA::Octet は作成できない。 これらの値は newNVChar(), newNVBool(), newNVOctet() で作成する。

引数:

	name	NameValue の name
	value	NameValue の value

戻り値:

NameValue

参照元 RTC::PortBase::addProperty().

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

value が CORBA::Any の NameValue を生成する

このオペレーションはf value が CORBA::Any の NameValueを作成する。

引数:

	name	NameValue の name
	value	NameValue の value

戻り値:

NameValue

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

value が CORBA::Boolean の NameValue を生成する

このオペレーションはf value が CORBA::Boolean の NameValueを作成する。

引数:

	name	NameValue の name
	value	NameValue の value

戻り値:

NameValue

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

value が CORBA::Char の NameValue を生成する

このオペレーションはf value が CORBA::Char の NameValueを作成する。

引数:

	name	NameValue の name
	value	NameValue の value

戻り値:

NameValue

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

value が CORBA::Octet の NameValue を生成する

このオペレーションは value が CORBA::Octet の NameValueを作成する。

引数:

	name	NameValue の name
	value	NameValue の value

戻り値:

NameValue

coil::Properties NVUtil::toProperties

(

const SDOPackage::NVList &

nv

)

NVList を Properties へ変換する.

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

引数:

nv

変換元の NVList

戻り値:

変換結果Property

std::string NVUtil::toString

(

const SDOPackage::NVList &

nv

)

NVList に設定されている内容を文字列にする.

引数:

nv

出力対象 NVList

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

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

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

引数:

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

戻り値:

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