Commentary class that also keeps track of past information and reports it all out when requested. At that point, it should wipe the past information and start collecting anew. More...
Public Member Functions | |
| def | __init__ (self, theConfig) |
| Constructor for RunningCommentary class. More... | |
| def | ack (self) |
| Send along to Announcement that Channel acknowledges message. More... | |
| def | prepare (self, theSignal) |
| Prepare the commentary (e.g., convert to storage format). More... | |
| def | reset (self) |
 Public Member Functions inherited from Commentary | |
| def | message (self) |
| Return the commentary message. More... | |
| def | reportout (self) |
Public Attributes | |
| commentary | |
| Public Attributes inherited from Commentary | |
| announcement | |
| commentary | |
| config | |
| Public Attributes inherited from Announcement | |
| announcement | |
| config | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Commentary | |
| 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) |
Detailed Description
Commentary class that also keeps track of past information and reports it all out when requested. At that point, it should wipe the past information and start collecting anew.
The commentary will either be directly access for use, or it will be reported out. Reporting out does conversion to text.
Constructor & Destructor Documentation
◆ __init__()
| def __init__ | ( | self, | |
| theConfig | |||
| ) |
Constructor for RunningCommentary class.
Reimplemented from Commentary.
Member Function Documentation
◆ ack()
| def ack | ( | self | ) |
Send along to Announcement that Channel acknowledges message.
For a RunningCommentary, acknowledgement indicates that the stored information was used or somehow passed on. Thus, the old information should be removed so that new information may be accumulated.
Reimplemented from Announcement.
◆ prepare()
| def prepare | ( | self, | |
| theSignal | |||
| ) |
Prepare the commentary (e.g., convert to storage format).
- Parameters
-
[in] theSignal The signal attached to the announcement.
Reimplemented from Commentary.
◆ reset()
| def reset | ( | self | ) |
Member Data Documentation
◆ commentary
| commentary |
The documentation for this class was generated from the following file:
- /home/pvela/python/perceiver/perceiver/reports/drafts.py
