Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.run.FunctionRunOutput Class Reference
Inheritance diagram for cpc.dataflow.run.FunctionRunOutput:
cpc.dataflow.transaction.Transaction

Public Member Functions

def setOut
 
def setSubOut
 
def hasOutputs
 
def hasSubnetOutputs
 
def addInstance
 
def addConnection
 
def addCommand
 
def setError
 
def setWarning
 
def cancelPrevCommands
 
def writeXML
 

Public Attributes

 outputs
 
 subnetOutputs
 
 cmds
 
 newInstances
 
 newConnections
 
 cancelCmds
 
 errMsg
 
 warnMsg
 

Detailed Description

A class holding the output of a function's run method.
   
   Its readable and directly manipulable member variables are:
   - outputs (a list of OutputItem objects)
   - subnetOutputs (a list of OutputItem objects)
   - cmds (a list of Commands)
   - newInstances (a list of NewInstances)
   - newConnections (a list of NewConnections)

Member Function Documentation

def cpc.dataflow.run.FunctionRunOutput.addCommand (   self,
  cmd 
)
Add a command to the list.
    cmd = the command object
def cpc.dataflow.run.FunctionRunOutput.addConnection (   self,
  srcStr,
  dstStr,
  val = None 
)
Add a new subnet connection to the list.
    srcStr = the source as instance:out.item
    dstStr = the destination as instance:in.item
    val  = optional value instead of source
def cpc.dataflow.run.FunctionRunOutput.addInstance (   self,
  instanceName,
  functionName 
)
Add a new subnet function instance to the list.
    instanceName  = the new instance's name
    functionName  = the new instance's function name
def cpc.dataflow.run.FunctionRunOutput.cancelPrevCommands (   self)
Cancel any previous commands.
def cpc.dataflow.run.FunctionRunOutput.hasOutputs (   self)
Check whether there are outputs.
def cpc.dataflow.run.FunctionRunOutput.hasSubnetOutputs (   self)
Check whether there are subnet outputs.
def cpc.dataflow.run.FunctionRunOutput.setError (   self,
  msg 
)
Set an error leading to an error state, or
   clear an error previously set during this run if msg=None. 
def cpc.dataflow.run.FunctionRunOutput.setOut (   self,
  ioitem,
  outval 
)
Add a specified output value.
    ioitem = the full output specifier 
    outval = an OutValue (OutValue object) 
def cpc.dataflow.run.FunctionRunOutput.setSubOut (   self,
  ioitem,
  outval 
)
Set a specified subnet output value.
    name = the output name
    outval = the output value (OutValue object) 
def cpc.dataflow.run.FunctionRunOutput.setWarning (   self,
  msg 
)
Set a warning message leading to a warning state, or
   clear a warning previously set during this run if msg=None. 
def cpc.dataflow.run.FunctionRunOutput.writeXML (   self,
  outf,
  indent = 0 
)
Write the contents of this object in XML form to a file.

Member Data Documentation

cpc.dataflow.run.FunctionRunOutput.cancelCmds
cpc.dataflow.run.FunctionRunOutput.cmds
cpc.dataflow.run.FunctionRunOutput.errMsg
cpc.dataflow.run.FunctionRunOutput.newConnections
cpc.dataflow.run.FunctionRunOutput.newInstances
cpc.dataflow.run.FunctionRunOutput.outputs
cpc.dataflow.run.FunctionRunOutput.subnetOutputs
cpc.dataflow.run.FunctionRunOutput.warnMsg

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