kelsey_sandbox.perception_monitor.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 174 of file src/kelsey_sandbox/perception_monitor.py.

---

Constructor & Destructor Documentation

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

initializes the monitor but doesn't start it

Parameters:

callback	the function to be called each time
rate	the rate in seconds at which to call the callback
args	the function arguments to pass into the callback

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

---

Member Function Documentation

def kelsey_sandbox.perception_monitor.PeriodicMonitor._run

(

self

)

[private]

Definition at line 221 of file src/kelsey_sandbox/perception_monitor.py.

def kelsey_sandbox.perception_monitor.PeriodicMonitor.get_ret_vals

(

self

)

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

Definition at line 274 of file src/kelsey_sandbox/perception_monitor.py.

def kelsey_sandbox.perception_monitor.PeriodicMonitor.has_failed

(

)

Definition at line 280 of file src/kelsey_sandbox/perception_monitor.py.

def kelsey_sandbox.perception_monitor.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_calls

the maximum number of times to call the callback

Definition at line 199 of file src/kelsey_sandbox/perception_monitor.py.

def kelsey_sandbox.perception_monitor.PeriodicMonitor.stop

(

self

)

stops the monitor

Returns:

the result of the monitor

Definition at line 265 of file src/kelsey_sandbox/perception_monitor.py.

def kelsey_sandbox.perception_monitor.PeriodicMonitor.wait_for_completion

(

rate = 0.01

)

Definition at line 284 of file src/kelsey_sandbox/perception_monitor.py.

---

Member Data Documentation

kelsey_sandbox::perception_monitor.PeriodicMonitor::args

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::beg_time

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::cb

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::contincency_args

Definition at line 199 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::contingency

Definition at line 199 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::failure

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::is_running

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::max_calls

Definition at line 199 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::mean_model

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::model_index

Definition at line 199 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::num_calls

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::rate

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::ret

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::std_devs

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::thread

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

kelsey_sandbox::perception_monitor.PeriodicMonitor::variance_model

Definition at line 181 of file src/kelsey_sandbox/perception_monitor.py.

---

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

• src/kelsey_sandbox/perception_monitor.py