Copernicus  2.0
 All Classes Namespaces Files Functions Variables
cpc.dataflow.msg.ActiveInstanceMsg Class Reference
Inheritance diagram for cpc.dataflow.msg.ActiveInstanceMsg:
cpc.dataflow.value.ValueBase

Public Member Functions

def getLog
 
def setError
 
def getError
 
def hasError
 
def setWarning
 
def getWarning
 
def hasWarning
 
def getSubValue
 
def getCreateSubValue
 
def getClosestSubValue
 
def getSubValueList
 
def getSubValueIterList
 
def hasSubValue
 
def getType
 
def getDesc
 
- Public Member Functions inherited from cpc.dataflow.value.ValueBase
def getSubValue
 
def getCreateSubValue
 
def getClosestSubValue
 
def getSubValueList
 
def getSubValueIterList
 
def hasSubValue
 
def getType
 
def getDesc
 

Public Attributes

 logVal
 
 log
 
 warning
 
 error
 
 subvals
 

Detailed Description

The active instance message object is a value that holds the
   messages associated with an active instance: errors, warnings and
   logs. It is accessible through cpcc get <active_inst_path>.msg

Member Function Documentation

def cpc.dataflow.msg.ActiveInstanceMsg.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.msg.ActiveInstanceMsg.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.msg.ActiveInstanceMsg.getDesc (   self)
Return a 'description' of a value: an item that can be passed to
   the client describing the value.
def cpc.dataflow.msg.ActiveInstanceMsg.getError (   self)
Get the error message
def cpc.dataflow.msg.ActiveInstanceMsg.getLog (   self)
def cpc.dataflow.msg.ActiveInstanceMsg.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.msg.ActiveInstanceMsg.getSubValueIterList (   self)
Return an iterable list of addressable subvalues.
def cpc.dataflow.msg.ActiveInstanceMsg.getSubValueList (   self)
Return a list of addressable subvalues.
def cpc.dataflow.msg.ActiveInstanceMsg.getType (   self)
Return the type associated with this value
def cpc.dataflow.msg.ActiveInstanceMsg.getWarning (   self)
Get the error message
def cpc.dataflow.msg.ActiveInstanceMsg.hasError (   self)
Check whether there is an error message.
def cpc.dataflow.msg.ActiveInstanceMsg.hasSubValue (   self,
  itemList 
)
Check whether a particular subvalue exists
def cpc.dataflow.msg.ActiveInstanceMsg.hasWarning (   self)
Check whether there is a warning message.
def cpc.dataflow.msg.ActiveInstanceMsg.setError (   self,
  msg 
)
Set the error message to None, or a string/unicode
def cpc.dataflow.msg.ActiveInstanceMsg.setWarning (   self,
  msg 
)
Set the warning message to None, or a string/unicode

Member Data Documentation

cpc.dataflow.msg.ActiveInstanceMsg.error
cpc.dataflow.msg.ActiveInstanceMsg.log
cpc.dataflow.msg.ActiveInstanceMsg.logVal
cpc.dataflow.msg.ActiveInstanceMsg.subvals
cpc.dataflow.msg.ActiveInstanceMsg.warning

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