MAK Data Logger API Documentation for DIS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions
MAKLogger::DtLgrDisSimOutput Class Reference

DIS simulation output. More...

+ Inheritance diagram for MAKLogger::DtLgrDisSimOutput:
+ Collaboration diagram for MAKLogger::DtLgrDisSimOutput:

Public Member Functions

virtual ~DtLgrDisSimOutput ()
 
virtual
DtLgrSimOutput::PacketSenderType 
packetSenderType (const DtPacket &) const
 Return the packet sender type of the specified packet. More...
 
virtual void disconnecting ()
 Called when the connection is being lost. More...
 
virtual void activateImplementation ()
 Active the implementation of SimOutput. More...
 
virtual void deactivateImplementation ()
 Deactivate implementation of SimOutput. More...
 
virtual const DtMessageIOInfoinfo () 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...
 
virtual void filterMessage (DtPacket *packet)
 Apply filter flags to message buffer. More...
 
virtual void removeEntity (const DtString &name)
 
virtual void removeEntity (DtPduKind kind, DtObjectId id)
 
virtual void removeEntity (DtConstLgrDisMessage &)
 
virtual DtExerciseConnexerciseConn ()
 The manager's exercise connection. More...
 
virtual const DtExerciseConnexerciseConn () const
 The manager's exercise connection const. More...
 
virtual void setExConnSimTime (DtTime time)
 Set/Get the exercise connection simTime. More...
 
virtual DtTime exConnSimTime () const
 Set/Get the exercise connection simTime. More...
 
- Public Member Functions inherited from MAKLogger::DtLgrSimOutput
 DtLgrSimOutput (DtLgrSimManager &manager)
 CTOR. More...
 
virtual ~DtLgrSimOutput ()
 DTOR. More...
 
virtual void activate (const DtMessageInput *msgInput)
 Activate the output. More...
 
virtual bool isActivated () const
 Get whether the output is active. More...
 
virtual void deactivate ()
 Deactivate the output. More...
 
