dtGame::LogTag Class Reference

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

#include <logtag.h>

List of all members.

Public Member Functions
virtual	~LogTag ()
	LogTag ()
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	SetKeyframeUniqueId (const dtCore::UniqueId &newId)
	Sets the id of the keyframe associated with this tag.
const dtCore::UniqueId &	GetKeyframeUniqueId () const
	Gets the id of the keyframe associated with this tag.
void	SetCaptureKeyframe (bool flag)
	Sets whether or not this tag should tell the system to capture a keyframe when it is inserted into the log stream.
bool	GetCaptureKeyframe () const
	Gets whether or not this tag has a keyframe associated with it.
bool	operator== (const LogTag &compareTo) const
bool	operator!= (const LogTag &compareTo) const
bool	operator< (const LogTag &compareTo) const
bool	operator> (const LogTag &compareTo) const

---

Detailed Description

A simple data class for basic Log Tag information.

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

---

Constructor & Destructor Documentation

virtual dtGame::LogTag::~LogTag

(

)

[inline, virtual]

dtGame::LogTag::LogTag

(

)

[inline]

---

Member Function Documentation

const std::string& dtGame::LogTag::GetName

(

)

const [inline]

Gets the name.

Returns:

The name

void dtGame::LogTag::SetName

(

const std::string &

newName

)

[inline]

Sets the name.

Parameters:

The

new name

const std::string& dtGame::LogTag::GetDescription

(

)

const [inline]

Gets the description.

Returns:

The description

void dtGame::LogTag::SetDescription

(

const std::string &

newDescription

)

[inline]

Sets the description.

Parameters:

The

new description

double dtGame::LogTag::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::LogTag::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::LogTag::GetUniqueId

(

)

const [inline]

Gets the unique id.

Returns:

The unique id

See also:

dtCore::UniqueId

void dtGame::LogTag::SetUniqueId

(

const dtCore::UniqueId &

newId

)

[inline]

Sets the unique id.

Parameters:

The

new unique id

void dtGame::LogTag::SetKeyframeUniqueId

(

const dtCore::UniqueId &

newId

)

[inline]

Sets the id of the keyframe associated with this tag.

Parameters:

newId

Valid id of a keyframe or an empty id if no keyframe is associated with this tag.

const dtCore::UniqueId& dtGame::LogTag::GetKeyframeUniqueId

(

)

const [inline]

Gets the id of the keyframe associated with this tag.

Returns:

A valid identifier if a keyframe is present or an empty identifier if no keyframe is present.

void dtGame::LogTag::SetCaptureKeyframe

(

bool

flag

)

[inline]

Sets whether or not this tag should tell the system to capture a keyframe when it is inserted into the log stream.

Parameters:

flag

True if a keyframe should be captured.

bool dtGame::LogTag::GetCaptureKeyframe

(

)

const [inline]

Gets whether or not this tag has a keyframe associated with it.

Returns:

True if the tag has a keyframe, false otherwise.

bool dtGame::LogTag::operator==

(

const LogTag &

compareTo

)

const [inline]

bool dtGame::LogTag::operator!=

(

const LogTag &

compareTo

)

const [inline]

bool dtGame::LogTag::operator<

(

const LogTag &

compareTo

)

const [inline]

bool dtGame::LogTag::operator>

(

const LogTag &

compareTo

)

const [inline]

---