Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.function.Function Class Reference
Inheritance diagram for cpc.dataflow.function.Function:
cpc.dataflow.description.Describable cpc.dataflow.network_function.NetworkedFunction cpc.dataflow.network_function.SelfFunction cpc.dataflow.atomic.AtomicFunction cpc.dataflow.network_function.NetworkFunction cpc.dataflow.atomic.SimpleFunctionFunction cpc.dataflow.external.ExternalFunction cpc.dataflow.atomic.ExtendedFunctionFunction

Public Member Functions

def getName
 
def getFullName
 
def setLib
 
def getLib
 
def getState
 
def hasLog
 
def setLog
 
def accessOutputs
 
def accessSubnetOutputs
 
def setAccessOutputs
 
def setAccessSubnetOutputs
 
def getStateMsg
 
def check
 
def setOutputDirWithoutFiles
 
def getInputs
 
def getOutputs
 
def getSubnetInputs
 
def getSubnetOutputs
 
def getSubnet
 
def outputDirNeeded
 
def setPersistentDir
 
def persistentDirNeeded
 
def writeXML
 
def run
 
- Public Member Functions inherited from cpc.dataflow.description.Describable
def setDescription
 
def getDescription
 

Public Attributes

 name
 
 inputs
 
 outputs
 
 subnetInputs
 
 subnetOutputs
 
 genTasks
 
 log
 
 outputDirWithoutFiles
 
 persistentDir
 
 taskAccessOutputs
 
 taskAccessSubnetOutputs
 
 state
 
 stateMsg
 
 lib
 
- Public Attributes inherited from cpc.dataflow.description.Describable
 desc
 

Static Public Attributes

tuple ok = FunctionState("ok")
 
tuple error = FunctionState("error")
 

Detailed Description

The class describing a function. A function is a single 
   computational unit in a dataflow network. It can consist of either 
   a controller with input and output definitions, or of a function graph.

Member Function Documentation

def cpc.dataflow.function.Function.accessOutputs (   self)
Return whether we want to give the current outputs to tasks
def cpc.dataflow.function.Function.accessSubnetOutputs (   self)
Return whether we want to give the current outputs to tasks
def cpc.dataflow.function.Function.check (   self)
Perform a check on whether the function can run and set
   the state to reflect this.
def cpc.dataflow.function.Function.getFullName (   self)
Return the function's full name.
def cpc.dataflow.function.Function.getInputs (   self)
Get a the type of all inputs.
def cpc.dataflow.function.Function.getLib (   self)
Get the function's library.
def cpc.dataflow.function.Function.getName (   self)
Returns the function's name.
def cpc.dataflow.function.Function.getOutputs (   self)
Get a the type of all outputs.
def cpc.dataflow.function.Function.getState (   self)
Get the state of the function.
def cpc.dataflow.function.Function.getStateMsg (   self)
Get the state message (in case of error) of the function.
def cpc.dataflow.function.Function.getSubnet (   self)
Return a subnetwork associated with this function, or None.
def cpc.dataflow.function.Function.getSubnetInputs (   self)
Get a the type of all subnet inputs.
def cpc.dataflow.function.Function.getSubnetOutputs (   self)
Get a the type of all subnet outputs.
def cpc.dataflow.function.Function.hasLog (   self)
Return whether this function has a log.
def cpc.dataflow.function.Function.outputDirNeeded (   self)
Returns  whether an output directory is needed.
def cpc.dataflow.function.Function.persistentDirNeeded (   self)
Return whether a persistance scratch storage directory is needed.
def cpc.dataflow.function.Function.run (   self,
  fnInput 
)
Run a function. Return a dict of outputs as Value objects, a 
   command to be queued, or None.
  
   fnInput = a run.FunctionRunInput object. 

   fnInput contains the functionRunOutput object that must be
   filled with output data
def cpc.dataflow.function.Function.setAccessOutputs (   self,
  use 
)
Set whether we want to give the current outputs to tasks
def cpc.dataflow.function.Function.setAccessSubnetOutputs (   self,
  use 
)
Set whether we want to give the current outputs to tasks
def cpc.dataflow.function.Function.setLib (   self,
  lib 
)
Set the function's library.
def cpc.dataflow.function.Function.setLog (   self,
  log 
)
Set whether this function has a log.
def cpc.dataflow.function.Function.setOutputDirWithoutFiles (   self,
  val 
)
Set whether there should be a run directory even if there's no
   output files.

   val =  a boolean
def cpc.dataflow.function.Function.setPersistentDir (   self,
  val 
)
Set whether a persistent scratch dir is needed.
def cpc.dataflow.function.Function.writeXML (   self,
  outFile,
  indent = 0 
)
Describe the fucntion in XML.

Member Data Documentation

tuple cpc.dataflow.function.Function.error = FunctionState("error")
static
cpc.dataflow.function.Function.genTasks
cpc.dataflow.function.Function.inputs
cpc.dataflow.function.Function.lib
cpc.dataflow.function.Function.log
cpc.dataflow.function.Function.name
tuple cpc.dataflow.function.Function.ok = FunctionState("ok")
static
cpc.dataflow.function.Function.outputDirWithoutFiles
cpc.dataflow.function.Function.outputs
cpc.dataflow.function.Function.persistentDir
cpc.dataflow.function.Function.state
cpc.dataflow.function.Function.stateMsg
cpc.dataflow.function.Function.subnetInputs
cpc.dataflow.function.Function.subnetOutputs
cpc.dataflow.function.Function.taskAccessOutputs
cpc.dataflow.function.Function.taskAccessSubnetOutputs

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