Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.value.ValueBase Class Reference
Inheritance diagram for cpc.dataflow.value.ValueBase:
cpc.dataflow.active_inst.ActiveInstance cpc.dataflow.msg.ActiveInstanceMsg cpc.dataflow.value.Value cpc.dataflow.active_value.ActiveValue cpc.dataflow.run.ArrayValue cpc.dataflow.run.BoolValue cpc.dataflow.run.DictValue cpc.dataflow.run.FileValue cpc.dataflow.run.FloatValue cpc.dataflow.run.IntValue cpc.dataflow.run.RecordValue cpc.dataflow.run.StringValue

Public Member Functions

def getSubValue
 
def getCreateSubValue
 
def getClosestSubValue
 
def getSubValueList
 
def getSubValueIterList
 
def hasSubValue
 
def getType
 
def getDesc
 

Detailed Description

The basic interface for a value-like object.

Member Function Documentation

def cpc.dataflow.value.ValueBase.getClosestSubValue (   self,
  itemList 
)
Get the closest relevant subvalue through a list of subitems, 
   
   itemList = the path of the value to get the closest value for 
def cpc.dataflow.value.ValueBase.getCreateSubValue (   self,
  itemList,
  createType = None,
  setCreateSourceTag = None 
)
Get or create a specific subvalue through a list of subitems, or 
   return None if not found.
   itemList = the path of the value to return/create
   if createType == a type, a subitem will be created with the given 
            type
   if setCreateSourceTag = not None, the source tag will be set for
                   any items that are created.
def cpc.dataflow.value.ValueBase.getDesc (   self)
Return a 'description' of a value: an item that can be passed to 
   the client describing the value.
def cpc.dataflow.value.ValueBase.getSubValue (   self,
  itemList 
)
Get a specific subvalue through a list of subitems, or return None 
   if not found.
   itemList = the path of the value to return
def cpc.dataflow.value.ValueBase.getSubValueIterList (   self)
Return an iterable list of addressable subvalues.
def cpc.dataflow.value.ValueBase.getSubValueList (   self)
Return a list of addressable subvalues.
def cpc.dataflow.value.ValueBase.getType (   self)
Return the type associated with this value
def cpc.dataflow.value.ValueBase.hasSubValue (   self,
  itemList 
)
Check whether a particular subvalue exists

The documentation for this class was generated from the following file: