NVUtil.h
Go to the documentation of this file.
1 // -*- C++ -*-
20 #ifndef NVUTIL_NVUTIL_H
21 #define NVUTIL_NVUTIL_H
22 
23 #include <string>
24 #include <iostream>
25 #include <coil/Properties.h>
26 #include <rtm/idl/SDOPackageSkel.h>
27 
46 namespace NVUtil
47 {
78  template <class Value>
79  SDOPackage::NameValue newNV(const char* name, Value value)
80  {
81  SDOPackage::NameValue nv;
82  nv.name = CORBA::string_dup(name);
83  nv.value <<= value;
84  return nv;
85  }
86 
87  /***
88  * @if jp
89  *
90  * @brief value が CORBA::string の NameValue を生成する * * このオペレーションはf value が CORBA::string の NameValueを作成する。 * * @param name NameValue の name * @param value NameValue の value * * @return NameValue * * @else * * @brief Create NameValue typed CORBA::string * * This operation creates NameValue typed CORBA::string. * * @param name Name of NameValue * @param value The value of NameValue * * @return NameValue * * @endif */ /* template <> SDOPackage::NameValue newNV(const char* name, const char* value) { SDOPackage::NameValue nv; nv.name = CORBA::string_dup(name); nv.value <<= value; return nv; } */ /*! * @if jp * * @brief value が CORBA::Char の NameValue を生成する * * このオペレーションはf value が CORBA::Char の NameValueを作成する。 * * @param name NameValue の name * @param value NameValue の value * * @return NameValue * * @else * * @brief Create NameValue typed CORBA::Char * * This operation creates NameValue typed CORBA::Char. * * @param name Name of NameValue * @param value The value of NameValue * * @return NameValue * * @endif */ SDOPackage::NameValue newNVChar(const char* name, const CORBA::Char value); /*! * @if jp * * @brief value が CORBA::Boolean の NameValue を生成する * * このオペレーションはf value が CORBA::Boolean の NameValueを作成する。 * * @param name NameValue の name * @param value NameValue の value * * @return NameValue * * @else * * @brief Create NameValue typed CORBA::Boolean * * This operation creates NameValue typed CORBA::Boolean. * * @param name Name of NameValue * @param value The value of NameValue * * @return NameValue * * @endif */ SDOPackage::NameValue newNVBool(const char* name, const CORBA::Boolean value); /*! * @if jp * * @brief value が CORBA::Octet の NameValue を生成する * * このオペレーションは value が CORBA::Octet の NameValueを作成する。 * * @param name NameValue の name * @param value NameValue の value * * @return NameValue * * @else * * @brief Create NameValue typed CORBA::Octet * * This operation creates NameValue typed CORBA::Octet. * * @param name Name of NameValue * @param value The value of NameValue * * @return NameValue * * @endif */ SDOPackage::NameValue newNVOctet(const char* name, const CORBA::Octet value); /*! * @if jp * * @brief value が CORBA::Any の NameValue を生成する * * このオペレーションはf value が CORBA::Any の NameValueを作成する。 * * @param name NameValue の name * @param value NameValue の value * * @return NameValue * * @else * * @brief Create NameValue typed CORBA::Any * * This operation creates NameValue typed CORBA::Any. * * @param name Name of NameValue * @param value The value of NameValue * * @return NameValue * * @endif */ SDOPackage::NameValue newNVAny(const char* name, const CORBA::Any& value); /*! * @if jp * * @brief Properties を NVList へコピーする * * このオペレーションは Properties を NVList へコピーする。 * NVList の value は全て CORBA::string 型としてコピーする。 * * @param nv Properties の値を格納する NVList * @param prop コピー元の Properties * * @else * * @brief Copy the properties to NVList * * This operation copies the properties to NVList. * All NVList's values are copied as CORBA::string. * * @param nv NVList to store properties values * @param prop Properties that is copies from * * @endif */ #ifndef ORB_IS_RTORB void copyFromProperties(SDOPackage::NVList& nv, const coil::Properties& prop); #else // ORB_IS_RTORB void copyFromProperties(SDOPackage_NVList& nv, const coil::Properties& prop); #endif // ORB_IS_RTORB /*! * @if jp * * @brief NVList を Properties へコピーする * * このオペレーションは NVList を Properties へコピーする。 * * @param prop NVList の値を格納する Properties * @param nv コピー元の NVList * * @else * * @brief Copy NVList to the Proeprties * * This operation copies NVList to properties. * * @param prop Properties to store NVList values * @param nv NVList of copy source * * @endif */ void copyToProperties(coil::Properties& prop, const SDOPackage::NVList& nv); /*! * @if jp * * @brief NVList を Properties へ変換する * * このオペレーションは NVList を Properties へ変換する。 * * @param nv 変換元の NVList * * @return 変換結果Property * * @else * * @brief Transform NVList to the properties * * This operation transforms NVList to properties * * @param nv NVList of tranformation source * * @return Transformation result Property * * @endif */ coil::Properties toProperties(const SDOPackage::NVList& nv); /*! * @if jp * * @brief NVList から name で指定された value を返す * * このオペレーションは name で指定された value を Any 型で返す。 * 指定した名称の要素が存在しない場合は例外を発生させる。 * * @param nv 検索対象の NVList * @param name 検索する名前 * * @return 検索結果 * * @else * * @brief 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. * * @param nv The target NVList for the find * @param name Name for the find * * @return Find result * * @endif */ const CORBA::Any& find(const SDOPackage::NVList& nv, const char* name); /*! * @if jp * * @brief name で指定された要素のインデックスを返す * * このオペレーションは name で指定された要素が格納されている位置の * インデックスを返す。 * * @param nv 検索対象の NVList * @param name 検索する名前 * * @return 検索対象のインデックス * * @else * * @brief 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. * * @param nv The target NVList for the find * @param name Name for the find * * @return Index of target object for the find * * @endif */ const CORBA::Long find_index(const SDOPackage::NVList& nv, const char* name); /*! * @if jp * * @brief 指定された name の value の型が string であるか検証する * * このオペレーションは name で指定された value の型が CORBA::string * かどうかを bool 値で返す。 * * @param nv 検索対象の NVList * @param name 検索する名前 * * @return string検証結果(string:true、それ以外:false) * * @else * * @brief 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. * * @param nv The target NVList for the search * @param name Name for the search * * @return String validation result (String:true, Else:false) * * @endif */ bool isString(const SDOPackage::NVList& nv, const char* name); /*! * @if jp * * @brief 指定された name の value の値が指定した文字列と一致するか検証する * * このオペレーションは name で指定された value の型が CORBA::string * かどうかを判断し、 CORBA::string である場合には指定した文字列と一致するか * をbool 値で返す。 * * @param nv 検索対象の NVList * @param name 検索する名前 * @param value 比較対象文字列 * * @return 検証結果(文字列と一致:true、非一致:false) * * @else * * @brief 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. * * @param nv The target NVList for the search * @param name Name for the search * @param value String value to compare * * @return Check result (Match:true, Unmatch:false) * * @endif */ bool isStringValue(const SDOPackage::NVList& nv, const char* name, const char* value); /*! * @if jp * * @brief 指定された name の NVList を string として返す。 * * このオペレーションは name で指定された NVList の値を string で返す。 * もし、name で指定した value の値が CORBA::string でなければ、 * 空の文字列のstringを返す。 * * @param nv 検索対象の NVList * @param name 検索する名前 * * @return name に対応する値のstring型の値 * * @else * * @brief 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. * * @param nv The target NVList for the search * @param name Name for the search * * @return String value corresponding to name * * @endif */ std::string toString(const SDOPackage::NVList& nv, const char* name); /*! * @if jp * * @brief 指定された文字列を NVList の要素に追加する。 * * このオペレーションは name で指定された要素に value で指定された文字列を * 追加する。 * name で指定した要素に既に value の値が設定されている場合には何もしない。 * name で指定した要素に value の値が設定されていない場合は、 ","区切りで * value の値を追加する。 * 指定された値を設定する。 * name で指定した要素が存在しない場合は、 NVList の最後に新たな要素を追加し、 * 指定された値を設定する。 * * @param nv 検索対象の NVList * @param name 追加対象要素名 * @param value 追加する文字列 * * @return 追加操作結果 * * @else * * @brief 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. * * @param nv The target NVList for the search * @param name The target element name for the appending * @param value String to append * * @return Append operation result * * @endif */ #ifndef ORB_IS_RTORB bool appendStringValue(SDOPackage::NVList& nv, const char* name, const char* value); #else // ORB_IS_RTORB bool appendStringValue(SDOPackage_NVList& nv, const char* name, const char* value); #endif // ORB_IS_RTORB /*! * @if jp * * @brief NVList に要素を追加する。 * * このオペレーションは dest で指定された NVList に src で指定された要素を * 追加する。 * * @param dest 追加される NVList * @param src 追加する NVList * * @else * * @brief Append an element to NVList * * This operation appends elements specified by src to NVList specified * by dest. * * @param dest NVList to be appended * @param src NVList to append * * @endif */ void append(SDOPackage::NVList& dest, const SDOPackage::NVList& src); /*! * @if jp * * @brief NVList に設定されている内容を文字列として出力する。 * * 指定された NVList に設定された内容を文字列として出力する。 * なお、設定されている要素が文字列型以外の場合には、その旨(文字列ではない)を * 出力する。 * * @param nv 出力対象 NVList * * @else * * @brief 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. * * @param nv The target NVList for the print * * @endif */ std::ostream& dump(std::ostream& out, const SDOPackage::NVList& nv); /*! * @if jp * @brief NVList に設定されている内容を文字列として標準出力する。 * * @param nv 出力対象 NVList * * @else * @brief Print information configured in NVList as a string type * to Standard Outport. * * @param nv The target NVList for the print * * @endif */ void dump(const SDOPackage::NVList& nv); /*! * @if jp * @brief NVList に設定されている内容を文字列にする * * @param nv 出力対象 NVList * * @else * @brief Get information configured in NVList as a string type. * * @param nv The target NVList for the print * * @endif */ std::string toString(const SDOPackage::NVList& nv); }; #endif // NVUTIL_NVUTIL_H
91  *
92  * このオペレーションはf value が CORBA::string の NameValueを作成する。
93  *
94  * @param name NameValue の name
95  * @param value NameValue の value
96  *
97  * @return NameValue
98  *
99  * @else
100  *
101  * @brief Create NameValue typed CORBA::string
102  *
103  * This operation creates NameValue typed CORBA::string.
104  *
105  * @param name Name of NameValue
106  * @param value The value of NameValue
107  *
108  * @return NameValue
109  *
110  * @endif
111  */
112  /*
113  template <>
114  SDOPackage::NameValue newNV(const char* name, const char* value)
115  {
116  SDOPackage::NameValue nv;
117  nv.name = CORBA::string_dup(name);
118  nv.value <<= value;
119  return nv;
120  }
121  */
122 
148  SDOPackage::NameValue newNVChar(const char* name, const CORBA::Char value);
149 
175  SDOPackage::NameValue newNVBool(const char* name,
176  const CORBA::Boolean value);
177 
203  SDOPackage::NameValue newNVOctet(const char* name, const CORBA::Octet value);
204 
230  SDOPackage::NameValue newNVAny(const char* name, const CORBA::Any& value);
231 
255 #ifndef ORB_IS_RTORB
256  void copyFromProperties(SDOPackage::NVList& nv, const coil::Properties& prop);
257 #else // ORB_IS_RTORB
258  void copyFromProperties(SDOPackage_NVList& nv, const coil::Properties& prop);
259 #endif // ORB_IS_RTORB
260 
282  void copyToProperties(coil::Properties& prop, const SDOPackage::NVList& nv);
283 
307  coil::Properties toProperties(const SDOPackage::NVList& nv);
308 
336  const CORBA::Any& find(const SDOPackage::NVList& nv, const char* name);
337 
365  const CORBA::Long find_index(const SDOPackage::NVList& nv, const char* name);
366 
394  bool isString(const SDOPackage::NVList& nv, const char* name);
395 
427  bool isStringValue(const SDOPackage::NVList& nv, const char* name,
428  const char* value);
429 
459  std::string toString(const SDOPackage::NVList& nv, const char* name);
460 
503 #ifndef ORB_IS_RTORB
504  bool appendStringValue(SDOPackage::NVList& nv, const char* name,
505  const char* value);
506 #else // ORB_IS_RTORB
507  bool appendStringValue(SDOPackage_NVList& nv, const char* name,
508  const char* value);
509 #endif // ORB_IS_RTORB
510 
534  void append(SDOPackage::NVList& dest, const SDOPackage::NVList& src);
535 
559  std::ostream& dump(std::ostream& out, const SDOPackage::NVList& nv);
560 
575  void dump(const SDOPackage::NVList& nv);
576 
590  std::string toString(const SDOPackage::NVList& nv);
591 
592 
593 };
594 #endif // NVUTIL_NVUTIL_H
NVUtil::newNV
SDOPackage::NameValue newNV(const char *name, Value value)
Create NameValue.
Definition: NVUtil.h:79
NVUtil::isString
bool isString(const SDOPackage::NVList &nv, const char *name)
Validate whether value type specified by name is string type.
Definition: NVUtil.cpp:239
NVUtil::newNVOctet
SDOPackage::NameValue newNVOctet(const char *name, const CORBA::Octet value)
Create NameValue typed CORBA::Octet.
Definition: NVUtil.cpp:77
NVUtil::appendStringValue
bool appendStringValue(SDOPackage::NVList &nv, const char *name, const char *value)
Append the specified string to element of NVList.
Definition: NVUtil.cpp:313
RTC::Local::NVList
std::vector< std::pair< std::string, std::string > > NVList
Definition: IRTC.h:67
NVUtil::newNVBool
SDOPackage::NameValue newNVBool(const char *name, const CORBA::Boolean value)
This operation creates NameValue typed CORBA::Boolean.
Definition: NVUtil.cpp:62
NVUtil
Utility for NameValue.
Definition: NVUtil.cpp:38
NVUtil::find_index
const CORBA::Long find_index(const SDOPackage::NVList &nv, const char *name)
Return the index of element specified by name from NVList.
Definition: NVUtil.cpp:227
NVUtil::copyToProperties
void copyToProperties(coil::Properties &prop, const SDOPackage::NVList &nv)
Copy NVList to the Proeprties.
Definition: NVUtil.cpp:137
NVUtil::toString
std::string toString(const SDOPackage::NVList &nv, const char *name)
Get NVList of specifid name as string.
Definition: NVUtil.cpp:282
NVUtil::find
const CORBA::Any & find(const SDOPackage::NVList &nv, const char *name)
Return the value specified by name from NVList.
Definition: NVUtil.cpp:212
NVUtil::dump
void dump(const SDOPackage::NVList &nv)
Print information configured in NVList as a string type to Standard Outport.
Definition: NVUtil.cpp:394
NVUtil::append
void append(SDOPackage::NVList &dest, const SDOPackage::NVList &src)
Append an element to NVList.
Definition: NVUtil.cpp:354
OrganizationSDOPackageTest.prop
prop
Organization::get_organization_property ();.
Definition: OrganizationSDOPackageTest.py:107
NVUtil::toProperties
coil::Properties toProperties(const SDOPackage::NVList &nv)
Transform NVList to the properties.
Definition: NVUtil.cpp:180
coil::Properties
Class represents a set of properties.
Definition: Properties.h:101
NVUtil::newNVChar
SDOPackage::NameValue newNVChar(const char *name, const CORBA::Char value)
Create NameValue typed CORBA::Char.
Definition: NVUtil.cpp:47
NVUtil::isStringValue
bool isStringValue(const SDOPackage::NVList &nv, const char *name, const char *value)
Check whether the value of specified name specified matches the specified string. ...
Definition: NVUtil.cpp:262
NVUtil::copyFromProperties
void copyFromProperties(SDOPackage::NVList &nv, const coil::Properties &prop)
Copy the properties to NVList.
Definition: NVUtil.cpp:108
NVUtil::newNVAny
SDOPackage::NameValue newNVAny(const char *name, const CORBA::Any &value)
Create NameValue typed CORBA::Any.
Definition: NVUtil.cpp:92

openrtm_aist
Author(s): Noriaki Ando
autogenerated on Thu Jun 6 2019 19:25:59