Public Member Functions | Public Attributes | Private Member Functions
kelsey_sandbox.periodic_funs.PeriodicMonitor Class Reference

Periodically monitors the output of a callback function by calling it at a certain rate and compares it with a provided model to insure the value doesn't vary greatly within a degree of tolerance provided by the variance function. More...

List of all members.

Public Member Functions

def __init__
 initializes the monitor but doesn't start it
def get_ret_vals
 If max_calls sets to automatically terminate, return the ret vals.
def has_failed
def start
 begins the monitor TODO DOCS
def stop
 stops the monitor
def wait_for_completion

Public Attributes

 args
 beg_time
 cb
 contincency_args
 contingency
 failure
 is_running
 max_calls
 mean_model
 model_index
 num_calls
 rate
 ret
 std_devs
 thread
 variance_model

Private Member Functions

def _run

Detailed Description

Periodically monitors the output of a callback function by calling it at a certain rate and compares it with a provided model to insure the value doesn't vary greatly within a degree of tolerance provided by the variance function.

Definition at line 78 of file periodic_funs.py.


Constructor & Destructor Documentation

def kelsey_sandbox.periodic_funs.PeriodicMonitor.__init__ (   self,
  callback,
  rate = 0.01,
  args = None 
)

initializes the monitor but doesn't start it

Parameters:
callbackthe function to be called each time
ratethe rate in seconds at which to call the callback
argsthe function arguments to pass into the callback

Definition at line 85 of file periodic_funs.py.


Member Function Documentation

Definition at line 125 of file periodic_funs.py.

If max_calls sets to automatically terminate, return the ret vals.

Definition at line 178 of file periodic_funs.py.

Definition at line 184 of file periodic_funs.py.

def kelsey_sandbox.periodic_funs.PeriodicMonitor.start (   self,
  mean_model,
  variance_model,
  std_devs = 2.5,
  max_calls = None,
  contingency = None,
  contingency_args = None 
)

begins the monitor TODO DOCS

Parameters:
max_callsthe maximum number of times to call the callback

Definition at line 103 of file periodic_funs.py.

stops the monitor

Returns:
the result of the monitor

Definition at line 169 of file periodic_funs.py.

Definition at line 188 of file periodic_funs.py.


Member Data Documentation

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 103 of file periodic_funs.py.

Definition at line 103 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 103 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 103 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.

Definition at line 85 of file periodic_funs.py.


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


kelsey_sandbox
Author(s): kelsey
autogenerated on Wed Nov 27 2013 11:52:04