Editor Class Reference

Editor class manages multiple reporters and curates information going to the output channel based on reporter commentary. More...

Public Member Functions
def	__init__ (self, theChannel, theConfig=CfgReporter())
	Constructor to Editor class. More...
def	addBeat (self, beatReporter, beatRevisor=None, assignID=None)
	Add a new BeatReporter to manage and potentially provide a news desk assignment ID (default is true for this last part). More...
def	assignGroup (self, theGroup, theRevisor=None, assignIDs=None)
	Assign a group of BeatReporters to the Editor. More...
def	incoming (self, assignID, theReport)
	There is an incoming output from a BeatReporter. More...
def	remBeat (self, assignID)
	Remove BeatReporter based on provided assignment ID. More...

Public Attributes
	channel
	Final output channel for all reports. More...
	config
	Configuration of Editor. More...
	reporters
	List of BeatReporters to manage (replaces role of Triggers). More...
	revisions
	List of Revision filters for BeatReporter Commentary (optional). More...

Detailed Description

Editor class manages multiple reporters and curates information going to the output channel based on reporter commentary.

An Editor manages multiple reporters that are given "assignments" in that they receive specific signals, have their own triggers, and respond to the associated signals in their own ways. An Editor collects the reporter outputs and determines when to publish (or report out) and in what order. We call the Editor level receipt of activity as the the Editor's "news desk." The Editor's collects the information and its channel does the reporting through a output generating channel.

Typically the Editor will have a set of BeatReporters that are responsible for creating specific reporting output. All of their streams are integrated into a single output stream (or channel).

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			theChannel,
			theConfig = CfgReporter()
	)

Constructor to Editor class.

Collects necessary pieces.

The constructor is not as rich as the Reporter because it maintains a list of Reporters that contain the necessary action responses to events. The Editor simply manages the responses from BeatReporters and submits the output to its own channel, which is given here in the constructor.

The base design will operate a lot like a standard logging system whereby all Reporters will simply output through the same channel. In principle, managing this way is not needed since multiple independent reporters can simply share a channel and operate that way. For more specialized operation, use sub-classes and override the default operation.

Parameters

[in]	theChannel	Channel instance.
[in]	theConfig	Configuration specifications.

Member Function Documentation

addBeat()

def addBeat	(		self,
			beatReporter,
			beatRevisor = None,
			assignID = None
	)

Add a new BeatReporter to manage and potentially provide a news desk assignment ID (default is true for this last part).

Parameters

[in]	beatReporter	Tell editor to manage new beat reporter.
[in]	beatRevisor	To revise reporters commentary output, if needed.
[in]	assignID	Assignment ID. If not given, automatically done.

assignGroup()

def assignGroup	(		self,
			theGroup,
			theRevisor = None,
			assignIDs = None
	)

Assign a group of BeatReporters to the Editor.

incoming()

def incoming	(		self,
			assignID,
			theReport
	)

There is an incoming output from a BeatReporter.

Process based on assignment ID.

The default Editor simply has a bunch of BeatReporters and gives them IDs according to order attached to the Editor. This gives placement in the list.

If more specialized processing with interactions between BeatReporters is needed, then this Editor class should be overloaded so that assigment conditional output and assigment coordinated output may be implemented. Or so that assignment ID involves a lookup to be unbound from ordering.

Parameters

[in]	assignID	Assignment ID
[in]	theReport	Report generated by the BeatReporter.

remBeat()

def remBeat	(		self,
			assignID
	)

Remove BeatReporter based on provided assignment ID.

If the assignment ID is non-sensical (out of bounds), then the request is ignored. Currently no indication is provided for this outcome.

The default version of the Editor maintains a list of BeatReporters whose assignment IDs match their placement in the list. Removing a beat reshuffles the list and triggers updated assignment IDs. If outer processing requires static IDs, then this class needs to be overloaded. Or, it might be better for outer scope to use the Reporter handle. That might be problematic if the outer scope is not privy to assignment status. Should query BeatReporter to know if it is on assignment.

Parameters

[in]

assignID

Assignment ID of reporter.

Member Data Documentation

channel

channel

Final output channel for all reports.

config

config

Configuration of Editor.

reporters

reporters

List of BeatReporters to manage (replaces role of Triggers).

revisions

revisions

List of Revision filters for BeatReporter Commentary (optional).

---

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

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