Specialized reporter class that works with an editor. More...

Inheritance diagram for BeatReporter:

Collaboration diagram for BeatReporter:

Public Member Functions
def	__init__ (self, theTrigger, theAnnouncer, theChannel=None, theConfig=None)
	Constructor to BeatReporter class. More...

def	assignBeat (self, theEditor, assignID)
	Put on assignment by linking up with an Editor. More...

def	assignToEditor (self, theEditor, beatRevisor=None, assignID=None)
	Have beat reporter self-assign to Editor. More...

def	pauseBeat (self)
	Pause assignment. More...

def	pauseBeat (self)
	Pause assignment. More...

def	process (self, theSignal)
	Process incoming signal and report as specified. More...

def	resumeBeat (self)
	Resume assignment. More...

Static Public Member Functions
def	buildGroupWithAnnouncement (triggers=None, announceFuns=None, announceCfg=None, beatrepCfg=None)
	Build out a group of BeatReporter instances. More...

def	buildGroupWithCommentary (triggers=None, announceFuns=None, commentFuns=None, commentCfg=None, beatrepCfg=None)
	Build out a group of BeatReporter instances. More...

def	buildGroupWithRunningCommentary (triggers=None, keepQuiet=False, filters=None, beatrepCfg=None, announceFun=None, commentFun=None, commentCfg=None)
	Build out a group of BeatReporter instances with Running Commentary. More...

Public Attributes
	hasAssignment
	Flag indicating whether the BeatReporter has an assignment from an Editor. More...

	isOnAssignment
	Flag indicating whether the BeatReporter is on assignment (i.e., reporting). More...

Public Attributes inherited from Reporter
	announcer

	channel

	config

	trigger

Detailed Description

Specialized reporter class that works with an editor.

A BeatReporter consists of the same elements as a Reporter but its individual components process the information differently and reports out to an editor.
A BeatReporter is responsible for creating specific reporting output that is shared with the editor. The Editor then collects the output and determines when to publish (or report out) and in what order. Consequently, the channel output of a BeatReporter is not the final output channel but goes to the Editor's "news desk." The Editor's channel actually does the reporting through a output generating channel.

Note: Right now a lot of the core is done by the Reporter and there really is no need for a special derived class. Should we stick with it, should we add a build static method to Reporter for a BeatReporter configuration, or something else? Just in case something changes, going with a separate class as it might interact with the Editor in a unique way. Otherwise, this separation may remain as an example of "the code is the documentation."

Constructor & Destructor Documentation

◆ init()

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

Constructor to BeatReporter class.

Collects necessary pieces.

Parameters

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

Reimplemented from Reporter.

Member Function Documentation

◆ assignBeat()

def assignBeat	(	self,
		theEditor,
		assignID
	)

Put on assignment by linking up with an Editor.

This member function is usually invoked by the Editor and carries out the work of setting up the assignment. Default is a pass through to the Channel, which should be of Assignment class.

Parameters

[in]	theEditor	Editor managing the reporter.
[in]	assignID	Assignment ID given (usually outer scope is Editor).

◆ assignToEditor()

def assignToEditor	(	self,
		theEditor,
		beatRevisor = `None`,
		assignID = `None`
	)

Have beat reporter self-assign to Editor.

Though exists, not a typical way to invoke. Better for request to come from Editor based on outer-outer scope invocation.

Parameters

[in]	theEditor	Editor who BeatReporter should report to.
[in]	beatRevisor	To revise reporters commentary output, if needed.
[in]	assignID	Assignment ID. If not given, automatically done.

◆ buildGroupWithAnnouncement()

def buildGroupWithAnnouncement	(	triggers = `None`,
		announceFuns = `None`,
		announceCfg = `None`,
		beatrepCfg = `None`
	)

static

Build out a group of BeatReporter instances.

Parameters

[in]	triggers	List of triggers. Required. Determines no. of BeatReporters
[in]	announceFuns	Not provided or List of announcement function pointers.
[in]	announceCfg	Not provided, singleton, or list of announcement configs.
[in]	beatrepCfg	Not provided, singleton, or list of reporter configs.

Uses the passed arguments to build out a group of reporters. The list of Triggers is crucial since there should be one per BeatReporter. Then, there should be enough information in announceFuns or announceCfgs to instantiate one Announcement per Trigger. Either enough announceFuns and an announceCfg exists to instantiate multiple Announcements, one per announceFun (in principle equal in number to the quantity of Triggers). Or no announceFuns and enough announceCfg instances to create multiple Announcements.

The BeatReporter configuration can be given or not. It will use a default configuration if not provided.

◆ buildGroupWithCommentary()

