Classes | Functions
OpenRTM_aist.NVUtil Namespace Reference

Classes

class  nv_find
 
class  to_prop
 

Functions

def append (dest, src)
 
def appendStringValue (nv, name, value)
 
def copyFromProperties (nv, prop)
 Copy to NVList from Proeprties. More...
 
def copyToProperties (prop, nvlist)
 Copy to Proeprties from NVList. More...
 
def dump (nv)
 
def dump_to_stream (out, nv)
 Print information configured in NVList as a string type std::ostream& dump_to_stream(std::ostream& out, const SDOPackage::NVList& nv) More...
 
def find (nv, name)
 Get value in NVList specified by name. More...
 
def find_index (nv, name)
 
def isString (nv, name)
 
def isStringValue (nv, name, value)
 
def newNV (name, value)
 Create NameVale. More...
 
def toProperties (nv)
 coil::Properties toProperties(const SDOPackage::NVList& nv); More...
 
def toString (nv, name=None)
 Get string value in NVList specified by name. More...
 

Function Documentation

◆ append()

def OpenRTM_aist.NVUtil.append (   dest,
  src 
)

Definition at line 386 of file NVUtil.py.

◆ appendStringValue()

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

Definition at line 352 of file NVUtil.py.

◆ copyFromProperties()

def OpenRTM_aist.NVUtil.copyFromProperties (   nv,
  prop 
)

Copy to NVList from Proeprties.

This operation copies Properties to NVList. Created NVList's values are CORBA::string.

Parameters
nvNVList to store Properties values
propProperties that is copies from

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

Definition at line 85 of file NVUtil.py.

◆ copyToProperties()

def OpenRTM_aist.NVUtil.copyToProperties (   prop,
  nvlist 
)

Copy to Proeprties from NVList.

This operation copies NVList to Properties.

Parameters
propProperties to store NVList values
nvNVList that is copies from

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

Definition at line 118 of file NVUtil.py.

◆ dump()

def OpenRTM_aist.NVUtil.dump (   nv)

Definition at line 423 of file NVUtil.py.

◆ dump_to_stream()

def OpenRTM_aist.NVUtil.dump_to_stream (   out,
  nv 
)

Print information configured in NVList as a string type std::ostream& dump_to_stream(std::ostream& out, const SDOPackage::NVList& nv)

Definition at line 398 of file NVUtil.py.

◆ find()

def OpenRTM_aist.NVUtil.find (   nv,
  name 
)

Get value in NVList specified by name.

This operation returns Any type of value specified by name. Created NVList's values are CORBA::string.

Parameters
nvNVList to be searched
propname to seartch in NVList

Definition at line 204 of file NVUtil.py.

◆ find_index()

def OpenRTM_aist.NVUtil.find_index (   nv,
  name 
)

Definition at line 229 of file NVUtil.py.

◆ isString()

def OpenRTM_aist.NVUtil.isString (   nv,
  name 
)

Definition at line 249 of file NVUtil.py.

◆ isStringValue()

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

Definition at line 276 of file NVUtil.py.

◆ newNV()

def OpenRTM_aist.NVUtil.newNV (   name,
  value 
)

Create NameVale.

This operation creates NameVale.

Parameters
namename of NameValue
valuevalue of NameValue
Returns
NameValue

Definition at line 50 of file NVUtil.py.

◆ toProperties()

def OpenRTM_aist.NVUtil.toProperties (   nv)

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

Definition at line 158 of file NVUtil.py.

◆ toString()

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

Get string value in NVList specified by name.

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
nvNVList to be searched
namename to to serach
Returns
string value named by name

Definition at line 311 of file NVUtil.py.



openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Feb 28 2022 23:01:08