MAK Data Logger API Documentation for HLA
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtRemoteLoggerConnection Class Reference

Instances of DtRemoteLoggerConnection are a family of messages used to control a remote instance of the MAK-Logger over the network. More...

+ Collaboration diagram for DtRemoteLoggerConnection:

Public Member Functions

 DtRemoteLoggerConnection ()
 (default) constructor
 DtRemoteLoggerConnection (const DtEntityIdentifier &loggerId, const DtString &loggerName)
 Constructor.
virtual ~DtRemoteLoggerConnection ()
 destructor
 DtRemoteLoggerConnection (const DtRemoteLoggerConnection &src)
 copy constructor
DtRemoteLoggerConnectionoperator= (const DtRemoteLoggerConnection &src)
 assignment operator
bool operator< (const DtRemoteLoggerConnection &rhs) const
 less than
virtual void updateInfo (const DtLgrTotalStatePdu &totalState)
 Update the information using the given PDU data.
virtual void printDataToStream (std::ostream &stream) const
 Print contents.
virtual const DtEntityIdentifier & id () const
 Set/Get logger ID.
virtual void setId (const DtEntityIdentifier &val)
 Set/Get logger ID.
virtual const DtStringname () const
 Set/Get logger name.
virtual void setName (const DtString &val)
 Set/Get logger name.
virtual DtTime time () const
 Set/Get logger time within the tape.
virtual void setTime (DtTime value)
 Set/Get logger time within the tape.
virtual DtTime idealTime () const
 Set/Get logger time of execution.
virtual void setIdealTime (DtTime value)
 Set/Get logger time of execution.
virtual double scale () const
 Set/Get logger playback scaling factor (speed) Undefined for recording.
virtual void setScale (double sc)
 Set/Get logger playback scaling factor (speed) Undefined for recording.
virtual DtTime fileLength () const
 Set/Get logger file length in time (last time) Undefined for recording.
virtual void setFileLength (DtTime value)
 Set/Get logger file length in time (last time) Undefined for recording.
virtual DtTime heartbeat () const
 Set/Get heartbeat interval for entities (DIS only)
virtual void setHeartbeat (DtTime value)
 Set/Get heartbeat interval for entities (DIS only)
virtual DtTime timeout () const
 Set/Get timeout interval for entities (DIS only)
virtual void setTimeout (DtTime value)
 Set/Get timeout interval for entities (DIS only)
virtual bool dataScaling () const
 Set/Get whether attributes are set to scale based on scale factor.
virtual void setDataScaling (bool isEnabled)
 Set/Get whether attributes are set to scale based on scale factor.
virtual DtLgrFilePosition filePos () const
 Set/Get logger file position.
virtual void setFilePos (DtLgrFilePosition pos)
 Set/Get logger file position.
virtual DtLgrMode mode () const
 Set/Get logger mode.
virtual void setMode (DtLgrMode value)
 Set/Get logger mode.
virtual DtLgrMode playAction () const
 Set/Get logger action when a file is opened for playback.
virtual void setPlayAction (DtLgrMode value)
 Set/Get logger action when a file is opened for playback.
virtual DtLgrMode recordAction () const
 Set/Get logger action when a file is opened for record.
virtual void setRecordAction (DtLgrMode value)
 Set/Get logger action when a file is opened for record.
virtual DtLgrMode eofAction () const
 Set/Get logger action when playback EOF is reached.
virtual void setEofAction (DtLgrMode value)
 Set/Get logger action when playback EOF is reached.
virtual bool timeConstrained () const
 Set/Get whether logger is time constrained.
virtual void setTimeConstrained (bool isEnabled)
 Set/Get whether logger is time constrained.
virtual bool timeRegulated () const
 Set/Get whether logger is time regulating.
virtual void setTimeRegulated (bool isEnabled)
 Set/Get whether logger is time regulating.
virtual bool usingOwnFedAmb () const
 Set/Get whether logger is using its own Fed. Amb. (HLA only)
virtual void setUsingOwnFedAmb (bool isEnabled)
 Set/Get whether logger is using its own Fed. Amb. (HLA only)
virtual const char * lgrFile () const
 Set/Get name of file being played back or recorded.
virtual void setLgrFile (const DtString &name)
 Set/Get name of file being played back or recorded.
virtual const char * annotationsFile () const
 Set/Get name of annotations file.
virtual void setAnnotationsFile (const DtString &name)
 Set/Get name of annotations file.
virtual DtTime lastUpdateTime () const
 Set/Get time of the last update Deprecated - undefined.
virtual void setLastUpdateTime (DtTime value)
 Set/Get time of the last update Deprecated - undefined.
virtual int protocol ()
 Set/Get protocol of Logger.
virtual void setProtocol (int protocolNumber)
 Set/Get protocol of Logger.

