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, Initial, NotSent }

Public Member Functions
	DtLgrSimOutput (DtLgrSimManager &manager)
	CTOR. More...
virtual	~DtLgrSimOutput ()
	DTOR. More...
virtual void	activate (const DtMessageInput *msgInput)
	Activate the output. More...
virtual void	activateImplementation ()=0
	Perform protocol-specific activation. More...
virtual bool	isActivated () const
	Get whether the output is active. More...
virtual void	deactivate ()
	Deactivate the output. More...
virtual void	deactivateImplementation ()=0
	Perform protocol-specific deactivation. More...
virtual bool	outputPacket (const DtPacket &packet)
	Apply filter flags to message buffer. More...
virtual void	filterMessage (DtPacket *packet)
	Apply filter flags to message buffer. More...
virtual void	filterMessageAllowingCheckpoints (DtPacket *packet)
	Apply filter flags to message buffer, allowing checkpoints. More...
virtual bool	sentPackets ()
	Has the output sent packets since last call to sentPackets. More...
virtual bool	isDynamicMetaData (DtPacket *packet)
	Returns true of the packet is a checkpoint, pause, or unpause packet. More...
virtual PacketSenderType	packetSenderType (const DtPacket &) const =0
	Return the packet sender type of the specified packet. More...
virtual void	setExConnSimTime (DtTime time)=0
	Set/Get the exercise connection simTime. More...
virtual DtTime	exConnSimTime () const =0
	Set/Get the exercise connection simTime. More...
virtual void	setOutputScaling (double scale)
	Set/Get the output scaling. More...
virtual double	outputScaling () const
	Set/Get the output scaling. More...
virtual void	setOutputStatic (bool isStatic)
	Set/Get the output static. More...
virtual bool	isOutputStatic () const
	Set/Get the output static. More...
virtual void	setOutputPaused (bool isPaused)
	Set/Get the output paused. More...
virtual bool	isOutputPaused () const
	Set/Get the output paused. 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 const DtMessageIOInfo *	info () const =0
	Return the output's ioinfo. More...
virtual void	flush ()=0
	Flush output, called after all outputs are finish for a time step. More...
virtual void	setOutputScaling (double scaling, bool enableStatic, bool isPaused=false)=0
	Set an output scaling value and static indicator. 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 Member Functions
virtual void	initialSend (const DtPacket &)
	Send data for an initial packet; involves decoding initial packet and passing resulting initial state messages through output process. More...
virtual void	immediateSend (const DtPacket &) const =0
	Send a packet in immediate mode (primarily for interactions) More...
virtual void	retainedSend (const DtPacket &)=0
	Send a packet in retained mode (primarily for updates) More...
virtual void	sendPacket (const DtPacket &)
	Send a packet. More...
virtual void	clearPublishers ()=0
	Clear any publishers from output. More...
virtual void	getUpdates (DtMessageBuffer &stateBuffer, const DtAbsoluteTime &time)=0
	Fill the provided message buffer with updates using the given time from current object publishers. More...

Protected Attributes
double	myOutputScaling
	The value to scale output messages. More...
bool	myIsPaused
	Output is paused. More...
bool	myOutputStatic
	Whether output should be static. More...
bool	mySendPacketFlag
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. 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
	DtLgrSimOutput (const DtLgrSimOutput &)
	Not Implemented. More...
DtLgrSimOutput &	operator= (const DtLgrSimOutput &)
	Not Implemented. More...

Detailed Description

The abstract interface which defines the output to a simulation.

Member Enumeration Documentation

enum MAKLogger::DtLgrSimOutput::PacketSenderType

Enumerator
Immediate
Retained
Initial
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::clearPublishers ( )

protectedpure virtual

Clear any publishers from output.

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 DtTime MAKLogger::DtLgrSimOutput::exConnSimTime ( ) const

pure virtual

Set/Get the exercise connection simTime.

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::getUpdates ( DtMessageBuffer &  stateBuffer, const DtAbsoluteTime &  time  )

protectedpure virtual

Fill the provided message buffer with updates using the given time from current object publishers.

Implemented in MAKLogger::DtLgrHlaSimOutput.

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

protectedpure virtual

Send a packet in immediate mode (primarily for interactions)

Implemented in MAKLogger::DtLgrHlaSimOutput.

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

protectedvirtual

Send data for an initial packet; involves decoding initial packet and passing resulting initial state messages through output process.

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

virtual

Get whether the output is active.

Implements MAKLogger::DtMessageOutput.

virtual bool MAKLogger::DtLgrSimOutput::isDynamicMetaData ( DtPacket *  packet )

virtual

Returns true of the packet is a checkpoint, pause, or unpause packet.

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

virtual

Set/Get the output paused.

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

virtual

Set/Get the output static.

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 double MAKLogger::DtLgrSimOutput::outputScaling ( ) const

virtual

Set/Get the output scaling.

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.

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

protectedvirtual

Send a packet.

virtual bool MAKLogger::DtLgrSimOutput::sentPackets ( )

virtual

Has the output sent packets since last call to sentPackets.

virtual void MAKLogger::DtLgrSimOutput::setExConnSimTime ( DtTime  time )

pure virtual

Set/Get the exercise connection simTime.

Implemented in MAKLogger::DtLgrHlaSimOutput.

virtual void MAKLogger::DtLgrSimOutput::setOutputPaused ( bool  isPaused )

virtual

Set/Get the output paused.

virtual void MAKLogger::DtLgrSimOutput::setOutputScaling ( double  scale )

virtual

Set/Get the output scaling.

virtual void MAKLogger::DtLgrSimOutput::setOutputStatic ( bool  isStatic )

virtual

Set/Get the output static.

Member Data Documentation

bool MAKLogger::DtLgrSimOutput::myActivateFlag

protected

bool MAKLogger::DtLgrSimOutput::myIsPaused

protected

Output is paused.

DtLgrSimManager& MAKLogger::DtLgrSimOutput::myManager

protected

double MAKLogger::DtLgrSimOutput::myOutputScaling

protected

The value to scale output messages.

bool MAKLogger::DtLgrSimOutput::myOutputStatic

protected

Whether output should be static.

bool MAKLogger::DtLgrSimOutput::mySendPacketFlag

protected

bool MAKLogger::DtLgrSimOutput::mySentPacketsFlag

protected

---

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

• lgrSimOutput.h