Classes | Functions | Variables
NVUtil Namespace Reference

Utility for NameValue. More...

Classes

struct  nv_find
 Functor to find a NVList. More...
 
class  NVUtilTests
 NVUtil Test. More...
 
struct  to_prop
 Functor to transform NVList into the properties. More...
 

Functions

void append (SDOPackage::NVList &dest, const SDOPackage::NVList &src)
 Append an element to NVList. More...
 
bool appendStringValue (SDOPackage::NVList &nv, const char *name, const char *value)
 Append the specified string to element of NVList. More...
 
void copyFromProperties (SDOPackage::NVList &nv, const coil::Properties &prop)
 Copy the properties to NVList. More...
 
void copyToProperties (coil::Properties &prop, const SDOPackage::NVList &nv)
 Copy NVList to the Proeprties. More...
 
void dump (const SDOPackage::NVList &nv)
 Print information configured in NVList as a string type to Standard Outport. More...
 
std::ostream & dump (std::ostream &out, const SDOPackage::NVList &nv)
 Print information configured in NVList as string type. More...
 
std::ostream & dump_to_stream (std::ostream &out, const SDOPackage::NVList &nv)
 Print information configured in NVList as a string type. More...
 
const CORBA::Any & find (const SDOPackage::NVList &nv, const char *name)
 Return the value specified by name from NVList. More...
 
const CORBA::Long find_index (const SDOPackage::NVList &nv, const char *name)
 Return the index of element specified by name from NVList. More...
 
bool isString (const SDOPackage::NVList &nv, const char *name)
 Validate whether value type specified by name is string type. More...
 
bool isStringValue (const SDOPackage::NVList &nv, const char *name, const char *value)
 Check whether the value of specified name specified matches the specified string. More...
 
template<class Value >
SDOPackage::NameValue newNV (const char *name, Value value)
 Create NameValue. More...
 
SDOPackage::NameValue newNVAny (const char *name, const CORBA::Any &value)
 Create NameValue typed CORBA::Any. More...
 
SDOPackage::NameValue newNVBool (const char *name, const CORBA::Boolean value)
 This operation creates NameValue typed CORBA::Boolean. More...
 
SDOPackage::NameValue newNVChar (const char *name, const CORBA::Char value)
 Create NameValue typed CORBA::Char. More...
 
SDOPackage::NameValue newNVOctet (const char *name, const CORBA::Octet value)
 Create NameValue typed CORBA::Octet. More...
 
coil::Properties toProperties (const SDOPackage::NVList &nv)
 Transform NVList to the properties. More...
 
std::string toString (const SDOPackage::NVList &nv, const char *name)
 Get NVList of specifid name as string. More...
 
std::string toString (const SDOPackage::NVList &nv)
 Get information configured in NVList as a string type. More...
 

Variables

int g_argc
 
vector< string > g_argv
 

Detailed Description

Utility for NameValue.

This class provides the utility function of NameValue.

Function Documentation

◆ append()

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

Append an element to NVList.

This operation appends elements specified by src to NVList specified by dest.

Parameters
destNVList to be appended
srcNVList to append

Definition at line 354 of file NVUtil.cpp.

◆ appendStringValue()

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

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.

Parameters
nvThe target NVList for the search
nameThe target element name for the appending
valueString to append
Returns
Append operation result

Definition at line 313 of file NVUtil.cpp.

◆ copyFromProperties()

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

Copy the properties to NVList.

This operation copies the properties to NVList. All NVList's values are copied as CORBA::string.

Parameters
nvNVList to store properties values
propProperties that is copies from

Definition at line 108 of file NVUtil.cpp.

◆ copyToProperties()

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

Copy NVList to the Proeprties.

This operation copies NVList to properties.

Parameters
propProperties to store NVList values
nvNVList of copy source

Definition at line 137 of file NVUtil.cpp.

◆ dump() [1/2]

void NVUtil::dump ( const SDOPackage::NVList &  nv)

Print information configured in NVList as a string type to Standard Outport.

Parameters
nvThe target NVList for the print

Definition at line 394 of file NVUtil.cpp.

◆ dump() [2/2]

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

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.

Parameters
nvThe target NVList for the print

◆ dump_to_stream()

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

Print information configured in NVList as a string type.

Definition at line 369 of file NVUtil.cpp.

◆ find()

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

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.

Parameters
nvThe target NVList for the find
nameName for the find
Returns
Find result

Definition at line 212 of file NVUtil.cpp.

◆ find_index()

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

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.

Parameters
nvThe target NVList for the find
nameName for the find
Returns
Index of target object for the find

Definition at line 227 of file NVUtil.cpp.

◆ isString()

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

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.

Parameters
nvThe target NVList for the search
nameName for the search
Returns
String validation result (String:true, Else:false)

Definition at line 239 of file NVUtil.cpp.

◆ isStringValue()

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

Check whether the value of specified name specified matches the specified string.

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.

Parameters
nvThe target NVList for the search
nameName for the search
valueString value to compare
Returns
Check result (Match:true, Unmatch:false)

Definition at line 262 of file NVUtil.cpp.

◆ newNV()

template<class Value >
SDOPackage::NameValue NVUtil::newNV ( const char *  name,
Value  value 
)

Create NameValue.

This operation creates NameValue. CORBA::Char, CORBA::Boolean, CORBA::Octet creation is not supported. These type of NameValue should be created by using newNVChar(), newNVBool(), newNVOctet() functions.

Parameters
nameName of NameValue
valueThe value of NameValue
Returns
NameValue

Definition at line 79 of file NVUtil.h.

◆ newNVAny()

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

Create NameValue typed CORBA::Any.

This operation creates NameValue typed CORBA::Any.

Parameters
nameName of NameValue
valueThe value of NameValue
Returns
NameValue

Definition at line 92 of file NVUtil.cpp.

◆ newNVBool()

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

This operation creates NameValue typed CORBA::Boolean.

Create NameValue typed CORBA::Boolean.

This operation creates NameValue typed CORBA::Boolean.

Parameters
nameName of NameValue
valueThe value of NameValue
Returns
NameValue

Definition at line 62 of file NVUtil.cpp.

◆ newNVChar()

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

Create NameValue typed CORBA::Char.

This operation creates NameValue typed CORBA::Char.

Parameters
nameName of NameValue
valueThe value of NameValue
Returns
NameValue

Definition at line 47 of file NVUtil.cpp.

◆ newNVOctet()

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

Create NameValue typed CORBA::Octet.

This operation creates NameValue typed CORBA::Octet.

Parameters
nameName of NameValue
valueThe value of NameValue
Returns
NameValue

Definition at line 77 of file NVUtil.cpp.

◆ toProperties()

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

Transform NVList to the properties.

This operation transforms NVList to properties

Parameters
nvNVList of tranformation source
Returns
Transformation result Property

Definition at line 180 of file NVUtil.cpp.

◆ toString() [1/2]

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

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.

Parameters
nvThe target NVList for the search
nameName for the search
Returns
String value corresponding to name

Definition at line 282 of file NVUtil.cpp.

◆ toString() [2/2]

std::string NVUtil::toString ( const SDOPackage::NVList &  nv)

Get information configured in NVList as a string type.

Parameters
nvThe target NVList for the print

Definition at line 406 of file NVUtil.cpp.

Variable Documentation

◆ g_argc

int NVUtil::g_argc

Definition at line 65 of file NVUtilTests.cpp.

◆ g_argv

vector<string> NVUtil::g_argv

Definition at line 66 of file NVUtilTests.cpp.



openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:46