dtNetGM::MachineInfoMessage Class Reference

A MachineInfoMessage contains a dtGame::MachineInfo to be used with different messages to send information about a GameManager accross the network. More...

#include <machineinfomessage.h>

Inheritance diagram for dtNetGM::MachineInfoMessage:

List of all members.

Public Member Functions
	MachineInfoMessage ()
const std::string &	GetMachineInfoName () const
	Gets the Name from the contained MachineInfo.
void	SetMachineInfoName (const std::string &name)
	Sets the name associated with the MachineInfo.
const std::string &	GetUniqueId () const
	Gets the UniqueId from the contained MachineInfo as string.
void	SetUniqueId (const std::string &strId)
	Sets the UniqueId associated with the MachineInfo.
const std::string &	GetHostName () const
	Gets the HostName from the contained MachineInfo.
void	SetHostName (const std::string &hostname)
	Sets the HostName associated with the MachineInfo.
const std::string &	GetIPAddress () const
	Gets the IpAddress from the contained MachineInfo.
void	SetIPAddress (const std::string &ipAddress)
	Sets the IpAddress associated with the MachineInfo.
const unsigned long &	GetTimeStamp () const
	Gets the TimeStamp from the contained MachineInfo.
void	SetTimeStamp (const unsigned long &timeStamp)
	Sets the TimeStamp associated with the MachineInfo.
const unsigned int &	GetPing () const
	Gets the Ping from the contained MachineInfo.
void	SetPing (const unsigned int &ping)
	Sets the Ping associated with the MachineInfo.
dtCore::RefPtr < dtGame::MachineInfo >	GetMachineInfo () const
	Gets the MachineInfo from the message.
void	SetMachineInfo (const dtGame::MachineInfo &machineInfo)
	Sets the MachineInfo.
Protected Member Functions
virtual	~MachineInfoMessage ()
	Destructor.

---

Detailed Description

A MachineInfoMessage contains a dtGame::MachineInfo to be used with different messages to send information about a GameManager accross the network.

See also:

dtGame::MachineInfo

---

Constructor & Destructor Documentation

dtNetGM::MachineInfoMessage::MachineInfoMessage

(

)

[inline]

virtual dtNetGM::MachineInfoMessage::~MachineInfoMessage

(

)

[inline, protected, virtual]

Destructor.

---

Member Function Documentation

const std::string & dtNetGM::MachineInfoMessage::GetMachineInfoName

(

)

const

Gets the Name from the contained MachineInfo.

Returns:

The name

void dtNetGM::MachineInfoMessage::SetMachineInfoName

(

const std::string &

name

)

Sets the name associated with the MachineInfo.

Parameters:

The

new name

const std::string & dtNetGM::MachineInfoMessage::GetUniqueId

(

)

const

Gets the UniqueId from the contained MachineInfo as string.

Returns:

The uniqueid

void dtNetGM::MachineInfoMessage::SetUniqueId

(

const std::string &

strId

)

Sets the UniqueId associated with the MachineInfo.

Parameters:

The

new uniqueid as string

const std::string & dtNetGM::MachineInfoMessage::GetHostName

(

)

const

Gets the HostName from the contained MachineInfo.

Returns:

The hostname

void dtNetGM::MachineInfoMessage::SetHostName

(

const std::string &

hostname

)

Sets the HostName associated with the MachineInfo.

Parameters:

The

new hostname

const std::string & dtNetGM::MachineInfoMessage::GetIPAddress

(

)

const

Gets the IpAddress from the contained MachineInfo.

Returns:

The ipaddress

void dtNetGM::MachineInfoMessage::SetIPAddress

(

const std::string &

ipAddress

)

Sets the IpAddress associated with the MachineInfo.

Parameters:

The

new ipaddress

const unsigned long & dtNetGM::MachineInfoMessage::GetTimeStamp

(

)

const

Gets the TimeStamp from the contained MachineInfo.

Returns:

The timestamp

void dtNetGM::MachineInfoMessage::SetTimeStamp

(

const unsigned long &

timeStamp

)

Sets the TimeStamp associated with the MachineInfo.

Parameters:

The

new timestamp

const unsigned int & dtNetGM::MachineInfoMessage::GetPing

(

)

const

Gets the Ping from the contained MachineInfo.

Returns:

The ping

void dtNetGM::MachineInfoMessage::SetPing

(

const unsigned int &

ping

)

Sets the Ping associated with the MachineInfo.

Parameters:

The

new ping

dtCore::RefPtr< dtGame::MachineInfo > dtNetGM::MachineInfoMessage::GetMachineInfo

(

)

const

Gets the MachineInfo from the message.

Returns:

The machineinfo

void dtNetGM::MachineInfoMessage::SetMachineInfo

(

const dtGame::MachineInfo &

machineInfo

)

Sets the MachineInfo.

Parameters:

The

new machineinfo

---