MAKLogger::DtLgrPacketPrinterOutput Class Reference

Inheritance diagram for MAKLogger::DtLgrPacketPrinterOutput:

Collaboration diagram for MAKLogger::DtLgrPacketPrinterOutput:

Public Member Functions
	DtLgrPacketPrinterOutput (DtLgrPacketPrinter *printer, const DtString &destination, const DtMessageIOInfo *info)
	Ctor. More...
virtual	~DtLgrPacketPrinterOutput ()
	DTOR. More...
virtual void	setPrinter (DtLgrPacketPrinter *printer)
	Set the printer. More...
virtual void	setDestination (const DtString &destination)
	Set the destination. More...
virtual const DtString &	destination () const
	Get the destination. More...
virtual DtLgrPacketPrinter *	currentPrinter ()
	Get the current printer. More...
virtual void	activate (const DtMessageInput *fileInput)
	Activate the output, this will call beginPrinting of the printer. More...
virtual bool	isActivated () const
	Get if the output has been activated. More...
virtual void	deactivate ()
	Deactivate the output. More...
virtual bool	outputPacket (const DtPacket &packet)
	Output a single packet. More...
virtual void	filterMessage (DtPacket *packet)
	Apply filter flags to message buffer. More...
virtual const DtMessageIOInfo *	info () const
	Return the output's ioinfo. More...
virtual void	flush ()
	Flush output, called after all outputs are finish for a time step. More...
virtual void	setOutputScaling (double scaling, bool enableStatic, bool isPaused=false)
	Set an output scaling value and static indicator. More...
Public Member Functions inherited from MAKLogger::DtMessageOutput
	DtMessageOutput ()
	CTOR. More...
virtual	~DtMessageOutput ()
	DTOR. More...
virtual bool	sourceTimeInclusive () const
	Get the whether input time was inclusive. More...
virtual void	outputMessages (const DtMessageBuffer &buffer)
	Apply filter flags to message buffer. More...
virtual void	outputMessage (const DtPacket *packet)
	Output a single message. More...
virtual void	filterMessages (DtMessageBuffer &buffer)
	Apply filter flags to message buffer. More...
virtual void	filterMessageAllowingCheckpoints (DtPacket *packet)
	Apply filter to a packet, allowing checkpoints. More...
virtual void	setSendImmediate (bool enable)
	Turn on and off sending immediate messages. More...
virtual void	setSendRetained (bool enable)
	Turn on and off sending retained messages. More...
virtual void	setSendInitial (bool enable)
	Turn on and off sending initial state messages. More...
void	attachFilter (DtMessageFilter *)
	Attach a filter to the output. More...
void	detachFilter (DtMessageFilter *)
	Detach a filter from the output. More...
void	filters (DtCollector< DtMessageFilter * > filterCollection) const
	Return the filters associated with the output. More...
DtObserveEvent< DtPacket > *	preOutputPacketEvent ()
	Get the event signaled before a packet is output. More...
DtObserveEvent< DtPacket > *	postOutputPacketEvent ()
	Get the event signaled after a packet is output. More...
DtObserveEvent< DtPacket > *	packetFilteredEvent ()
	Get the event signaled if a packet is filtered. More...
virtual void	setSourceTime (const DtAbsoluteTime &sourceTime, bool inclusive)
	Set/Get the time boundary used to collect the the source to be processed for output. More...
virtual DtAbsoluteTime	sourceTime () const
	Set/Get the time boundary used to collect the the source to be processed for output. More...

Protected Attributes
DtLgrPacketPrinter *	myPrinter
const DtMessageIOInfo *	myInfo
bool	myActivateFlag
DtString	myDestination
Protected Attributes inherited from MAKLogger::DtMessageOutput
std::set< DtMessageFilter * >	myFilters
DtObserveEvent< DtPacket >	myPreOutputPacketEvent
	Event called before a packet is output. More...
DtObserveEvent< DtPacket >	myPostOutputPacketEvent
	Event called after a packet is output. More...
DtObserveEvent< DtPacket >	myFilteredPacketEvent
	Event called if a packet is filtered. More...
bool	mySendImmediateFlag
	Whether to send immediate messages. More...
bool	mySendRetainedFlag
	Whether to send retained messages. More...
bool	mySendInitialFlag
	Whether to send initial state messages. More...
DtAbsoluteTime	mySourceTime
	The time used for collecting input. More...
bool	mySourceTimeBoundary
	Whether the input time was inclusive or exclusive. More...

Private Member Functions
	DtLgrPacketPrinterOutput (const DtLgrPacketPrinterOutput &)
DtLgrPacketPrinterOutput &	operator= (const DtLgrPacketPrinterOutput &)

Constructor & Destructor Documentation

MAKLogger::DtLgrPacketPrinterOutput::DtLgrPacketPrinterOutput	(	DtLgrPacketPrinter *	printer,
		const DtString &	destination,
		const DtMessageIOInfo *	info
	)

Ctor.

Give the output the printer. And set the printer.

Parameters

INPUT

printer A pointer to the printer. The output does not take ownership of the printer.

virtual MAKLogger::DtLgrPacketPrinterOutput::~DtLgrPacketPrinterOutput ( )

virtual

DTOR.

MAKLogger::DtLgrPacketPrinterOutput::DtLgrPacketPrinterOutput ( const DtLgrPacketPrinterOutput &  )

private

Member Function Documentation

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

virtual

Activate the output, this will call beginPrinting of the printer.

File input is provided for access general source information and meta data.

Implements MAKLogger::DtMessageOutput.

virtual DtLgrPacketPrinter* MAKLogger::DtLgrPacketPrinterOutput::currentPrinter ( )

virtual

Get the current printer.

virtual void MAKLogger::DtLgrPacketPrinterOutput::deactivate ( )

virtual

Deactivate the output.

Implements MAKLogger::DtMessageOutput.

virtual const DtString& MAKLogger::DtLgrPacketPrinterOutput::destination ( ) const

virtual

Get the destination.

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

virtual

Apply filter flags to message buffer.

Implements MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrPacketPrinterOutput::flush ( )

virtual

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

Implements MAKLogger::DtMessageOutput.

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

virtual

Return the output's ioinfo.

Implements MAKLogger::DtMessageOutput.

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

virtual

Get if the output has been activated.

Implements MAKLogger::DtMessageOutput.

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

private

virtual bool MAKLogger::DtLgrPacketPrinterOutput::outputPacket ( const DtPacket &  packet )

virtual

Output a single packet.

Returns

true if packet was output. Always true with a printer.

Implements MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrPacketPrinterOutput::setDestination ( const DtString &  destination )

virtual

Set the destination.

This should be called before activate and should not be called after activate until deactivate is called.

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

virtual

Set an output scaling value and static indicator.

Implements MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrPacketPrinterOutput::setPrinter ( DtLgrPacketPrinter *  printer )

virtual

Set the printer.

This should be called before activate and should not be called after activate until deactivate is called.

Member Data Documentation

bool MAKLogger::DtLgrPacketPrinterOutput::myActivateFlag

protected

DtString MAKLogger::DtLgrPacketPrinterOutput::myDestination

protected

const DtMessageIOInfo* MAKLogger::DtLgrPacketPrinterOutput::myInfo

protected

DtLgrPacketPrinter* MAKLogger::DtLgrPacketPrinterOutput::myPrinter

protected

---

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

• lgrPacketPrinter.h