 |
NDEVR
API Documentation
|
|
NDEVR
API Documentation
|
A LogStream that writes log messages to the platform debug console. More...
Public Member Functions | |
| DebugStream () | |
| Constructs a DebugStream instance. | |
| ~DebugStream () | |
| Destroys the DebugStream instance. | |
| void | addMessage (uint04 id, const LogMessage &message) final override |
| Adds a log message and writes it to the debug console. | |
| void | setProgress (uint04 id, fltp04 progress) final override |
| Updates the progress for a given operation and writes it to the debug console. | |
| Public Member Functions inherited from LogStream | |
| virtual | ~LogStream () |
| Destructor. | |
| virtual void | addMessages (uint04 id, const Buffer< LogMessage > &messages) |
| Adds multiple log messages to this stream at once. | |
| virtual void | addProgressSource (const TranslatedString &name, uint04 idx, fltp04 progress) |
| Registers a new progress source to be tracked by this stream. | |
| virtual void | allowCancel (bool) |
| Sets whether this stream allows the user to cancel an in-progress operation. | |
| virtual void | allowInput (bool) |
| Sets whether this stream allows user input during an operation. | |
| virtual void | attach (InfoPipe *stream) |
| Attaches this LogStream to the given InfoPipe so it receives log updates. | |
| void | clearLinks () |
| Detaches this LogStream from all linked InfoPipe objects and clears the link list. | |
| virtual void | detach (InfoPipe *stream) |
| Detaches this LogStream from the given InfoPipe, stopping further updates from it. | |
| bool | ignoringMessages () const |
| Returns whether this stream is currently ignoring messages. | |
| virtual void | removeProgressSource (uint04 idx) |
| Removes a previously registered progress source from this stream. | |
| void | setIgnoreMessages (bool ignore) |
| Sets whether this stream should ignore incoming messages. | |
Additional Inherited Members | |
| Protected Attributes inherited from LogStream | |
| bool | m_ignore_message = false |
| Whether this stream should ignore incoming messages. | |
| Buffer< InfoPipe * > | m_linked_logs |
| Collection of InfoPipe objects this stream is listening to. | |
| Dictionary< uint04, ProgressSource > | m_progress_sources |
| Maps progress source indices to their ProgressSource data. | |
A LogStream that writes log messages to the platform debug console.
Definition at line 40 of file DebugStream.h.
|
finaloverridevirtual |
Adds a log message and writes it to the debug console.
| [in] | id | The identifier associated with the message source. |
| [in] | message | The log message to output. |
Implements LogStream.
Updates the progress for a given operation and writes it to the debug console.
| [in] | id | The identifier of the operation whose progress is being reported. |
| [in] | progress | The current progress value as a fraction from 0.0 to 1.0. |
Implements LogStream.