Commentary class, which does not transcribe the signal but passes it along in some non-text format. More...
Public Member Functions | |
| def | __init__ (self, theConfig) |
| Constructor for Commentary class. More... | |
| def | message (self) |
| Return the commentary message. More... | |
| def | prepare (self, theSignal) |
| Prepare the announcement (e.g., convert to text for reporting out). More... | |
| def | reportout (self) |
 Public Member Functions inherited from Announcement | |
| def | ack (self) |
| Send along to Announcement that Channel acknowledges message. More... | |
Static Public Member Functions | |
| def | counter (icnt=0, cspec="{}") |
| Signal is ignored and replace with invocation counter. More... | |
| def | timeof () |
| Signal is ignored and replace with current time in raw/time format. More... | |
| Static Public Member Functions inherited from Announcement | |
| def | alwaystoiterable (fsig) |
| def | counterWithReset (icnt=0, cspec="{}") |
| Signal is ignored and replace with invocation counter. More... | |
| def | dateof () |
| Signal is ignored and replace with current date (as string). More... | |
| def | fixed (theAnnouncement) |
| Signal is ignored and replace with a fixed output. More... | |
| def | float2text (fspec="{}") |
| Convert float to string based on preset specification. More... | |
| def | int2text (isig) |
| Convert integer to string. More... | |
| def | passthrough (fsig) |
| def | text2text (ssig) |
| Signal is already a string, so just return. More... | |
| def | toiterable (fsig) |
Public Attributes | |
| announcement | |
| commentary | |
| config | |
| Public Attributes inherited from Announcement | |
| announcement | |
| config | |
Detailed Description
Commentary class, which does not transcribe the signal but passes it along in some non-text format.
A commentary repackages a signal for passing it along. Unlike an announcement, the commentary may or may not be immediately converted to text and output via a channel. Rather it exists in storage until ready for use. The expected implementation is that some external source will request the information rather than being passed along automatically.
Consequently, static signal saving methods are also needed that do not convert the signal to text but rather return what part of the signal to save. In most cases, a passthrough (inherited from Announcement) will do. However, there are some cases where the triggered signal is used to create a different kind of message. Downstream processing may prefer to get the commentary rather than convert it into a text/string announcement. It is up to the downstream part to establish approach.
The design makes sense when used with a BeatReporter who would pass the data along to an Editor. The Editor can sit on the data, or elect to publish it through the Editor's Channel. If the Channel can process binary or non-text data, then using the Commentary would be the sensible outcome.
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
| theConfig | |||
| ) |
Constructor for Commentary class.
Reimplemented from Announcement.
Reimplemented in RunningCommentary.
Member Function Documentation
◆ counter()
|
static |
Signal is ignored and replace with invocation counter.
Every time the trigger happens to involve counter, the counter increases. It starts with 0. If something else should be used, then pass in the initial value when creating the pointer.
- Returns
- Counter value.
Reimplemented from Announcement.
◆ message()
| def message | ( | self | ) |
Return the commentary message.
Reimplemented from Announcement.
◆ prepare()
| def prepare | ( | self, | |
| theSignal | |||
| ) |
Prepare the announcement (e.g., convert to text for reporting out).
- Parameters
-
[in] theSignal The signal attached to the announcement.
Reimplemented from Announcement.
Reimplemented in RunningCommentary.
◆ reportout()
| def reportout | ( | self | ) |
◆ timeof()
|
static |
Signal is ignored and replace with current time in raw/time format.
Rather than use the signal to generate the message, use the time of the signal occurence to be the announcement.
- Returns
- The fixed announcement.
Reimplemented from Announcement.
Member Data Documentation
◆ announcement
| announcement |
◆ commentary
| commentary |
◆ config
| config |
The documentation for this class was generated from the following file:
- /home/pvela/python/perceiver/perceiver/reports/drafts.py
