diagnostic_updater._update_functions.FrequencyStatus Class Reference

Inheritance diagram for diagnostic_updater._update_functions.FrequencyStatus:

List of all members.

Public Member Functions
def	__init__
def	clear
def	run
def	tick
Public Attributes
	count
	hist_indx
	lock
	params
	seq_nums
	times

---

Detailed Description

A diagnostic task that monitors the frequency of an event.

This diagnostic task monitors the frequency of calls to its tick method,
and creates corresponding diagnostics. It will report a warning if the
frequency is outside acceptable bounds, and report an error if there have
been no events in the latest window.

Definition at line 70 of file _update_functions.py.

---

Constructor & Destructor Documentation

def diagnostic_updater._update_functions.FrequencyStatus.__init__	(		self,
			params,
			name = "FrequencyStatus"
	)

Constructs a FrequencyStatus class with the given parameters.

Definition at line 79 of file _update_functions.py.

---

Member Function Documentation

def diagnostic_updater._update_functions.FrequencyStatus.clear

(

self

)

Resets the statistics.

Definition at line 86 of file _update_functions.py.

def diagnostic_updater._update_functions.FrequencyStatus.run	(		self,
			stat
	)

Definition at line 100 of file _update_functions.py.

def diagnostic_updater._update_functions.FrequencyStatus.tick

(

self

)

Signals that an event has occurred.

Definition at line 95 of file _update_functions.py.

---

Member Data Documentation

diagnostic_updater::_update_functions.FrequencyStatus::count

Definition at line 86 of file _update_functions.py.

diagnostic_updater::_update_functions.FrequencyStatus::hist_indx

Definition at line 86 of file _update_functions.py.

diagnostic_updater::_update_functions.FrequencyStatus::lock

Definition at line 79 of file _update_functions.py.

diagnostic_updater::_update_functions.FrequencyStatus::params

Definition at line 79 of file _update_functions.py.

diagnostic_updater::_update_functions.FrequencyStatus::seq_nums

Definition at line 86 of file _update_functions.py.

diagnostic_updater::_update_functions.FrequencyStatus::times

Definition at line 86 of file _update_functions.py.

---

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

• _update_functions.py