Protected Attributes

DtEntityIdentifier myId
DtString myName
DtTime myTime
DtTime myLastUpdateTime
DtLgrFilePosition myFilePosition
DtLgrMode myMode
DtTime myIdealTime
double myScale
DtTime myFileLength
DtTime myHeartbeat
DtTime myTimeout
bool myDataScaling
DtLgrFilePosition myFilePos
DtLgrMode myPlayAction
DtLgrMode myRecordAction
DtLgrMode myEofAction
bool myTimeConstrained
bool myTimeRegulated
bool myUsingOwnFedAmb
DtString myLgrFile
DtString myAnnotationsFile
int myProtocol

Detailed Description

Instances of DtRemoteLoggerConnection are a family of messages used to control a remote instance of the MAK-Logger over the network.

See lc*.h.

Constructor & Destructor Documentation

DtRemoteLoggerConnection::DtRemoteLoggerConnection ( )

(default) constructor

DtRemoteLoggerConnection::DtRemoteLoggerConnection ( const DtEntityIdentifier &  loggerId,
const DtString loggerName 
)

Constructor.

virtual DtRemoteLoggerConnection::~DtRemoteLoggerConnection ( )
virtual

destructor

DtRemoteLoggerConnection::DtRemoteLoggerConnection ( const DtRemoteLoggerConnection src)

copy constructor

Member Function Documentation

virtual const char* DtRemoteLoggerConnection::annotationsFile ( ) const
virtual

Set/Get name of annotations file.

virtual bool DtRemoteLoggerConnection::dataScaling ( ) const
virtual

Set/Get whether attributes are set to scale based on scale factor.

virtual DtLgrMode DtRemoteLoggerConnection::eofAction ( ) const
virtual

Set/Get logger action when playback EOF is reached.

virtual DtTime DtRemoteLoggerConnection::fileLength ( ) const
virtual

Set/Get logger file length in time (last time) Undefined for recording.

virtual DtLgrFilePosition DtRemoteLoggerConnection::filePos ( ) const
virtual

Set/Get logger file position.

virtual DtTime DtRemoteLoggerConnection::heartbeat ( ) const
virtual

Set/Get heartbeat interval for entities (DIS only)

virtual const DtEntityIdentifier& DtRemoteLoggerConnection::id ( ) const
virtual

Set/Get logger ID.

virtual DtTime DtRemoteLoggerConnection::idealTime ( ) const
virtual

Set/Get logger time of execution.

virtual DtTime DtRemoteLoggerConnection::lastUpdateTime ( ) const
virtual

Set/Get time of the last update Deprecated - undefined.

virtual const char* DtRemoteLoggerConnection::lgrFile ( ) const
virtual

Set/Get name of file being played back or recorded.

virtual DtLgrMode DtRemoteLoggerConnection::mode ( ) const
virtual

Set/Get logger mode.

virtual const DtString& DtRemoteLoggerConnection::name ( ) const
virtual

Set/Get logger name.

bool DtRemoteLoggerConnection::operator< ( const DtRemoteLoggerConnection rhs) const

less than

DtRemoteLoggerConnection& DtRemoteLoggerConnection::operator= ( const DtRemoteLoggerConnection src)

assignment operator

virtual DtLgrMode DtRemoteLoggerConnection::playAction ( ) const
virtual

Set/Get logger action when a file is opened for playback.

virtual void DtRemoteLoggerConnection::printDataToStream ( std::ostream &  stream) const
virtual

Print contents.

virtual int DtRemoteLoggerConnection::protocol ( )
virtual

Set/Get protocol of Logger.

virtual DtLgrMode DtRemoteLoggerConnection::recordAction ( ) const
virtual

Set/Get logger action when a file is opened for record.

virtual double DtRemoteLoggerConnection::scale ( ) const
virtual

Set/Get logger playback scaling factor (speed) Undefined for recording.

virtual void DtRemoteLoggerConnection::setAnnotationsFile ( const DtString name)
virtual

Set/Get name of annotations file.

virtual void DtRemoteLoggerConnection::setDataScaling ( bool  isEnabled)
virtual

Set/Get whether attributes are set to scale based on scale factor.

virtual void DtRemoteLoggerConnection::setEofAction ( DtLgrMode  value)
virtual

Set/Get logger action when playback EOF is reached.

virtual void DtRemoteLoggerConnection::setFileLength ( DtTime  value)
virtual

Set/Get logger file length in time (last time) Undefined for recording.

virtual void DtRemoteLoggerConnection::setFilePos ( DtLgrFilePosition  pos)
virtual

Set/Get logger file position.

virtual void DtRemoteLoggerConnection::setHeartbeat ( DtTime  value)
virtual

Set/Get heartbeat interval for entities (DIS only)

