The message input is the interface for objects that provide messages into the pipeline. More...
Inheritance diagram for MAKLogger::DtMessageInput:
Collaboration diagram for MAKLogger::DtMessageInput:
Public Member Functions | |
| virtual void | activate ()=0 |
| Called when the input is activated. | |
| virtual void | deactivate ()=0 |
| Called when the input is deactivated. | |
| virtual void | startReadMessages (DtAbsoluteTime timeToRead) |
| Called at the beginning of a read operation. | |
| virtual void | stopReadMessages () |
| Called at the end of a read operation. | |
| virtual DtAbsoluteTime | inputTime () const |
| Get the current input time. | |
| virtual void | setStopReadingTimeBoundary (bool inclusive) |
| The stop reading time (set by startReadMessages may be inclusive or exclusive. | |
| virtual bool | stopReadingBoundary () const |
| Get the current stop reading boundary setting. | |
| virtual void | getNextMessages (DtMessageBuffer &)=0 |
| Called when the pipeline needs to get messages. | |
| virtual void | dropNextMessages ()=0 |
| Called to drop messages from the current read operation. | |
| virtual const DtMessageIOInfo * | info () const =0 |
| The the message info for the input. | |
| virtual void | tick () |
| Tick the message input -- for repeating tasks, such as timeout checks. | |
| virtual void | setTimeLimit (double limit) |
| Set the time limit on reads during playback. | |
Protected Attributes | |
| DtAbsoluteTime | myCurrentTime |
| bool | myStopReadingBoundary |
| double | myTimeLimit |
Private Member Functions | |
| DtMessageInput (const DtMessageInput &) | |
| Not Implemented. | |
| DtMessageInput & | operator= (const DtMessageInput &) |
| Not Implemented. | |
Detailed Description
The message input is the interface for objects that provide messages into the pipeline.
Member Function Documentation
| virtual void MAKLogger::DtMessageInput::setStopReadingTimeBoundary | ( | bool | inclusive | ) | [virtual] |
The stop reading time (set by startReadMessages may be inclusive or exclusive.
By default it is inclusive. For example, reading up to 10 seconds contains all messages with timestamps <= 10. Setting boundary to be false (exclusive) will result to a read up to 10s but not including packets with a time of 10s.
| virtual void MAKLogger::DtMessageInput::setTimeLimit | ( | double | limit | ) | [virtual] |
Set the time limit on reads during playback.
Units are seconds. A value less than zero indicates no limit.
| virtual bool MAKLogger::DtMessageInput::stopReadingBoundary | ( | ) | const [virtual] |
Get the current stop reading boundary setting.
- Return values:
-
true Time is Inclusive false Time is Exclusive.
The documentation for this class was generated from the following file: