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 Member Functions | Protected Attributes
MAKLogger::DtDisLogger Class Reference

DtDISLogger is a DIS interface for creating a logger. More...

+ Inheritance diagram for MAKLogger::DtDisLogger:
+ Collaboration diagram for MAKLogger::DtDisLogger:

Public Member Functions

virtual ~DtDisLogger ()
 Creates a DIS Logger and optionally initializes it. More...
 
virtual void init ()
 Init the Dis Logger. More...
 
virtual void setNetmask (const DtString &netmaskString)
 Temporary workaround for connection netmask parameter that is missing from exercise connection initializer. More...
 
virtual const DtString & netmask () const
 Netmask that has been set (default is empty string). More...
 
void connect (DtExerciseConnInitializer &exConnInit)
 Tell the logger to connect using an Exercise Connection Initializer. More...
 
virtual bool tick ()
 Tick the logger once, function is non-blocking. More...
 
- Public Member Functions inherited from MAKLogger::DtLogger
virtual ~DtLogger ()
 
virtual void registerSimulationProtocol (DtLgrProtocolRegistration *)
 This method must be called by a simulation plug-in during initialization. More...
 
virtual const
DtLgrProtocolRegistration
simulationProtocol () const
 Gets the protocol registration the logger was registered with. More...
 
virtual DtRelativeTime tickTime () const
 Get the estimated time between ticks. More...
 
virtual void setTickTime (DtRelativeTime time)
 Set the estimated time between tick calls. More...
 
virtual void submitCommand (const DtCommand &command)
 Send a command to the logger to execute. More...
 
virtual DtLgrCommandHandlerSP getCommandHandler (const DtLgrCommandType &type) const
 Lookup the command handler for a specific type of command. More...
 
virtual const DtLibraryListlibraries () const
 Gets the Loaded libraries. More...
 
virtual DtLgrSimManagersimManager ()
 Access simulation manager;. More...
 
DtLgrSystemDriverdriver ()
 Get system driver. More...
 

Protected Member Functions

 DtDisLogger ()
 Protected CTOR. More...
 

Protected Attributes

DtLgrDisSimInterfacemySimInterface
 
DtString myNetmask
 
- Protected Attributes inherited from MAKLogger::DtLogger
DtLgrProtocolRegistrationmyRegistration
 
DtLgrSystemDrivermyDriver
 The driver which defines the logger executions. More...
 
DtRelativeTime myTickTime
 The time between ticks. More...
 

Additional Inherited Members

- Static Protected Attributes inherited from MAKLogger::DtLogger
static DtRelativeTime theDefaultTickTime
 Default tick time. More...
 

Detailed Description

DtDISLogger is a DIS interface for creating a logger.

Automatically registers the DIS protocol with the logger and provides helper functions.

Constructor & Destructor Documentation

virtual MAKLogger::DtDisLogger::~DtDisLogger ( )
virtual

Creates a DIS Logger and optionally initializes it.

After initialization no additional drivers may be added. Destructor for the logger.

MAKLogger::DtDisLogger::DtDisLogger ( )
protected

Protected CTOR.

Exceptions
DtCorruptedStateis thrown when unable to construct logger.

Member Function Documentation

void MAKLogger::DtDisLogger::connect ( DtExerciseConnInitializer &  exConnInit)

Tell the logger to connect using an Exercise Connection Initializer.

virtual void MAKLogger::DtDisLogger::init ( )
virtual

Init the Dis Logger.

Calls base init, then creates sim interface.

Exceptions
DtCorruptedState

Reimplemented from MAKLogger::DtLogger.

virtual const DtString& MAKLogger::DtDisLogger::netmask ( ) const
virtual

Netmask that has been set (default is empty string).

virtual void MAKLogger::DtDisLogger::setNetmask ( const DtString &  netmaskString)
virtual

Temporary workaround for connection netmask parameter that is missing from exercise connection initializer.

virtual bool MAKLogger::DtDisLogger::tick ( )
virtual

Tick the logger once, function is non-blocking.

This causes the logger to tick for one round of execution. Typically an application will have a loop where it ticks the logger.

Returns
Returns whether the logger should continue to be ticked.
Return values
trueThe logger can still tick.
falseThe logger should exit.

Reimplemented from MAKLogger::DtLogger.

Member Data Documentation

DtString MAKLogger::DtDisLogger::myNetmask
protected
DtLgrDisSimInterface* MAKLogger::DtDisLogger::mySimInterface
protected

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)