dtGame::LogStatusMessage Class Reference

This message class is sent by the ServerLoggerComponent - it has logger status info; it provides the complete status of the server logger component. More...

#include <loggermessages.h>

Inheritance diagram for dtGame::LogStatusMessage:

List of all members.

Public Member Functions
	LogStatusMessage ()
LogStatus	GetStatus () const
	Creates a LogStatus and populates it with the Status values from the message.
void	SetStatus (const LogStatus &status)
	Sets the Status parameters from the passed in LogStatus (server only).
Protected Member Functions
virtual	~LogStatusMessage ()

---

Detailed Description

This message class is sent by the ServerLoggerComponent - it has logger status info; it provides the complete status of the server logger component.

Can be sent at anytime. Can ONLY be sent by the server. All information is from the server logger's perspective. The same message is used for status for all states, so not all parameters will always be relevant. Note that this message wraps the status params with a LogStatus object.

Related Message Types: LOG_INFO_STATUS
Parameter: CurrentSimTime: The server's current sim time (always set, any state, double).
Parameter: ActiveMaps: The current loaded set (may be empty, any state, string).
Parameter: LogFile: The current log file (may be empty, any state, string).
Parameter: AutoRecordKeyframeInterval: Interval between automatic keyframes. Zero means no auto keyframes. (record only, double).
Parameter: EstPlaybackTimeRemaining: Estimated time remaining for playback of cur file (playback only, double).
Parameter: CurrentRecordDuration: Current length of the active recoring (record only, double).
Parameter: NumRecordedMessages: Number of messages logged in current recording (record only, unsigned long).

---

Constructor & Destructor Documentation

dtGame::LogStatusMessage::LogStatusMessage

(

)

virtual dtGame::LogStatusMessage::~LogStatusMessage

(

)

[inline, protected, virtual]

---

Member Function Documentation

LogStatus dtGame::LogStatusMessage::GetStatus

(

)

const

Creates a LogStatus and populates it with the Status values from the message.

Returns:

A Status object with the message's parameter values.

void dtGame::LogStatusMessage::SetStatus

(

const LogStatus &

status

)

Sets the Status parameters from the passed in LogStatus (server only).

Parameters:

status

The Status object - the status attributes will be set on the message

---