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

Public Member Functions

def writeXML
 
def setExecutable
 
def check
 
def run
 

Public Attributes

 controllerExec
 
 basedir
 
 outputDirWithoutFiles
 
 fullpath
 
 stateMsg
 
 state
 
- Public Attributes inherited from cpc.dataflow.atomic.AtomicFunction
 genTasks
 
- Public Attributes inherited from cpc.dataflow.network_function.NetworkedFunction
 network
 
 selfInstance
 
- Public Attributes inherited from cpc.dataflow.function.Function
 name
 
 inputs
 
 outputs
 
 subnetInputs
 
 subnetOutputs
 
 genTasks
 
 log
 
 outputDirWithoutFiles
 
 persistentDir
 
 taskAccessOutputs
 
 taskAccessSubnetOutputs
 
 state
 
 stateMsg
 
 lib
 
- Public Attributes inherited from cpc.dataflow.description.Describable
 desc
 

Additional Inherited Members

- Static Public Attributes inherited from cpc.dataflow.function.Function
tuple ok = FunctionState("ok")
 
tuple error = FunctionState("error")
 

Detailed Description

A function that has a controller that is an external command that
   can be called directly. The communication happens through XML 
   to stdin, and reading XML from stdout.

Member Function Documentation

def cpc.dataflow.external.ExternalFunction.check (   self)
Perform a check on whether the function can run and set
   the state to reflect this. In this case, run the function 
   without inputs, and check whether the externa command runs with
   return code 0.
def cpc.dataflow.external.ExternalFunction.run (   self,
  inp 
)
def cpc.dataflow.external.ExternalFunction.setExecutable (   self,
  controllerExec 
)
Set the controller executable for this function.
def cpc.dataflow.external.ExternalFunction.writeXML (   self,
  outFile,
  indent = 0 
)
The function itself does not need to be described.

Member Data Documentation

cpc.dataflow.external.ExternalFunction.basedir
cpc.dataflow.external.ExternalFunction.controllerExec
cpc.dataflow.external.ExternalFunction.fullpath
cpc.dataflow.external.ExternalFunction.outputDirWithoutFiles
cpc.dataflow.external.ExternalFunction.state
cpc.dataflow.external.ExternalFunction.stateMsg

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