diagnostic_updater._update_functions.TimeStampStatus Class Reference

Inheritance diagram for diagnostic_updater._update_functions.TimeStampStatus:

Public Member Functions
def	__init__ (self, params=TimeStampStatusParam(), name="Timestamp Status")
def	run (self, stat)
def	tick (self, stamp)
Public Member Functions inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
def	__init__ (self, name)
def	getName (self)

Public Attributes
	deltas_valid
	early_count
	late_count
	lock
	max_delta
	min_delta
	params
	zero_count
	zero_seen
Public Attributes inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
	name

Detailed Description

Diagnostic task to monitor the interval between events.

This diagnostic task monitors the difference between consecutive events,
and creates corresponding diagnostics. An error occurs if the interval
between consecutive events is too large or too small. An error condition
will only be reported during a single diagnostic report unless it
persists. Tallies of errors are also maintained to keep track of errors
in a more persistent way.

Definition at line 167 of file _update_functions.py.

Constructor & Destructor Documentation

__init__()

def diagnostic_updater._update_functions.TimeStampStatus.__init__	(		self,
			params = TimeStampStatusParam(),
			name = "Timestamp Status"
	)

Constructs the :class:`TimeStampStatus` with the given parameters.

:param TimeStampStatus params: parameters of the diagnostic task.
:param str name: name of the diagnostic task.

Definition at line 178 of file _update_functions.py.

Member Function Documentation

run()

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

Fills out this Task's :class:`DiagnosticStatusWrapper`.

:param DiagnosticStatusWrapper stat: the :class:`DiagnosticStatusWrapper` to fill
:return: the filled :class:`DiagnosticStatusWrapper`
:rtype: DiagnosticStatusWrapper

Reimplemented from diagnostic_updater._diagnostic_updater.DiagnosticTask.

Definition at line 215 of file _update_functions.py.

tick()

def diagnostic_updater._update_functions.TimeStampStatus.tick	(		self,
			stamp
	)

Signals an event.

:param stamp: The timestamp of the event that will be used in computing intervals.
:type stamp: float or rospy.Time.

Definition at line 195 of file _update_functions.py.

Member Data Documentation

deltas_valid

diagnostic_updater._update_functions.TimeStampStatus.deltas_valid

Definition at line 193 of file _update_functions.py.

early_count

diagnostic_updater._update_functions.TimeStampStatus.early_count

Definition at line 187 of file _update_functions.py.

late_count

diagnostic_updater._update_functions.TimeStampStatus.late_count

Definition at line 188 of file _update_functions.py.

lock

diagnostic_updater._update_functions.TimeStampStatus.lock

Definition at line 186 of file _update_functions.py.

max_delta

diagnostic_updater._update_functions.TimeStampStatus.max_delta

Definition at line 191 of file _update_functions.py.

min_delta

diagnostic_updater._update_functions.TimeStampStatus.min_delta

Definition at line 192 of file _update_functions.py.

params

diagnostic_updater._update_functions.TimeStampStatus.params

Definition at line 185 of file _update_functions.py.

zero_count

diagnostic_updater._update_functions.TimeStampStatus.zero_count

Definition at line 189 of file _update_functions.py.

zero_seen

diagnostic_updater._update_functions.TimeStampStatus.zero_seen

Definition at line 190 of file _update_functions.py.

---

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

• _update_functions.py