dtGame::LogKeyframe Class Reference

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

#include <logkeyframe.h>

List of all members.

Public Types
typedef std::vector< std::string >	NameVector
Public Member Functions
	LogKeyframe ()
virtual	~LogKeyframe ()
const std::string &	GetName () const
	Gets the name.
void	SetName (const std::string &newName)
	Sets the name.
const std::string &	GetDescription () const
	Gets the description.
void	SetDescription (const std::string &newDescription)
	Sets the description.
double	GetSimTimeStamp () const
	Gets the simulation timestamp (as opposed to real time).
void	SetSimTimeStamp (double newSimTimeStamp)
	Sets the sim time stamp (as opposed to real time).
const dtCore::UniqueId &	GetUniqueId () const
	Gets the unique id.
void	SetUniqueId (const dtCore::UniqueId &newId)
	Sets the unique id.
void	SetTagUniqueId (const dtCore::UniqueId &tagId)
	Sets the id of the tag owning this keyframe.
const dtCore::UniqueId &	GetTagUniqueId () const
	Gets the uniqueid of the tag owning this keyframe is one exists.
const NameVector &	GetActiveMaps () const
	Gets the map name that was active when this keyframe was generated.
void	SetActiveMaps (const NameVector &newActiveMaps)
	Sets the map name that was active when this keyframe was generated.
long	GetLogFileOffset () const
	Gets the file offset used by the server.
void	SetLogFileOffset (long newLogFileOffset)
	Sets the file offset used by the server.
bool	operator== (const LogKeyframe &compareTo) const
bool	operator!= (const LogKeyframe &compareTo) const
bool	operator< (const LogKeyframe &compareTo) const
bool	operator> (const LogKeyframe &compareTo) const

---

Detailed Description

A simple data class for basic Log Keyframe information.

This class has a copy constructor plus ==, !=, =, <, and > operators.

---

Member Typedef Documentation

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

---

Constructor & Destructor Documentation

dtGame::LogKeyframe::LogKeyframe

(

)

[inline]

virtual dtGame::LogKeyframe::~LogKeyframe

(

)

[inline, virtual]

---

Member Function Documentation

const std::string& dtGame::LogKeyframe::GetName

(

)

const [inline]

Gets the name.

Returns:

The name

void dtGame::LogKeyframe::SetName

(

const std::string &

newName

)

[inline]

Sets the name.

Parameters:

The

new name

const std::string& dtGame::LogKeyframe::GetDescription

(

)

const [inline]

Gets the description.

Returns:

The description

void dtGame::LogKeyframe::SetDescription

(

const std::string &

newDescription

)

[inline]

Sets the description.

Parameters:

The

new description

double dtGame::LogKeyframe::GetSimTimeStamp

(

)

const [inline]

Gets the simulation timestamp (as opposed to real time).

Returns:

The simulation based time stamp (as opposed to real time)

void dtGame::LogKeyframe::SetSimTimeStamp

(

double

newSimTimeStamp

)

[inline]

Sets the sim time stamp (as opposed to real time).

Parameters:

The

new simulation time stamp (as opposed to real time)

const dtCore::UniqueId& dtGame::LogKeyframe::GetUniqueId

(

)

const [inline]

Gets the unique id.

Returns:

The unique id

See also:

dtCore::UniqueId

void dtGame::LogKeyframe::SetUniqueId

(

const dtCore::UniqueId &

newId

)

[inline]

Sets the unique id.

Parameters:

The

new unique id

void dtGame::LogKeyframe::SetTagUniqueId

(

const dtCore::UniqueId &

tagId

)

[inline]

Sets the id of the tag owning this keyframe.

Parameters:

The

unique id for a tag owning this keyframe or an empty id if there is no owner tag.

const dtCore::UniqueId& dtGame::LogKeyframe::GetTagUniqueId

(

)

const [inline]

Gets the uniqueid of the tag owning this keyframe is one exists.

Returns:

A valid identifier for the tag or an empty identifier if no tag currently owns this keyframe.

const NameVector& dtGame::LogKeyframe::GetActiveMaps

(

)

const [inline]

Gets the map name that was active when this keyframe was generated.

Returns:

The map vector

void dtGame::LogKeyframe::SetActiveMaps

(

const NameVector &

newActiveMaps

)

[inline]

Sets the map name that was active when this keyframe was generated.

Parameters:

The

map name

long dtGame::LogKeyframe::GetLogFileOffset

(

)

const [inline]

Gets the file offset used by the server.

Note that this value is only relevant to the server logger component. Anyone else doesn't have access to the relevant file. This is not part of the message params.

Returns:

The server's file offset for the keyframe

void dtGame::LogKeyframe::SetLogFileOffset

(

long

newLogFileOffset

)

[inline]

Sets the file offset used by the server.

Note that this value is only relevant to the server logger component. Anyone else doesn't have access to the relevant file. Should only be called by the server. This is not part of the message params.

Parameters:

The

new server file offset value

bool dtGame::LogKeyframe::operator==

(

const LogKeyframe &

compareTo

)

const [inline]

bool dtGame::LogKeyframe::operator!=

(

const LogKeyframe &

compareTo

)

const [inline]

bool dtGame::LogKeyframe::operator<

(

const LogKeyframe &

compareTo

)

const [inline]

bool dtGame::LogKeyframe::operator>

(

const LogKeyframe &

compareTo

)

const [inline]

---