def buildGroupWithCommentary	(	triggers = `None`,
		announceFuns = `None`,
		commentFuns = `None`,
		commentCfg = `None`,
		beatrepCfg = `None`
	)

static

Build out a group of BeatReporter instances.

Parameters

[in]	triggers	List of triggers. Required. Determines no. of BeatReporters
[in]	announceFuns	Not provided or List of commentary function pointers.
[in]	commentFuns	Not provided or List of commentary function pointers.
[in]	commentCfg	Not provided, singleton, or list of announcement configs.
[in]	beatrepCfg	Not provided, singleton, or list of reporter configs.

Uses the passed arguments to build out a group of reporters. The list of Triggers is crucial since there should be one per BeatReporter. Then, there should be enough information in announceFuns+commentFuns or commentCfgs to instantiate one Announcement per Trigger. Either enough announceFuns+commentFuns and an commentCfg exists to instantiate multiple Commentary, one per commentFun (in principle equal in number to the quantity of Triggers). Or no announceFuns+commentFuns and enough commentCfg instances to create multiple Commentaries.

The BeatReporter configuration can be given or not. It will use a default configuration if not provided.

◆ buildGroupWithRunningCommentary()

def buildGroupWithRunningCommentary	(	triggers = `None`,
		keepQuiet = `False`,
		filters = `None`,
		beatrepCfg = `None`,
		announceFun = `None`,
		commentFun = `None`,
		commentCfg = `None`
	)

static

Build out a group of BeatReporter instances with Running Commentary.

Parameters

[in]	triggers	List of triggers. Required. Determines no. of BeatReporters
[in]	keepQuiet	Singleton or list indicating assignment reporting property.
[in]	announceFun	Not provided or singleton.
[in]	commentFun	Not provided or singleton.
[in]	commentCfg	Not provided or singleton.
[in]	beatrepCfg	Not provided, singleton, or list of reporter configs.

The way that a single RunningCommentary works is that all signal feeds get sent to the instance and accumulated. During accumulation, the Editor should not receive any notification. When the accumulated information is ready to go, one assignment or multiple specific assignments should indicate as much. All other assignments do not send along information to the Editor for action. There are many different ways to achieve this kind of processing. The current design was the simplest based on what was built out.

HOW TO INVOKE:

Because there is only a single (Running) Commentary instance that absorbs all information, there is no need to provide multiple comment and announcement functions. Just one of each if it is custom, otherwise, the default is for the commentFun to be a passthrough and the announceFun to be None. If the announceFun is not none, it should permit as input the commenFun output (which in the default case is an iterable).

Uses the passed arguments to build out a group of reporters. The list of Triggers is crucial since there should be one per BeatReporter. If the assignment or beat that triggers an output matters, then keepQuiet boolean list should indicate which one it is. Otherwise, all beat assignments will not keep quiet.

Then, there should be enough information in announceFuns+commentFuns or commentCfgs to instantiate one Announcement per Trigger. Either enough announceFuns+commentFuns and an commentCfg exists, one per commentFun (in principle equal in number to the quantity of Triggers). Or no announceFuns+commentFuns and enough commentCfg instances. All are given the same RunningCommentary. The Editor instance controls the decision to output.

The BeatReporter configuration can be given or not. It will use a default configuration if not provided.

◆ pauseBeat() [1/2]

def pauseBeat ( self )

Pause assignment.

When an assignment is paused, the BeatReporter will not report to Editor. In fact, the default for the class is to not even process triggers. Subclasses can overload this operational scheme and continue processing triggers but without reporting the outcomes to the Editor.

◆ pauseBeat() [2/2]

def pauseBeat ( self )

Pause assignment.

When an assignment is paused, the BeatReporter will not report to Editor. In fact, the default for the class is to not even process triggers. Subclasses can overload this operational scheme and continue processing triggers but without reporting the outcomes to the Editor.

◆ 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 from Reporter.

◆ resumeBeat()

def resumeBeat ( self )

Resume assignment.

Will report to Editor when triggered.

Resume a paused beat assignment.

Member Data Documentation

◆ hasAssignment

hasAssignment

Flag indicating whether the BeatReporter has an assignment from an Editor.

◆ isOnAssignment

isOnAssignment

Flag indicating whether the BeatReporter is on assignment (i.e., reporting).

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ assignBeat()

◆ assignToEditor()

◆ buildGroupWithAnnouncement()

◆ buildGroupWithCommentary()

◆ buildGroupWithRunningCommentary()

◆ pauseBeat() [1/2]

◆ pauseBeat() [2/2]

◆ process()

◆ resumeBeat()

Member Data Documentation

◆ hasAssignment

◆ isOnAssignment

◆ init()