dtGame::LogStatus Class Reference

A simple data class for basic Log Status information. More...

#include <logstatus.h>

List of all members.

Public Types
typedef std::vector< std::string >	NameVector
Public Member Functions
	LogStatus ()
virtual	~LogStatus ()
const LogStateEnumeration &	GetStateEnum () const
	Get the state enum.
void	SetStateEnum (const LogStateEnumeration &newStateEnum)
	Set the state enum.
double	GetCurrentSimTime () const
	Gets the current simulation time as believed by the server component (as opposed to real time).
void	SetCurrentSimTime (double newCurrentSimTime)
	Sets the current simulation time as believed by the server component (as opposed to real time).
const NameVector &	GetActiveMaps () const
	Gets the map name list that was active when this status was created.
void	SetActiveMaps (const NameVector &newActiveMap)
	Sets the active map names.
const std::string &	GetLogFile () const
	Gets the log file.
void	SetLogFile (const std::string &newLogFile)
	Sets the log file.
double	GetAutoRecordKeyframeInterval () const
	Gets the auto record keyframe interval.
void	SetAutoRecordKeyframeInterval (double newAutoRecordKeyframeInterval)
	Sets the auto record keyframe interval.
double	GetCurrentRecordDuration () const
	Sets the length (in seconds) of the current recording.
void	SetCurrentRecordDuration (double newCurrentRecordDuration)
	Sets the length (in seconds) of the current recording.
unsigned long	GetNumMessages () const
	Gets the number of messages that have been processed/sent by the server logger component.
void	SetNumMessages (unsigned long numMessages)
	Sets the number of messages that have been processed/sent by the server logger component.
Friends
std::ostream &	operator<< (std::ostream &stream, const LogStatus &me)
	Prints the log status to a stream.

---

Detailed Description

A simple data class for basic Log Status information.

This class has a copy constructor plus the = operator.

---

Member Typedef Documentation

typedef std::vector<std::string> dtGame::LogStatus::NameVector

---

Constructor & Destructor Documentation

dtGame::LogStatus::LogStatus

(

)

virtual dtGame::LogStatus::~LogStatus

(

)

[inline, virtual]

---

Member Function Documentation

const LogStateEnumeration& dtGame::LogStatus::GetStateEnum

(

)

const [inline]

Get the state enum.

This indicates the server logger component's recording/playback/idle state.

Returns:

The server logger comonent's state.

void dtGame::LogStatus::SetStateEnum

(

const LogStateEnumeration &

newStateEnum

)

[inline]

Set the state enum.

This is typically set by the server and indicates the server logger components state.

Parameters:

newStateEnum

the new state.

double dtGame::LogStatus::GetCurrentSimTime

(

)

const [inline]

Gets the current simulation time as believed by the server component (as opposed to real time).

Returns:

The server's believed simulation time stamp (as opposed to real time)

void dtGame::LogStatus::SetCurrentSimTime

(

double

newCurrentSimTime

)

[inline]

Sets the current simulation time as believed by the server component (as opposed to real time).

Parameters:

The

new simulation time stamp (as opposed to real time)

const NameVector& dtGame::LogStatus::GetActiveMaps

(

)

const [inline]

Gets the map name list that was active when this status was created.

Returns:

The map vector

void dtGame::LogStatus::SetActiveMaps

(

const NameVector &

newActiveMap

)

Sets the active map names.

Parameters:

The

map name

const std::string& dtGame::LogStatus::GetLogFile

(

)

const [inline]

Gets the log file.

Returns:

The logfile

void dtGame::LogStatus::SetLogFile

(

const std::string &

newLogFile

)

[inline]

Sets the log file.

Parameters:

The

new log file

double dtGame::LogStatus::GetAutoRecordKeyframeInterval

(

)

const [inline]

Gets the auto record keyframe interval.

0 indicates no automatic interval. Any non-0 means that the server will attempt to make a keyframe every X seconds. Only the server should set this value.

Returns:

The keyframe auto record interval (in seconds)

void dtGame::LogStatus::SetAutoRecordKeyframeInterval

(

double

newAutoRecordKeyframeInterval

)

[inline]

Sets the auto record keyframe interval.

0 indicates no automatic interval. Any non-0 means that the server will attempt to make a keyframe every X seconds. Only the server should set this value.

Parameters:

The

new auto record keyframe interval (in seconds)

double dtGame::LogStatus::GetCurrentRecordDuration

(

)

const [inline]

Sets the length (in seconds) of the current recording.

This should only be non-zero during a record session. This should ONLY be set by the server log component.

Returns:

The length of the current record (in seconds).

void dtGame::LogStatus::SetCurrentRecordDuration

(

double

newCurrentRecordDuration

)

[inline]

Sets the length (in seconds) of the current recording.

This should only be non-zero during a record session. This should ONLY be set by the server log component.

Parameters:

The

length of the current record (in seconds).

unsigned long dtGame::LogStatus::GetNumMessages

(

)

const [inline]

Gets the number of messages that have been processed/sent by the server logger component.

Returns:

The number of messages.

void dtGame::LogStatus::SetNumMessages

(

unsigned long

numMessages

)

[inline]

Sets the number of messages that have been processed/sent by the server logger component.

This should only be set by the server logger component itself.

Parameters:

numMessages

The number of messages.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	stream,
		const LogStatus &	me
	)			[friend]

Prints the log status to a stream.

Parameters:

	stream	Standard stream
	me	The log status object to print.

---