Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.project.Project Class Reference
Inheritance diagram for cpc.dataflow.project.Project:

Public Member Functions

def getName
 
def getBasedir
 
def getNewInputSubDir
 
def getFileList
 
def getTopLevelLib
 
def getFunction
 
def addFunction
 
def getImportList
 
def getNamedValue
 
def scheduleSet
 
def scheduleConnect
 
def beginTransaction
 
def commit
 
def rollback
 
def getNamedInstance
 
def getNamedItemList
 
def getNamedDescription
 
def getDebugInfo
 
def getGraph
 
def addInstance
 
def importTopLevelFile
 
def importName
 
def getAllTasks
 
def cancel
 
def activate
 
def deactivate
 
def rerun
 
def getQueue
 
def writeXML
 
def writeXMLPointer
 
def readState
 
def writeState
 
def getSubValue
 
def getCreateSubValue
 
def getClosestSubValue
 
def getSubValueList
 
def getSubValueIterList
 
def hasSubValue
 
def getType
 
def getDesc
 

Public Attributes

 updateLock
 
 conf
 
 name
 
 basedir
 
 queue
 
 cmdQueue
 
 fileList
 
 network
 
 topLevelImport
 
 functions
 
 imports
 
 inputDir
 
 inputNr
 
 transactionStackLock
 
 transactionStack
 

Detailed Description

The top-level class describing a running function network together
   with all function definitions. 

Member Function Documentation

def cpc.dataflow.project.Project.activate (   self,
  pathname 
)
Activate all active instances.
def cpc.dataflow.project.Project.addFunction (   self,
  function 
)
Add a function to the project.
def cpc.dataflow.project.Project.addInstance (   self,
  name,
  functionName 
)
Add an instance with a name and function name to the top-level
   network.
def cpc.dataflow.project.Project.beginTransaction (   self,
  outf 
)
Create a new transaction list.
def cpc.dataflow.project.Project.cancel (   self)
Delete all queued commands.
def cpc.dataflow.project.Project.commit (   self,
  outf 
)
Commit a set of changes scheduled with scheduleSet()
def cpc.dataflow.project.Project.deactivate (   self,
  pathname 
)
De-activate all active instances contained in pathname (or 
   everything if pathname is empty).
def cpc.dataflow.project.Project.getAllTasks (   self)
Get a list of all tasks to queue for execution.
def cpc.dataflow.project.Project.getBasedir (   self)
Return the base directory. This is a const property
def cpc.dataflow.project.Project.getClosestSubValue (   self,
  itemList 
)
Get the closest relevant subvalue through a list of subitems, 
   
   itemList = the path of the value to get the closest value for 
def cpc.dataflow.project.Project.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 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.project.Project.getDebugInfo (   self,
  itemname 
)
Give debug info about a particular item.
def cpc.dataflow.project.Project.getDesc (   self)
Return a 'description' of a value: an item that can be passed to 
   the client describing the value.
def cpc.dataflow.project.Project.getFileList (   self)
Get the project's file list. This pointer is a const property, 
   and the file list has its own locking mechanism.
def cpc.dataflow.project.Project.getFunction (   self,
  fname 
)
Return the function object associated with a name.
def cpc.dataflow.project.Project.getGraph (   self,
  pathname 
)
Get an graph description based on a path name according to the rule
   [instance]:[instance].
def cpc.dataflow.project.Project.getImportList (   self)
Get the function import list.
def cpc.dataflow.project.Project.getName (   self)
Return the project name. This is a const property
def cpc.dataflow.project.Project.getNamedDescription (   self,
  pathname 
)
Get a description of a named function/type/lib
def cpc.dataflow.project.Project.getNamedInstance (   self,
  instname 
)
def cpc.dataflow.project.Project.getNamedItemList (   self,
  pathname 
)
Get an list based on a path name according to the rule
   [instance]:[instance]
def cpc.dataflow.project.Project.getNamedValue (   self,
  itemname 
)
Get a value for a specific name according to the rule
   [instance]:[instance].[ioitem].
def cpc.dataflow.project.Project.getNewInputSubDir (   self)
Return the name of a new input subdir to store new externally 
   set input files in.  NOTE: it won't be created.
def cpc.dataflow.project.Project.getQueue (   self)
Get the task queue.
def cpc.dataflow.project.Project.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.project.Project.getSubValueIterList (   self)
Return an iterable list of addressable subvalues.
def cpc.dataflow.project.Project.getSubValueList (   self)
Return a list of addressable subvalues.
def cpc.dataflow.project.Project.getTopLevelLib (   self)
Get the top-level import library
def cpc.dataflow.project.Project.getType (   self)
Return the type associated with this value
def cpc.dataflow.project.Project.hasSubValue (   self,
  itemList 
)
Check whether a particular subvalue exists
def cpc.dataflow.project.Project.importName (   self,
  name 
)
Import a named module.
def cpc.dataflow.project.Project.importTopLevelFile (   self,
  fileObject,
  filename 
)
Read a source file as a top-level description.
def cpc.dataflow.project.Project.readState (   self,
  stateFile = "_state.xml" 
)
def cpc.dataflow.project.Project.rerun (   self,
  pathname,
  recursive,
  clearError,
  outf 
)
Re-run and optionally clear an error on an item.
def cpc.dataflow.project.Project.rollback (   self,
  outf 
)
Cancel a transaction.
def cpc.dataflow.project.Project.scheduleConnect (   self,
  src,
  dst,
  outf 
)
Add an instance of a connect in the transaction schedule.
def cpc.dataflow.project.Project.scheduleSet (   self,
  itemname,
  literal,
  outf,
  sourceType = None,
  printName = None 
)
Add an instance of a set in the transaction schedule.
def cpc.dataflow.project.Project.writeState (   self)
def cpc.dataflow.project.Project.writeXML (   self,
  outf,
  indent = 0 
)
Write the function definitions and top-level network description 
   in XML to outf.
def cpc.dataflow.project.Project.writeXMLPointer (   self,
  outFile 
)
Write a short pointer to where information can be found to an
   XML file.

Member Data Documentation

cpc.dataflow.project.Project.basedir
cpc.dataflow.project.Project.cmdQueue
cpc.dataflow.project.Project.conf
cpc.dataflow.project.Project.fileList
cpc.dataflow.project.Project.functions
cpc.dataflow.project.Project.imports
cpc.dataflow.project.Project.inputDir
cpc.dataflow.project.Project.inputNr
cpc.dataflow.project.Project.name
cpc.dataflow.project.Project.network
cpc.dataflow.project.Project.queue
cpc.dataflow.project.Project.topLevelImport
cpc.dataflow.project.Project.transactionStack
cpc.dataflow.project.Project.transactionStackLock
cpc.dataflow.project.Project.updateLock

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