Reporter Class Reference

Base/abstract reporter class. More...

Inheritance diagram for Reporter:

Public Member Functions
def	__init__ (self, theTrigger, theAnnouncer, theChannel, theConfig=None)
	Constructor to reporter class. More...
def	process (self, theSignal)
	Process incoming signal and report as specified. More...

Public Attributes
	announcer
	channel
	config
	trigger

Detailed Description

Base/abstract reporter class.

A Reporter consists of a Trigger, an Announcer, and a Channel for a given state stream. The Trigger uses state/signal history–or possible other externally derived states–to establish when to "announce" a given piece of information. The Announcer then constructs the necessary announcement to then be piped through the proper Channel.

It is like a more flexible logging system with some of its structural elements. For example, the python logging API has loggers, handlers, filters, and formatters. Their analogs are reporters, channels, and triggers, with announcers being somewhat distinct. Based on intended use, a reporter is not the same as a logger. First, the information given is not necessarily a string. Second, specific meta-data that normally gets output by the logger may not apply here and other meta-data may be of interest. The caller will usually have created the reporter to use as needed, as opposed to being generally used by all code. Also, a logger is called when logging needed. Here, a reporter gets called all the time with updated state information. It decides (based on the trigger) when to report and how (based on the announcer).

A reporter manages the higher level flow that goes from state information to output. This way programming can go from debug type outputs to highly structured output that supports analysis. It can even be that the output is to a stream, thereby serving as input to some other process. Such a case could hold for ROS topic/message output types.

All of the core implementations are overloadable through derived classes. Some generic versions are available.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			theTrigger,
			theAnnouncer,
			theChannel,
			theConfig = None
	)

Constructor to reporter class.

Collects necessary pieces.

Parameters

[in]	theTrigger	Trigger instance.
[in]	theAnnouncer	Announcer instance.
[in]	theChannel	Channel instance.
[in]	theConfig	Configuration specifications.

Reimplemented in BeatReporter.

Member Function Documentation

process()

def process	(		self,
			theSignal
	)

Process incoming signal and report as specified.

Parameters

[in]

theSignal

Signal to process for reporting.

Returns

Passes back trigger outcome, in case helpful.

Reimplemented in BeatReporter.

Member Data Documentation

announcer

announcer

channel

channel

config

config

trigger

trigger

---

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

• /home/pvela/python/perceiver/perceiver/reporting.py