Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.command.platform.Platform Class Reference
Inheritance diagram for cpc.command.platform.Platform:

Public Member Functions

def addMaxResource
 
def getMaxResources
 
def getMaxResource
 
def hasMaxResource
 
def addMinResource
 
def getMinResources
 
def getMinResource
 
def hasMinResource
 
def addPrefResource
 
def getPrefResources
 
def getPrefResource
 
def hasPrefResource
 
def reserveCmdResources
 
def releaseCmdResources
 
def canReserveCmdResources
 
def addRunVar
 
def getRunVars
 
def setRunVars
 
def getName
 
def getArch
 
def isJoinPrefered
 
def callRunSet
 
def callFinishSet
 
def printXML
 
def writeXML
 

Public Attributes

 name
 
 arch
 
 preferJoin
 
 callRun
 
 callFinish
 
 maxResources
 
 minResources
 
 prefResources
 
 runvars
 

Detailed Description

The run platform with its associated capabilities.

Member Function Documentation

def cpc.command.platform.Platform.addMaxResource (   self,
  rsrc 
)
Add a single max. resource to the platform.
def cpc.command.platform.Platform.addMinResource (   self,
  rsrc 
)
Add a single min. resource to the platform.
def cpc.command.platform.Platform.addPrefResource (   self,
  rsrc 
)
Add a single pref. resource to the platform.
def cpc.command.platform.Platform.addRunVar (   self,
  name,
  value 
)
Add a single run variable to the platform.
def cpc.command.platform.Platform.callFinishSet (   self)
def cpc.command.platform.Platform.callRunSet (   self)
def cpc.command.platform.Platform.canReserveCmdResources (   self,
  cmd 
)
Check whether all of a command's reserved resources can be reserved
   with the current platform state.
   cmd = the command to check reserved resources for.
def cpc.command.platform.Platform.getArch (   self)
def cpc.command.platform.Platform.getMaxResource (   self,
  name 
)
Get a specific max. resource value or None.
def cpc.command.platform.Platform.getMaxResources (   self)
Get the list (dict) of max. resources.
def cpc.command.platform.Platform.getMinResource (   self,
  name 
)
Get a specific min. resource value or None.
def cpc.command.platform.Platform.getMinResources (   self)
Get the list (dict) of min. resources.
def cpc.command.platform.Platform.getName (   self)
def cpc.command.platform.Platform.getPrefResource (   self,
  name 
)
Get a specific pref. resource value or None.
def cpc.command.platform.Platform.getPrefResources (   self)
Get the list (dict) of pref. resources.
def cpc.command.platform.Platform.getRunVars (   self)
Return the runvars object.
def cpc.command.platform.Platform.hasMaxResource (   self,
  name 
)
Check whether a specific max. resource has been set for 
   this platform.
def cpc.command.platform.Platform.hasMinResource (   self,
  name 
)
Check whether a specific min. resource has been set for this 
   platform.
def cpc.command.platform.Platform.hasPrefResource (   self,
  name 
)
Check whether a specific pref. resource has been set for 
   this platform.
def cpc.command.platform.Platform.isJoinPrefered (   self)
def cpc.command.platform.Platform.printXML (   self)
def cpc.command.platform.Platform.releaseCmdResources (   self,
  cmd 
)
Add a command's reservations from this platform's max.
   resources. 
   Changes the available resources to reflect the release of 
   that command's reserved resources.
   cmd = the command
def cpc.command.platform.Platform.reserveCmdResources (   self,
  cmd 
)
Subtract a command's reservations from this platform's max.
   resources. 
   Changes the available resources to reflect the reservation of 
   that command's reserved resources.
   cmd = the command
def cpc.command.platform.Platform.setRunVars (   self,
  runvars 
)
Set a new runvars object.
def cpc.command.platform.Platform.writeXML (   self,
  outf 
)

Member Data Documentation

cpc.command.platform.Platform.arch
cpc.command.platform.Platform.callFinish
cpc.command.platform.Platform.callRun
cpc.command.platform.Platform.maxResources
cpc.command.platform.Platform.minResources
cpc.command.platform.Platform.name
cpc.command.platform.Platform.preferJoin
cpc.command.platform.Platform.prefResources
cpc.command.platform.Platform.runvars

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