MAKLogger::DtLgrSimOutput Class Reference

The abstract interface which defines the output to a simulation. More...

Inheritance diagram for MAKLogger::DtLgrSimOutput:

Collaboration diagram for MAKLogger::DtLgrSimOutput:

Public Types
enum	PacketSenderType { Immediate, Retained, NotSent }

Public Member Functions
	DtLgrSimOutput (DtLgrSimManager &manager)
	CTOR.
virtual	~DtLgrSimOutput ()
	DTOR.
virtual void	activate (const DtMessageInput *msgInput)
	Activate the output.
virtual void	activateImplementation ()=0
	Perform protocol-specific activation.
virtual bool	isActivated () const
	Get whether the output is active.
virtual void	deactivate ()
	Deactivate the output.
virtual void	deactivateImplementation ()=0
	Perform protocol-specific deactivation.
virtual bool	outputPacket (const DtPacket &packet)
	Apply filter flags to message buffer.
virtual void	filterMessage (DtPacket *packet)
	Apply filter flags to message buffer.
virtual void	filterMessageAllowingCheckpoints (DtPacket *packet)
	Apply filter flags to message buffer, allowing checkpoints.
virtual bool	sentPackets ()
	Has the output sent packets since last call to sentPackets.
virtual PacketSenderType	packetSenderType (const DtPacket &) const =0
	Return the packet sender type of the specified packet.
Public Member Functions inherited from MAKLogger::DtMessageOutput
	DtMessageOutput ()
	CTOR.
virtual	~DtMessageOutput ()
	DTOR.
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 void	filterMessages (DtMessageBuffer &buffer)
	Apply filter flags to message buffer.
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 Member Functions
virtual void	immediateSend (const DtPacket &) const =0
	Send a packet in immediate mode (primarily for interactions)
virtual void	retainedSend (const DtPacket &)=0
	Send a packet in retained mode (primarily for updates)
void	sendPacket (const DtPacket &)
	Send a packet.

Protected Attributes
bool	mySentPacketsFlag
DtLgrSimManager &	myManager
bool	myActivateFlag
Protected Attributes inherited from MAKLogger::DtMessageOutput
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
	DtLgrSimOutput (const DtLgrSimOutput &)
	Not Implemented.
DtLgrSimOutput &	operator= (const DtLgrSimOutput &)
	Not Implemented.

Detailed Description

The abstract interface which defines the output to a simulation.

Member Enumeration Documentation

enum MAKLogger::DtLgrSimOutput::PacketSenderType

Enumerator:

Immediate
Retained
NotSent

Constructor & Destructor Documentation

MAKLogger::DtLgrSimOutput::DtLgrSimOutput

(

DtLgrSimManager &

manager

)

CTOR.

virtual MAKLogger::DtLgrSimOutput::~DtLgrSimOutput ( )

virtual

DTOR.

MAKLogger::DtLgrSimOutput::DtLgrSimOutput ( const DtLgrSimOutput &  )

private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtLgrSimOutput::activate ( const DtMessageInput *  msgInput )

virtual

Activate the output.

Implements MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrSimOutput::activateImplementation ( )

pure virtual

Perform protocol-specific activation.

Implemented in MAKLogger::DtLgrHlaSimOutput.

virtual void MAKLogger::DtLgrSimOutput::deactivate ( )

virtual

Deactivate the output.

Implements MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrSimOutput::deactivateImplementation ( )

pure virtual

Perform protocol-specific deactivation.

Implemented in MAKLogger::DtLgrHlaSimOutput.

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

virtual

Apply filter flags to message buffer.

Implements MAKLogger::DtMessageOutput.

Reimplemented in MAKLogger::DtLgrHlaSimOutput.

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

virtual

Apply filter flags to message buffer, allowing checkpoints.

Reimplemented from MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrSimOutput::immediateSend ( const DtPacket &  ) const

protectedpure virtual

Send a packet in immediate mode (primarily for interactions)

Implemented in MAKLogger::DtLgrHlaSimOutput.

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

virtual

Get whether the output is active.

Implements MAKLogger::DtMessageOutput.

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

private

Not Implemented.

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

virtual

Apply filter flags to message buffer.

Implements MAKLogger::DtMessageOutput.

virtual PacketSenderType MAKLogger::DtLgrSimOutput::packetSenderType ( const DtPacket &  ) const

pure virtual

Return the packet sender type of the specified packet.

Implemented in MAKLogger::DtLgrHlaSimOutput.

virtual void MAKLogger::DtLgrSimOutput::retainedSend ( const DtPacket &  )

protectedpure virtual

Send a packet in retained mode (primarily for updates)

Implemented in MAKLogger::DtLgrHlaSimOutput.

void MAKLogger::DtLgrSimOutput::sendPacket ( const DtPacket &  )

protected

Send a packet.

virtual bool MAKLogger::DtLgrSimOutput::sentPackets ( )

virtual

Has the output sent packets since last call to sentPackets.

Member Data Documentation

bool MAKLogger::DtLgrSimOutput::myActivateFlag

protected

DtLgrSimManager& MAKLogger::DtLgrSimOutput::myManager

protected

bool MAKLogger::DtLgrSimOutput::mySentPacketsFlag

protected

---

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

• lgrSimOutput.h