virtual void DtRemoteLoggerConnection::setId ( const DtEntityIdentifier &  val)
virtual

Set/Get logger ID.

virtual void DtRemoteLoggerConnection::setIdealTime ( DtTime  value)
virtual

Set/Get logger time of execution.

virtual void DtRemoteLoggerConnection::setLastUpdateTime ( DtTime  value)
virtual

Set/Get time of the last update Deprecated - undefined.

virtual void DtRemoteLoggerConnection::setLgrFile ( const DtString name)
virtual

Set/Get name of file being played back or recorded.

virtual void DtRemoteLoggerConnection::setMode ( DtLgrMode  value)
virtual

Set/Get logger mode.

virtual void DtRemoteLoggerConnection::setName ( const DtString val)
virtual

Set/Get logger name.

virtual void DtRemoteLoggerConnection::setPlayAction ( DtLgrMode  value)
virtual

Set/Get logger action when a file is opened for playback.

virtual void DtRemoteLoggerConnection::setProtocol ( int  protocolNumber)
virtual

Set/Get protocol of Logger.

virtual void DtRemoteLoggerConnection::setRecordAction ( DtLgrMode  value)
virtual

Set/Get logger action when a file is opened for record.

virtual void DtRemoteLoggerConnection::setScale ( double  sc)
virtual

Set/Get logger playback scaling factor (speed) Undefined for recording.

virtual void DtRemoteLoggerConnection::setTime ( DtTime  value)
virtual

Set/Get logger time within the tape.

virtual void DtRemoteLoggerConnection::setTimeConstrained ( bool  isEnabled)
virtual

Set/Get whether logger is time constrained.

virtual void DtRemoteLoggerConnection::setTimeout ( DtTime  value)
virtual

Set/Get timeout interval for entities (DIS only)

virtual void DtRemoteLoggerConnection::setTimeRegulated ( bool  isEnabled)
virtual

Set/Get whether logger is time regulating.

virtual void DtRemoteLoggerConnection::setUsingOwnFedAmb ( bool  isEnabled)
virtual

Set/Get whether logger is using its own Fed. Amb. (HLA only)

virtual DtTime DtRemoteLoggerConnection::time ( ) const
virtual

Set/Get logger time within the tape.

virtual bool DtRemoteLoggerConnection::timeConstrained ( ) const
virtual

Set/Get whether logger is time constrained.

virtual DtTime DtRemoteLoggerConnection::timeout ( ) const
virtual

Set/Get timeout interval for entities (DIS only)

virtual bool DtRemoteLoggerConnection::timeRegulated ( ) const
virtual

Set/Get whether logger is time regulating.

virtual void DtRemoteLoggerConnection::updateInfo ( const DtLgrTotalStatePdu totalState)
virtual

Update the information using the given PDU data.

virtual bool DtRemoteLoggerConnection::usingOwnFedAmb ( ) const
virtual

Set/Get whether logger is using its own Fed. Amb. (HLA only)

Member Data Documentation

DtString DtRemoteLoggerConnection::myAnnotationsFile
protected
bool DtRemoteLoggerConnection::myDataScaling
protected
DtLgrMode DtRemoteLoggerConnection::myEofAction
protected
DtTime DtRemoteLoggerConnection::myFileLength
protected
DtLgrFilePosition DtRemoteLoggerConnection::myFilePos
protected
DtLgrFilePosition DtRemoteLoggerConnection::myFilePosition
protected
DtTime DtRemoteLoggerConnection::myHeartbeat
protected
DtEntityIdentifier DtRemoteLoggerConnection::myId
protected
DtTime DtRemoteLoggerConnection::myIdealTime
protected
DtTime DtRemoteLoggerConnection::myLastUpdateTime
protected
DtString DtRemoteLoggerConnection::myLgrFile
protected
DtLgrMode DtRemoteLoggerConnection::myMode
protected
DtString DtRemoteLoggerConnection::myName
protected
DtLgrMode DtRemoteLoggerConnection::myPlayAction
protected
int DtRemoteLoggerConnection::myProtocol
protected
DtLgrMode DtRemoteLoggerConnection::myRecordAction
protected
double DtRemoteLoggerConnection::myScale
protected
DtTime DtRemoteLoggerConnection::myTime
protected
bool DtRemoteLoggerConnection::myTimeConstrained
protected
DtTime DtRemoteLoggerConnection::myTimeout
protected
bool DtRemoteLoggerConnection::myTimeRegulated
protected
bool DtRemoteLoggerConnection::myUsingOwnFedAmb
protected

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

Document ID: Generated on Thu Jul 23 15:05:27 EDT 2020 from SVN revision 215371
Copyright © 2020 MAK Technologies. All Rights Reserved (www.mak.com)