dtGame::MachineInfo Class Reference

A data class representing basic machine information. More...

#include <machineinfo.h>

List of all members.

Public Member Functions
	MachineInfo (const std::string &name="")
	Constructor.
const std::string &	GetName () const
	Gets the name of a machine info.
const std::string &	GetHostName () const
	Gets the host name of a machine info.
const std::string &	GetIPAddress () const
	Gets the ip address of a machine info.
unsigned long	GetTimeStamp () const
	Gets the timestamp of the last time this machine was heard from.
unsigned int	GetPing () const
	Gets the ping of a machine info.
const dtCore::UniqueId &	GetUniqueId () const
	Gets the unique id of a machine info.
void	SetName (const std::string &newName)
	Sets the name of a machine info.
void	SetHostName (const std::string &newHostName)
	Sets the host name of a machine info.
void	SetIPAddress (const std::string &newIPAddress)
	Sets the ip address of a machine info.
void	SetTimeStamp (unsigned long newTimeStamp)
	Sets the time stamp of a machine info.
void	SetPing (unsigned int newPing)
	Sets the ping of a machine info.
void	SetUniqueId (const dtCore::UniqueId &newId)
	Sets the unique id of a machine info.
MachineInfo &	operator= (const MachineInfo &assignFrom)
bool	operator== (const MachineInfo &compareTo) const
bool	operator!= (const MachineInfo &compareTo) const
bool	operator< (const MachineInfo &compareTo) const
bool	operator> (const MachineInfo &compareTo) const
Protected Member Functions
virtual	~MachineInfo ()

---

Detailed Description

A data class representing basic machine information.

---

Constructor & Destructor Documentation

dtGame::MachineInfo::MachineInfo

(

const std::string &

name = ""

)

[inline]

Constructor.

virtual dtGame::MachineInfo::~MachineInfo

(

)

[inline, protected, virtual]

---

Member Function Documentation

const std::string& dtGame::MachineInfo::GetName

(

)

const [inline]

Gets the name of a machine info.

Returns:

The name

const std::string& dtGame::MachineInfo::GetHostName

(

)

const [inline]

Gets the host name of a machine info.

Returns:

The host name

const std::string& dtGame::MachineInfo::GetIPAddress

(

)

const [inline]

Gets the ip address of a machine info.

Returns:

The ip address

unsigned long dtGame::MachineInfo::GetTimeStamp

(

)

const [inline]

Gets the timestamp of the last time this machine was heard from.

Returns:

The time stamp

unsigned int dtGame::MachineInfo::GetPing

(

)

const [inline]

Gets the ping of a machine info.

Returns:

The ping time, in milliseconds

const dtCore::UniqueId& dtGame::MachineInfo::GetUniqueId

(

)

const [inline]

Gets the unique id of a machine info.

Returns:

The unique id

See also:

dtCore::UniqueId

void dtGame::MachineInfo::SetName

(

const std::string &

newName

)

[inline]

Sets the name of a machine info.

Parameters:

The

new name

void dtGame::MachineInfo::SetHostName

(

const std::string &

newHostName

)

[inline]

Sets the host name of a machine info.

Parameters:

The

new host name

void dtGame::MachineInfo::SetIPAddress

(

const std::string &

newIPAddress

)

[inline]

Sets the ip address of a machine info.

Parameters:

The

new ip address

void dtGame::MachineInfo::SetTimeStamp

(

unsigned long

newTimeStamp

)

[inline]

Sets the time stamp of a machine info.

Parameters:

The

new time stamp

void dtGame::MachineInfo::SetPing

(

unsigned int

newPing

)

[inline]

Sets the ping of a machine info.

Parameters:

The

new ping, in milliseconds

void dtGame::MachineInfo::SetUniqueId

(

const dtCore::UniqueId &

newId

)

[inline]

Sets the unique id of a machine info.

Parameters:

The

new unique id

MachineInfo& dtGame::MachineInfo::operator=

(

const MachineInfo &

assignFrom

)

[inline]

bool dtGame::MachineInfo::operator==

(

const MachineInfo &

compareTo

)

const [inline]

bool dtGame::MachineInfo::operator!=

(

const MachineInfo &

compareTo

)

const [inline]

bool dtGame::MachineInfo::operator<

(

const MachineInfo &

compareTo

)

const [inline]

bool dtGame::MachineInfo::operator>

(

const MachineInfo &

compareTo

)

const [inline]

---