Class defines interface for outputs for messages. More...
Inheritance diagram for MAKLogger::DtMessageOutput:
Collaboration diagram for MAKLogger::DtMessageOutput:
Public Member Functions | |
| DtMessageOutput () | |
| CTOR. | |
| virtual | ~DtMessageOutput () |
| DTOR. | |
| virtual void | activate (const DtMessageInput *fileInput)=0 |
| Activate the output. | |
| virtual bool | isActivated () const =0 |
| Get if the output has been activated. | |
| virtual void | deactivate ()=0 |
| Deactivate the output. | |
| virtual bool | sourceTimeInclusive () const |
| Get the whether input time was inclusive. | |
| virtual void | outputMessages (const DtMessageBuffer &buffer) |
| Apply filter flags to message buffer. | |
| virtual void | outputMessage (const DtPacket *packet) |
| Output a single message. | |
| virtual bool | outputPacket (const DtPacket &packet)=0 |
| Output a single packet. | |
| virtual void | filterMessages (DtMessageBuffer &buffer) |
| Apply filter flags to message buffer. | |
| virtual void | filterMessage (DtPacket *packet)=0 |
| Apply filter to a packet. | |
| virtual void | filterMessageAllowingCheckpoints (DtPacket *packet) |
| Apply filter to a packet, allowing checkpoints. | |
| virtual const DtMessageIOInfo * | info () const =0 |
| Return the output's ioinfo. | |
| virtual void | flush ()=0 |
| Flush output, called after all outputs are finish for a time step. | |
| virtual void | setOutputScaling (double scaling, bool enableStatic)=0 |
| Set an output scaling value and static indicator. | |
| virtual void | setSendImmediate (bool enable) |
| Turn on and off sending immediate messages. | |
| virtual void | setSendRetained (bool enable) |
| Turn on and off sending retained messages. | |
| void | attachFilter (DtMessageFilter *) |
| Attach a filter to the output. | |
| void | detachFilter (DtMessageFilter *) |
| Detach a filter from the output. | |
| void | filters (DtCollector< DtMessageFilter * > filterCollection) const |
| Return the filters associated with the output. | |
| DtObserveEvent< DtPacket > * | preOutputPacketEvent () |
| Get the event signaled before a packet is output. | |
| DtObserveEvent< DtPacket > * | postOutputPacketEvent () |
| Get the event signaled after a packet is output. | |
| DtObserveEvent< DtPacket > * | packetFilteredEvent () |
| Get the event signaled if a packet is filtered. | |
| virtual void | setSourceTime (const DtAbsoluteTime &sourceTime, bool inclusive) |
| Set/Get the time boundary used to collect the the source to be processed for output. | |
| virtual DtAbsoluteTime | sourceTime () const |
| Set/Get the time boundary used to collect the the source to be processed for output. | |
Protected Attributes | |
| std::set< DtMessageFilter * > | myFilters |
| DtObserveEvent< DtPacket > | myPreOutputPacketEvent |
| Event called before a packet is output. | |
| DtObserveEvent< DtPacket > | myPostOutputPacketEvent |
| Event called after a packet is output. | |
| DtObserveEvent< DtPacket > | myFilteredPacketEvent |
| Event called if a packet is filtered. | |
| bool | mySendImmediateFlag |
| Whether to send immediate messages. | |
| bool | mySendRetainedFlag |
| Whether to send retained messages. | |
| DtAbsoluteTime | mySourceTime |
| The time used for collecting input. | |
| bool | mySourceTimeBoundary |
| Whether the input time was inclusive or exclusive. | |
Private Member Functions | |
| DtMessageOutput (const DtMessageOutput &) | |
| Not Implemented. | |
| DtMessageOutput & | operator= (const DtMessageOutput &) |
| Not Implemented. | |
Detailed Description
Class defines interface for outputs for messages.
Member Function Documentation
| virtual void MAKLogger::DtMessageOutput::filterMessages | ( | DtMessageBuffer & | buffer | ) | [virtual] |
Apply filter flags to message buffer.
- Deprecated:
- This did not provide sufficient granularity.
| virtual void MAKLogger::DtMessageOutput::outputMessages | ( | const DtMessageBuffer & | buffer | ) | [virtual] |
Apply filter flags to message buffer.
Calls outputMessage on each packet.
- Deprecated:
- Did not provide sufficient granularity.
Reimplemented in MAKLogger::DtMultiMessageOutput.
| virtual bool MAKLogger::DtMessageOutput::outputPacket | ( | const DtPacket & | packet | ) | [pure virtual] |
Output a single packet.
The packet is first filtered.
- Returns:
- true if packet was output.
Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLgrSimOutput, and MAKLogger::DtLgrFileOutput.
| virtual void MAKLogger::DtMessageOutput::setSourceTime | ( | const DtAbsoluteTime & | sourceTime, |
| bool | inclusive | ||
| ) | [virtual] |
Set/Get the time boundary used to collect the the source to be processed for output.
Indicate whether the given time is included.
| virtual DtAbsoluteTime MAKLogger::DtMessageOutput::sourceTime | ( | ) | const [virtual] |
Set/Get the time boundary used to collect the the source to be processed for output.
Indicate whether the given time is included.
The documentation for this class was generated from the following file: