Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.active_value.ActiveValue Class Reference
Inheritance diagram for cpc.dataflow.active_value.ActiveValue:
cpc.dataflow.value.Value cpc.dataflow.value.ValueBase

Public Member Functions

def setListener
 
def getListener
 
def writeDebug
 
def update
 
def addMember
 
def acceptNewValue
 
def setSourceTag
 
def findListeners
 
def propagate
 
def notifyListeners
 
- Public Member Functions inherited from cpc.dataflow.value.Value
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

 seqNr
 
 listener
 
 sourceTag
 
 fileValue
 
 value
 
 basetype
 
- Public Attributes inherited from cpc.dataflow.value.Value
 type
 
 basetype
 
 createObject
 
 parent
 
 owner
 
 fileValue
 
 fileList
 
 updated
 
 selfName
 
 seqNr
 
 sourceTag
 
 value
 

Detailed Description

The class describing an active data value, as held by an active 
   instance.
   
   Values are trees with dicts/lists of members; the top level is usually
   a <instance>:in or <instance>:out. ActiveValue trees have listeners:
   active connection points that connect values together.

Member Function Documentation

def cpc.dataflow.active_value.ActiveValue.acceptNewValue (   self,
  sourceValue,
  sourceTag,
  resetSourceTag = False 
)
Find all newly set value of this value and any of its children that
   originate from source.
   
   sourceValue = the input value
   sourceTag = a source tag to check for (or None to accept anything)
    
   Returns: a boolean telling whether an update has taken place.
def cpc.dataflow.active_value.ActiveValue.addMember (   self,
  name,
  tp,
  opt,
  const 
)
Add a member item to a list if this value is a list.
   name = the name
   tp = the member type
   opt = whether it is optional
   const = whether it should be constant.
def cpc.dataflow.active_value.ActiveValue.findListeners (   self,
  listeners,
  omitSelf = None 
)
Find all listeners on this value and all its subvalues. 
   listeners = a (usually empty) list to add listeners to
   omitSelf = an optional listener to omit.
def cpc.dataflow.active_value.ActiveValue.getListener (   self)
Get the associated listener.
def cpc.dataflow.active_value.ActiveValue.notifyListeners (   self,
  sourceTag,
  seqNr 
)
Find all listeners' destinations associated with this value and call 
   notify() on them. This in turn calls handleNewInput() on the 
   activeInstances that the acps belong to.
def cpc.dataflow.active_value.ActiveValue.propagate (   self,
  sourceTag,
  seqNr 
)
Find all listeners associated with this value and update their 
   values, calling propagate() on their associated listeners.
   
   sourceTag = a source tag that handleInput matches to check
       for input from a single source
   seqNr = a sequence number to check for updated inputs.
def cpc.dataflow.active_value.ActiveValue.setListener (   self,
  listener 
)
Set a pointer to an associated listener (usually an active 
   connection point).
def cpc.dataflow.active_value.ActiveValue.setSourceTag (   self,
  sourceTag 
)
Force the source tag to a certain value.
def cpc.dataflow.active_value.ActiveValue.update (   self,
  srcVal,
  newSeqNr,
  sourceTag = None,
  resetSourceTag = False 
)
Set a new value from a Value, and call update() on all subitems. 
   This keeps all the metadata intact.
   
   srcVal = the input value.
   newSeqNr = the new sequence number (or None to keep the old one)
   sourceTag = any source tag to apply.
def cpc.dataflow.active_value.ActiveValue.writeDebug (   self,
  outf 
)

Member Data Documentation

cpc.dataflow.active_value.ActiveValue.basetype
cpc.dataflow.active_value.ActiveValue.fileValue
cpc.dataflow.active_value.ActiveValue.listener
cpc.dataflow.active_value.ActiveValue.seqNr
cpc.dataflow.active_value.ActiveValue.sourceTag
cpc.dataflow.active_value.ActiveValue.value

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