VRUT::MODULE_ID Class Reference

Unique module ID consisting of server type, module handle id and its instance id. More...

#include <moddefs.h>

List of all members.

Public Member Functions

MODULE_ID (SERVER_ID server=SERVER_ID_NONE, MODULE_HANDLE_ID hid=MODULE_HANDLE_ID_NONE, MODULE_INSTANCE_ID iid=MODULE_INSTANCE_ID_NONE)

Constructor.

MODULE_ID (unsigned _id)

Constructor.

MODULE_ID (const MODULE_ID &mid)

Copy constructor.

bool operator== (const MODULE_ID &mid) const

Comparison operator.

bool operator!= (const MODULE_ID &mid) const

Comparison operator.

unsigned GetID () const

Get combined ID.

SERVER_ID GetServerID () const

Get server type ID.

MODULE_HANDLE_ID GetHandleID () const

Get handle ID.

MODULE_INSTANCE_ID GetInstanceID () const

Get instance ID.

wxString ToString () const

Get module ID as string.

Static Public Member Functions

static MODULE_ID FromString (const wxString &str)

Get MODULE_ID from string.

Private Attributes

unsigned id

Module id.

Detailed Description

Unique module ID consisting of server type, module handle id and its instance id.

Definition at line 105 of file moddefs.h.

Constructor & Destructor Documentation

VRUT::MODULE_ID::MODULE_ID	(	SERVER_ID	server = `SERVER_ID_NONE`,
		MODULE_HANDLE_ID	hid = `MODULE_HANDLE_ID_NONE`,
		MODULE_INSTANCE_ID	iid = `MODULE_INSTANCE_ID_NONE`
	)			`[inline]`

Constructor.

Definition at line 113 of file moddefs.h.

00114               {
00115                      id = (iid & 0xffff) | ( (hid << 16) & 0xfff0000 ) | ( (server << 28) & 0xf0000000 );
00116               }

VRUT::MODULE_ID::MODULE_ID ( unsigned _id ) [inline]

Constructor.

Definition at line 119 of file moddefs.h.

00119 : id(_id)     {}

VRUT::MODULE_ID::MODULE_ID ( const MODULE_ID & mid ) [inline]

Copy constructor.

Definition at line 122 of file moddefs.h.

00123               {
00124                      id = mid.id;
00125               }

Member Function Documentation

bool VRUT::MODULE_ID::operator== ( const MODULE_ID & mid ) const [inline]

Comparison operator.

Definition at line 128 of file moddefs.h.

00129               {
00130                      return id == mid.id;
00131               }

bool VRUT::MODULE_ID::operator!= ( const MODULE_ID & mid ) const [inline]

Comparison operator.

Definition at line 134 of file moddefs.h.

00135               {
00136                      return !operator==(mid);
00137               }

unsigned VRUT::MODULE_ID::GetID ( ) const [inline]

Get combined ID.

Definition at line 140 of file moddefs.h.

00141               {
00142                      return id;
00143               }

SERVER_ID VRUT::MODULE_ID::GetServerID ( ) const [inline]

Get server type ID.

Definition at line 146 of file moddefs.h.

00147               {
00148                      return SERVER_ID( (id >> 28) & 0xf );
00149               }

MODULE_HANDLE_ID VRUT::MODULE_ID::GetHandleID ( ) const [inline]

Get handle ID.

Definition at line 152 of file moddefs.h.

00153               {
00154                      return MODULE_HANDLE_ID( (id >> 16) & 0xfff );
00155               }

MODULE_INSTANCE_ID VRUT::MODULE_ID::GetInstanceID ( ) const [inline]

Get instance ID.

Definition at line 158 of file moddefs.h.

00159               {
00160                      return MODULE_INSTANCE_ID( id & 0xffff );
00161               }

wxString VRUT::MODULE_ID::ToString ( ) const [inline]

Get module ID as string.

Definition at line 164 of file moddefs.h.

00165               {
00166                      return wxString::Format(wxT("%i:%i:%i"), GetServerID(), GetHandleID(), GetInstanceID());
00167               }

static MODULE_ID VRUT::MODULE_ID::FromString ( const wxString & str ) [inline, static]

Get MODULE_ID from string.

Definition at line 170 of file moddefs.h.

00171               {
00172                      wxStringTokenizer tkz(str, wxT(" :;|"));
00173                      SERVER_ID server = SERVER_ID_NONE;
00174                      MODULE_HANDLE_ID hid = MODULE_HANDLE_ID_NONE;
00175                      MODULE_INSTANCE_ID iid = MODULE_INSTANCE_ID_NONE;
00176                      if (tkz.CountTokens() == 3)
00177                      {
00178                             unsigned long tmp;
00179                             if (!tkz.GetNextToken().ToULong(&tmp))
00180                                    return MODULE_ID();
00181                             server = SERVER_ID(tmp);
00182                             if (!tkz.GetNextToken().ToULong(&tmp))
00183                                    return MODULE_ID();
00184                             hid = MODULE_HANDLE_ID(tmp);
00185                             if (!tkz.GetNextToken().ToULong(&tmp))
00186                                    return MODULE_ID();
00187                             iid = MODULE_INSTANCE_ID(tmp);
00188                      }
00189                      return MODULE_ID(server, hid, iid);
00190               }

Member Data Documentation

unsigned VRUT::MODULE_ID::id [private]

Module id.

Definition at line 109 of file moddefs.h.

The documentation for this class was generated from the following file:

/cygdrive/d/src/svn/vrut/trunk/core/src/moddefs.h


Public Member Functions
	MODULE_ID (SERVER_ID server=SERVER_ID_NONE, MODULE_HANDLE_ID hid=MODULE_HANDLE_ID_NONE, MODULE_INSTANCE_ID iid=MODULE_INSTANCE_ID_NONE)
	Constructor.
	MODULE_ID (unsigned _id)
	Constructor.
	MODULE_ID (const MODULE_ID &mid)
	Copy constructor.
bool	operator== (const MODULE_ID &mid) const
	Comparison operator.
bool	operator!= (const MODULE_ID &mid) const
	Comparison operator.
unsigned	GetID () const
	Get combined ID.
SERVER_ID	GetServerID () const
	Get server type ID.
MODULE_HANDLE_ID	GetHandleID () const
	Get handle ID.
MODULE_INSTANCE_ID	GetInstanceID () const
	Get instance ID.
wxString	ToString () const
	Get module ID as string.
Static Public Member Functions
static MODULE_ID	FromString (const wxString &str)
	Get `MODULE_ID` from string.
Private Attributes
unsigned	id
	Module id.