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, bool isPaused=false)=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.
virtual void	setSendInitial (bool enable)
	Turn on and off sending initial state 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.
bool	mySendInitialFlag
	Whether to send initial state 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.

Constructor & Destructor Documentation

MAKLogger::DtMessageOutput::DtMessageOutput ( )

CTOR.

virtual MAKLogger::DtMessageOutput::~DtMessageOutput ( )

virtual

DTOR.

MAKLogger::DtMessageOutput::DtMessageOutput ( const DtMessageOutput & )

private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtMessageOutput::activate ( const DtMessageInput * fileInput )

pure virtual

Activate the output.

Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLoggerFileWriter, and MAKLogger::DtLgrSimOutput.

void MAKLogger::DtMessageOutput::attachFilter ( DtMessageFilter * )

Attach a filter to the output.

virtual void MAKLogger::DtMessageOutput::deactivate ( )

pure virtual

Deactivate the output.

Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLoggerFileWriter, and MAKLogger::DtLgrSimOutput.

void MAKLogger::DtMessageOutput::detachFilter ( DtMessageFilter * )

Detach a filter from the output.

virtual void MAKLogger::DtMessageOutput::filterMessage ( DtPacket * packet )

pure virtual

Apply filter to a packet.

Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLgrDisSimOutput, MAKLogger::DtLgrSimOutput, and MAKLogger::DtLgrFileOutput.

virtual void MAKLogger::DtMessageOutput::filterMessageAllowingCheckpoints ( DtPacket * packet )

virtual

Apply filter to a packet, allowing checkpoints.

Reimplemented in MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtMessageOutput::filterMessages ( DtMessageBuffer & buffer )

virtual

Apply filter flags to message buffer.

Deprecated:: This did not provide sufficient granularity.

void MAKLogger::DtMessageOutput::filters ( DtCollector< DtMessageFilter * > filterCollection ) const

Return the filters associated with the output.

virtual void MAKLogger::DtMessageOutput::flush ( )

pure virtual

Flush output, called after all outputs are finish for a time step.

Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLoggerFileWriter, and MAKLogger::DtLgrDisSimOutput.

virtual const DtMessageIOInfo* MAKLogger::DtMessageOutput::info ( ) const

pure virtual

Return the output's ioinfo.

Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLoggerFileWriter, and MAKLogger::DtLgrDisSimOutput.

virtual bool MAKLogger::DtMessageOutput::isActivated ( ) const

pure virtual

Get if the output has been activated.

Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLoggerFileWriter, and MAKLogger::DtLgrSimOutput.

DtMessageOutput& MAKLogger::DtMessageOutput::operator= ( const DtMessageOutput & )

private

Not Implemented.

virtual void MAKLogger::DtMessageOutput::outputMessage ( const DtPacket * packet )

virtual

Output a single message.

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.

DtObserveEvent<DtPacket>* MAKLogger::DtMessageOutput::packetFilteredEvent ( )

Get the event signaled if a packet is filtered.

DtObserveEvent<DtPacket>* MAKLogger::DtMessageOutput::postOutputPacketEvent ( )

Get the event signaled after a packet is output.

DtObserveEvent<DtPacket>* MAKLogger::DtMessageOutput::preOutputPacketEvent ( )

Get the event signaled before a packet is output.

virtual void MAKLogger::DtMessageOutput::setOutputScaling	(	double	scaling,
		bool	enableStatic,
		bool	isPaused = `false`
	)

pure virtual

Set an output scaling value and static indicator.

Implemented in MAKLogger::DtLgrPacketPrinterOutput, MAKLogger::DtLoggerFileWriter, and MAKLogger::DtLgrDisSimOutput.

virtual void MAKLogger::DtMessageOutput::setSendImmediate ( bool enable )

virtual

Turn on and off sending immediate messages.

virtual void MAKLogger::DtMessageOutput::setSendInitial ( bool enable )

virtual

Turn on and off sending initial state messages.

virtual void MAKLogger::DtMessageOutput::setSendRetained ( bool enable )

virtual

Turn on and off sending retained messages.

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.

virtual bool MAKLogger::DtMessageOutput::sourceTimeInclusive ( ) const

virtual

Get the whether input time was inclusive.

Member Data Documentation

DtObserveEvent<DtPacket> MAKLogger::DtMessageOutput::myFilteredPacketEvent

protected

Event called if a packet is filtered.

std::set<DtMessageFilter*> MAKLogger::DtMessageOutput::myFilters

protected

DtObserveEvent<DtPacket> MAKLogger::DtMessageOutput::myPostOutputPacketEvent

protected

Event called after a packet is output.

DtObserveEvent<DtPacket> MAKLogger::DtMessageOutput::myPreOutputPacketEvent

protected

Event called before a packet is output.

bool MAKLogger::DtMessageOutput::mySendImmediateFlag

protected

Whether to send immediate messages.

bool MAKLogger::DtMessageOutput::mySendInitialFlag

protected

Whether to send initial state messages.

bool MAKLogger::DtMessageOutput::mySendRetainedFlag

protected

Whether to send retained messages.

DtAbsoluteTime MAKLogger::DtMessageOutput::mySourceTime

protected

The time used for collecting input.

bool MAKLogger::DtMessageOutput::mySourceTimeBoundary

protected

Whether the input time was inclusive or exclusive.

The documentation for this class was generated from the following file:

messageOutput.h

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation