Package ZenModel :: Module ThresholdInstance :: Class ThresholdInstance
[hide private]
[frames] | no frames]

Class ThresholdInstance

source code

 twisted.spread.jelly.Jellyable --+        
                                  |        
twisted.spread.flavors.Serializable --+    
                                      |    
        twisted.spread.flavors.Copyable --+
                                          |
   twisted.spread.jelly.Unjellyable --+   |
                                      |   |
      twisted.spread.flavors.RemoteCopy --+
                                          |
                                         ThresholdInstance
Known Subclasses:
MinMaxThreshold.MinMaxThresholdInstance

A ThresholdInstance is a threshold to be evaluated in a collector within a given context.

Instance Methods [hide private]
 
name(self)
return the name of this threshold (from the ThresholdClass)
source code
 
context(self)
Return the ThresholdContext for this ThresholdInstance
source code
 
key(self)
Unique data that refers to this object within a collector
source code
 
dataPoints(self)
Returns the names of the datapoints used to compute the threshold
source code
 
check(self, dataPoints)
The given datapoints have been updated, so re-evaluate.
source code
 
checkRaw(self, dataPoint, timeOf, value)
A new datapoint has been collected, use the given _raw_ value to re-evalue the threshold.
source code
 
getGraphElements(self, template, gopts, namespace, color)
Produce a visual indication on the graph of where the threshold applies.
source code

Inherited from twisted.spread.flavors.Copyable: getStateToCopy, getStateToCopyFor, getTypeToCopy, getTypeToCopyFor, jellyFor

Inherited from twisted.spread.flavors.Serializable: processUniqueID

Inherited from twisted.spread.jelly.Jellyable: __providedBy__, getStateFor

Inherited from twisted.spread.flavors.RemoteCopy: setCopyableState, unjellyFor

Inherited from twisted.spread.jelly.Unjellyable: setStateFor

Class Variables [hide private]
  count = None

Inherited from twisted.spread.flavors.Serializable: __implemented__, __provides__

Method Details [hide private]

check(self, dataPoints)

source code 
The given datapoints have been updated, so re-evaluate. returns events or an empty sequence

checkRaw(self, dataPoint, timeOf, value)

source code 
A new datapoint has been collected, use the given _raw_ value to re-evalue the threshold. returns a sequence of events.