Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.value.Value Class Reference
Inheritance diagram for cpc.dataflow.value.Value:
cpc.dataflow.value.ValueBase 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 copy
 
def destroy
 
def setLiteral
 
def setNone
 
def get
 
def getType
 
def getBasetype
 
def hasSubValue
 
def getSubValue
 
def getCreateSubValue
 
def getClosestSubValue
 
def getSubType
 
def getSubValueList
 
def getSubValueIterList
 
def haveAllRequiredValues
 
def remove
 
def getFullName
 
def setUpdated
 
def markUpdated
 
def isUpdated
 
def hasUpdates
 
def writeXML
 
def writeContentsXML
 
def itervalues
 
def getDesc
 
- Public Member Functions inherited from cpc.dataflow.value.ValueBase
def getSubValue
 
def getCreateSubValue
 
def getClosestSubValue
 
def getSubValueList
 
def getSubValueIterList
 
def hasSubValue
 
def getType
 
def getDesc
 

Public Attributes

 type
 
 basetype
 
 createObject
 
 parent
 
 owner
 
 fileValue
 
 fileList
 
 updated
 
 selfName
 
 seqNr
 
 sourceTag
 
 value
 

Detailed Description

The class describing a data value. Value classes hold function input 
   and output data, and are used to transmit external i/o data.

Member Function Documentation

def cpc.dataflow.value.Value.copy (   self,
  val 
)
Copy a value object or None
def cpc.dataflow.value.Value.destroy (   self)
Destroy the contents of this value. Only relevant for values
   that keep File objects.
def cpc.dataflow.value.Value.get (   self)
Set a literal value: a value without subtypes.
def cpc.dataflow.value.Value.getBasetype (   self)
Get the base type.
def cpc.dataflow.value.Value.getClosestSubValue (   self,
  itemList 
)
Get or create (if create==True) a specific subvalue through a 
   list of subitems, or return None if not found.
   
   itemList = the path of the value to get the closest value for
   If create==true, a subitem will be created for arrays/dicts
   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.
   if closestValue is true, the closest relevant value will be
                    returned 
def cpc.dataflow.value.Value.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 create==true, a subitem will be created for arrays/dicts
   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.Value.getDesc (   self)
Return a 'description' of a value: an item that can be passed to 
   the client describing the value.
def cpc.dataflow.value.Value.getFullName (   self)
Get the full name of the subitems of this value.
def cpc.dataflow.value.Value.getSubType (   self,
  itemList 
)
Determine the type of a sub-item (even if it doesn't exist yet).
def cpc.dataflow.value.Value.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.Value.getSubValueIterList (   self)
Return an iterable list of addressable subvalues.
def cpc.dataflow.value.Value.getSubValueList (   self)
Return a list of addressable subvalues.
def cpc.dataflow.value.Value.getType (   self)
Return the type associated with this value
def cpc.dataflow.value.Value.hasSubValue (   self,
  itemList 
)
Check whether a particular subvalue exists
def cpc.dataflow.value.Value.hasUpdates (   self)
Return whether this value or any of its chidren has the updated
   field set.
def cpc.dataflow.value.Value.haveAllRequiredValues (   self)
Return a boolean indicating whether this value and all of its
   subvalues are present (if they're not optional).
def cpc.dataflow.value.Value.isUpdated (   self)
def cpc.dataflow.value.Value.itervalues (   self)
Iterate the values of a compound type
def cpc.dataflow.value.Value.markUpdated (   self,
  updated 
)
Set the updated field for this value and its parents.
def cpc.dataflow.value.Value.remove (   self)
Remove the actual object.
def cpc.dataflow.value.Value.setLiteral (   self,
  literalValue 
)
Set a value: a value without subtypes.
def cpc.dataflow.value.Value.setNone (   self)
Set a value to None
def cpc.dataflow.value.Value.setUpdated (   self,
  updated 
)
Set the updated field for this value, and all its subvalues
   to 'updated'
def cpc.dataflow.value.Value.writeContentsXML (   self,
  outf,
  indent = 0 
)
Write out this value's subvalues as XML
def cpc.dataflow.value.Value.writeXML (   self,
  outf,
  indent = 0,
  fieldName = None 
)
Write out this value as XML

Member Data Documentation

cpc.dataflow.value.Value.basetype
cpc.dataflow.value.Value.createObject
cpc.dataflow.value.Value.fileList
cpc.dataflow.value.Value.fileValue
cpc.dataflow.value.Value.owner
cpc.dataflow.value.Value.parent
cpc.dataflow.value.Value.selfName
cpc.dataflow.value.Value.seqNr
cpc.dataflow.value.Value.sourceTag
cpc.dataflow.value.Value.type
cpc.dataflow.value.Value.updated
cpc.dataflow.value.Value.value

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