virtual bool outputPacket (const 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 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 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 Types

typedef std::pair< DtPduKind,
DtObjectId > 
UniqueObjectId
 
typedef std::map
< UniqueObjectId,
DtLgrPublisherInterface * > 
ObjectPublisherMap
 

Protected Member Functions

virtual void retainedSend (const DtPacket &)
 Retained message send, aka Object updates. More...
 
virtual void immediateSend (const DtPacket &) const
 Immediate send aka Interactions. More...
 
virtual void sendPacket (const DtPacket &packet)
 Send a packet. More...
 
virtual void parsePdu (const DtPdu *pdu) const
 
virtual void parsePacket (const DtPacket &packet)
 
virtual void updateEntity (DtConstLgrDisMessage &)
 
virtual void clearPublishers ()
 Clear any publishers from output. More...
 
virtual void getUpdates (DtMessageBuffer &stateBuffer, const DtAbsoluteTime &time)
 Fill the provided message buffer with updates using the given time from current object publishers. More...
 
virtual void rescalePublishers (double oldScale, double newScale, bool wasStatic, bool isStatic)
 
virtual void adjustProtocolVersionToSend (int pduDisVersion)
 
virtual void resetProtocolVersionToSend ()
 
- Protected Member Functions inherited from MAKLogger::DtLgrSimOutput
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...
 

Protected Attributes

DtLgrDisSimulationManagermyDisManager
 
ObjectPublisherMap myObjectPublisherMap
 
DtLgrDisMessageIOInfomyMessageInfo
 The protocol specific information about the output. More...
 
bool myOutputStatic
 Whether output should be static. More...
 
bool myIsPaused
 Tape is paused. More...
 
int mySendCount
 Mutable internal counter. More...
 
int myDefaultDISVersion
 
- Protected Attributes inherited from MAKLogger::DtLgrSimOutput
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
 
DtLgrSimManagermyManager
 
bool myActivateFlag
 
- Protected Attributes inherited from MAKLogger::DtMessageOutput
std::set< DtMessageFilter * > myFilters
 
DtObserveEvent< DtPacketmyPreOutputPacketEvent
 Event called before a packet is output. More...
 
DtObserveEvent< DtPacketmyPostOutputPacketEvent
 Event called after a packet is output. More...
 
DtObserveEvent< DtPacketmyFilteredPacketEvent
 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

 DtLgrDisSimOutput (const DtLgrDisSimOutput &)
 Not Implemented. More...
 
DtLgrDisSimOutputoperator= (const DtLgrDisSimOutput &)
 Not Implemented. More...
 

Additional Inherited Members

- Public Types inherited from MAKLogger::DtLgrSimOutput
enum  PacketSenderType { Immediate, Retained, Initial, NotSent }
 

Detailed Description

DIS simulation output.

Member Typedef Documentation

typedef std::pair<DtPduKind,DtObjectId> MAKLogger::DtLgrDisSimOutput::UniqueObjectId
protected

Constructor & Destructor Documentation

virtual MAKLogger::DtLgrDisSimOutput::~DtLgrDisSimOutput ( )
virtual
MAKLogger::DtLgrDisSimOutput::DtLgrDisSimOutput ( const DtLgrDisSimOutput )
private

Not Implemented.

Member Function Documentation

virtual void MAKLogger::DtLgrDisSimOutput::activateImplementation ( )
virtual

Active the implementation of SimOutput.

This function is called by simOutput's activate function.

Implements MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtLgrDisSimOutput::adjustProtocolVersionToSend ( int  pduDisVersion)
protectedvirtual
virtual void MAKLogger::DtLgrDisSimOutput::clearPublishers ( )
protectedvirtual

Clear any publishers from output.

Implements MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtLgrDisSimOutput::deactivateImplementation ( )
virtual

Deactivate implementation of SimOutput.

This function is called by simOutput's deactivate function.

Implements MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtLgrDisSimOutput::disconnecting ( )
virtual

Called when the connection is being lost.

virtual DtTime MAKLogger::DtLgrDisSimOutput::exConnSimTime ( ) const
virtual

Set/Get the exercise connection simTime.

Implements MAKLogger::DtLgrSimOutput.

virtual DtExerciseConn* MAKLogger::DtLgrDisSimOutput::exerciseConn ( )
virtual

The manager's exercise connection.

virtual const DtExerciseConn* MAKLogger::DtLgrDisSimOutput::exerciseConn ( ) const
virtual

The manager's exercise connection const.

virtual void MAKLogger::DtLgrDisSimOutput::filterMessage ( DtPacket packet)
virtual

Apply filter flags to message buffer.

Reimplemented from MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtLgrDisSimOutput::flush ( )
virtual

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

Implements MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrDisSimOutput::getUpdates ( DtMessageBuffer stateBuffer,
const DtAbsoluteTime time 
)
protectedvirtual

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

Implements MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtLgrDisSimOutput::immediateSend ( const DtPacket ) const
protectedvirtual

Immediate send aka Interactions.

Implements MAKLogger::DtLgrSimOutput.

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

Return the output's ioinfo.

Implements MAKLogger::DtMessageOutput.

DtLgrDisSimOutput& MAKLogger::DtLgrDisSimOutput::operator= ( const DtLgrDisSimOutput )
private

Not Implemented.

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

Return the packet sender type of the specified packet.

Implements MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtLgrDisSimOutput::parsePacket ( const DtPacket packet)
protectedvirtual
virtual void MAKLogger::DtLgrDisSimOutput::parsePdu ( const DtPdu *  pdu) const
protectedvirtual
virtual void MAKLogger::DtLgrDisSimOutput::removeEntity ( const DtString &  name)
virtual
virtual void MAKLogger::DtLgrDisSimOutput::removeEntity ( DtPduKind  kind,
DtObjectId  id 
)
virtual
virtual void MAKLogger::DtLgrDisSimOutput::removeEntity ( DtConstLgrDisMessage )
virtual
virtual void MAKLogger::DtLgrDisSimOutput::rescalePublishers ( double  oldScale,
double  newScale,
bool  wasStatic,
bool  isStatic 
)
protectedvirtual
virtual void MAKLogger::DtLgrDisSimOutput::resetProtocolVersionToSend ( )
protectedvirtual
virtual void MAKLogger::DtLgrDisSimOutput::retainedSend ( const DtPacket )
protectedvirtual

Retained message send, aka Object updates.

Implements MAKLogger::DtLgrSimOutput.

virtual void MAKLogger::DtLgrDisSimOutput::sendPacket ( const DtPacket )
protectedvirtual

Send a packet.

Reimplemented from MAKLogger::DtLgrSimOutput.

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

Set/Get the exercise connection simTime.

Implements MAKLogger::DtLgrSimOutput.

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

Set an output scaling value and static indicator.

Implements MAKLogger::DtMessageOutput.

virtual void MAKLogger::DtLgrDisSimOutput::updateEntity ( DtConstLgrDisMessage )
protectedvirtual

Member Data Documentation

int MAKLogger::DtLgrDisSimOutput::myDefaultDISVersion
protected
DtLgrDisSimulationManager& MAKLogger::DtLgrDisSimOutput::myDisManager
protected
bool MAKLogger::DtLgrDisSimOutput::myIsPaused
protected

Tape is paused.

DtLgrDisMessageIOInfo* MAKLogger::DtLgrDisSimOutput::myMessageInfo
protected

The protocol specific information about the output.

ObjectPublisherMap MAKLogger::DtLgrDisSimOutput::myObjectPublisherMap
protected
bool MAKLogger::DtLgrDisSimOutput::myOutputStatic
protected

Whether output should be static.

int MAKLogger::DtLgrDisSimOutput::mySendCount
mutableprotected

Mutable internal counter.


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

Document ID: Generated on Thu Dec 18 15:35:09 EST 2025 from SVN revision 282494
Copyright © 2024 MAK Technologies. All Rights Reserved (www.mak.com)