# Home    # nevrax.com   
Nevrax
Nevrax.org
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
Docs
 
Documentation  
Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  

NLMISC::CEntityId Struct Reference

TODO. More...

#include <entity_id.h>

Inheritance diagram for NLMISC::CEntityId:

NLAIAGENT::CAgentNumber NLAIAGENT::CIdent List of all members.

Public Methods

uint64 getRawId () const
uint64 getShortId () const
void setShortId (uint64 shortId)
uint8 getDynamicId () const
void setDynamicId (uint8 dynId)
uint8 getCreatorId () const
void setCreatorId (uint8 creatorId)
uint8 getType () const
void setType (uint8 type)
uint64 getUniqueId () const
bool isUnknownId () const
const CEntityId & operator++ (int)
const CEntityId & operator= (const CEntityId &a)
const CEntityId & operator= (uint64 p)
 operator uint64 () const
void setServiceId (uint8 sid)
void save (NLMISC::IStream &os)
 Save the Id into an output stream. More...

void load (NLMISC::IStream &is)
 Load the number from an input stream. More...

void serial (NLMISC::IStream &f) throw (NLMISC::EStream)
std::string toString () const
 return a string in form "(a:b:c:d)" where a,b,c,d are components of entity id. More...

void fromString (const char *str)
 Read from a debug string, use the same format as toString() (id:type:creator:dynamic) in hexadecimal. More...

void getDebugString (std::string &str) const
 Have a debug string. More...

Constructor
 CEntityId ()
 CEntityId (uint8 type, uint64 id, uint8 creator, uint8 dynamic)
 CEntityId (uint8 type, uint64 id)
 CEntityId (uint64 p)
 CEntityId (const CEntityId &a)
 CEntityId (NLMISC::IStream &is)
 fill from read stream. More...

 CEntityId (const char *str)
comparison of two CEntityId.
bool operator== (const CEntityId &a) const
bool operator< (const CEntityId &a) const
bool operator> (const CEntityId &a) const

Static Public Attributes

uint8 ServerId = 0
 The local num service id of the local machin. More...

const uint64 MaxEntityId = ((uint64)1 << (40 + 1)) - (uint64)1
 The maximume of number that we could generate without generat an overtaking exception. More...

const CEntityId Unknown
 Unknow CEntityId is similar as an NULL pointer. More...


Detailed Description

TODO.

Author:
Sameh Chafik, Vianney Lecroart , Nevrax France
Date:
2001

Definition at line 42 of file entity_id.h.


Constructor & Destructor Documentation

NLMISC::CEntityId::CEntityId   [inline]
 

Definition at line 84 of file entity_id.h.

References DetailedId, and FullId.

Referenced by NLAIAGENT::CAgentNumber::CAgentNumber, CEntityId, getUniqueId, operator++, operator<, operator=, operator==, and operator>.

NLMISC::CEntityId::CEntityId uint8    type,
uint64    id,
uint8    creator,
uint8    dynamic
[inline]
 

Definition at line 97 of file entity_id.h.

References DetailedId, id, and type.

NLMISC::CEntityId::CEntityId uint8    type,
uint64    id
[inline]
 

Definition at line 105 of file entity_id.h.

References DetailedId, id, ServerId, and type.

NLMISC::CEntityId::CEntityId uint64    p [inline, explicit]
 

Definition at line 113 of file entity_id.h.

References FullId.

NLMISC::CEntityId::CEntityId const CEntityId &    a [inline]
 

Definition at line 127 of file entity_id.h.

References CEntityId, and FullId.

NLMISC::CEntityId::CEntityId NLMISC::IStream   is [inline]
 

fill from read stream.

Definition at line 139 of file entity_id.h.

References FullId, and NLMISC::IStream::serial.

NLMISC::CEntityId::CEntityId const char *    str [inline, explicit]
 

Definition at line 156 of file entity_id.h.

References NLMISC::atoiInt64, DetailedId, id, and type.


Member Function Documentation

void NLMISC::CEntityId::fromString const char *    str [inline]
 

Read from a debug string, use the same format as toString() (id:type:creator:dynamic) in hexadecimal.

Definition at line 468 of file entity_id.h.

References DetailedId, id, and type.

uint8 NLMISC::CEntityId::getCreatorId   const [inline]
 

Definition at line 223 of file entity_id.h.

References DetailedId.

Referenced by NLAIAGENT::CAgentNumber::operator<.

void NLMISC::CEntityId::getDebugString std::string &    str const [inline]
 

Have a debug string.

Reimplemented in NLAIAGENT::CIdent.

Definition at line 486 of file entity_id.h.

References DetailedId, and x.

Referenced by toString.

uint8 NLMISC::CEntityId::getDynamicId   const [inline]
 

Definition at line 213 of file entity_id.h.

References DetailedId.

Referenced by NLAIAGENT::CAgentNumber::operator<.

uint64 NLMISC::CEntityId::getRawId   const [inline]
 

Definition at line 195 of file entity_id.h.

References FullId.

Referenced by NLNET::IService::getEntityId.

uint64 NLMISC::CEntityId::getShortId   const [inline]
 

Definition at line 203 of file entity_id.h.

References DetailedId.

Referenced by NLAIAGENT::CAgentNumber::operator<.

uint8 NLMISC::CEntityId::getType void    const [inline]
 

Definition at line 233 of file entity_id.h.

References DetailedId.

Referenced by NLAIAGENT::CAgentNumber::isAgentId, and NLAIAGENT::CAgentNumber::setTypeAt.

uint64 NLMISC::CEntityId::getUniqueId   const [inline]
 

Definition at line 243 of file entity_id.h.

References CEntityId, FullId, and id.

Referenced by operator<, and operator>.

bool NLMISC::CEntityId::isUnknownId   const [inline]
 

Definition at line 251 of file entity_id.h.

References DetailedId.

void NLMISC::CEntityId::load NLMISC::IStream   is [inline]
 

Load the number from an input stream.

Reimplemented in NLAIAGENT::CIdent.

Definition at line 424 of file entity_id.h.

References FullId.

Referenced by serial.

NLMISC::CEntityId::operator uint64   const [inline]
 

Definition at line 371 of file entity_id.h.

References FullId.

const CEntityId& NLMISC::CEntityId::operator++ int    [inline]
 

Definition at line 327 of file entity_id.h.

References CEntityId, DetailedId, MaxEntityId, and nlerror.

bool NLMISC::CEntityId::operator< const CEntityId &    a const [inline]
 

Definition at line 275 of file entity_id.h.

References CEntityId, and getUniqueId.

const CEntityId& NLMISC::CEntityId::operator= uint64    p [inline]
 

Definition at line 352 of file entity_id.h.

References CEntityId, and FullId.

const CEntityId& NLMISC::CEntityId::operator= const CEntityId &    a [inline]
 

Definition at line 340 of file entity_id.h.

References CEntityId, and FullId.

bool NLMISC::CEntityId::operator== const CEntityId &    a const [inline]
 

Definition at line 262 of file entity_id.h.

References CEntityId, and FullId.

bool NLMISC::CEntityId::operator> const CEntityId &    a const [inline]
 

Definition at line 300 of file entity_id.h.

References CEntityId, and getUniqueId.

void NLMISC::CEntityId::save NLMISC::IStream   os [inline]
 

Save the Id into an output stream.

Reimplemented in NLAIAGENT::CIdent.

Definition at line 407 of file entity_id.h.

References FullId.

Referenced by serial.

void NLMISC::CEntityId::serial NLMISC::IStream   f throw (NLMISC::EStream) [inline]
 

Definition at line 442 of file entity_id.h.

References load, and save.

void NLMISC::CEntityId::setCreatorId uint8    creatorId [inline]
 

Definition at line 228 of file entity_id.h.

References DetailedId.

Referenced by NLLOGIC::CLogicEventMessage::CLogicEventMessage.

void NLMISC::CEntityId::setDynamicId uint8    dynId [inline]
 

Definition at line 218 of file entity_id.h.

References DetailedId.

Referenced by NLLOGIC::CLogicEventMessage::CLogicEventMessage.

void NLMISC::CEntityId::setServiceId uint8    sid [inline]
 

Definition at line 387 of file entity_id.h.

References DetailedId, and ServerId.

Referenced by NLNET::IService::main.

void NLMISC::CEntityId::setShortId uint64    shortId [inline]
 

Definition at line 208 of file entity_id.h.

References DetailedId.

void NLMISC::CEntityId::setType uint8    type [inline]
 

Definition at line 238 of file entity_id.h.

References DetailedId, and type.

Referenced by NLAIAGENT::CAgentNumber::CAgentNumber, NLLOGIC::CLogicEventMessage::CLogicEventMessage, NLNET::IService::getEntityId, and NLAIAGENT::CAgentNumber::setTypeAt.

std::string NLMISC::CEntityId::toString   const [inline]
 

return a string in form "(a:b:c:d)" where a,b,c,d are components of entity id.

Definition at line 460 of file entity_id.h.

References getDebugString, and id.


Member Data Documentation

uint64 NLMISC::CEntityId::CreatorId [private]
 

Id of the service who created the entity.

Definition at line 56 of file entity_id.h.

struct { ... } NLMISC::CEntityId::DetailedId [private]
 

Referenced by CEntityId, fromString, getCreatorId, getDebugString, getDynamicId, getShortId, getType, isUnknownId, operator++, setCreatorId, setDynamicId, setServiceId, setShortId, and setType.

uint64 NLMISC::CEntityId::DynamicId [private]
 

Id of the service where the entity is.

Definition at line 54 of file entity_id.h.

uint64 NLMISC::CEntityId::FullId [private]
 

Definition at line 63 of file entity_id.h.

Referenced by CEntityId, getRawId, getUniqueId, load, operator uint64, operator=, operator==, and save.

uint64 NLMISC::CEntityId::Id [private]
 

Local agent number.

Definition at line 60 of file entity_id.h.

const uint64 NLMISC::CEntityId::MaxEntityId = ((uint64)1 << (40 + 1)) - (uint64)1 [static]
 

The maximume of number that we could generate without generat an overtaking exception.

Definition at line 34 of file entity_id.cpp.

Referenced by operator++.

uint8 NLMISC::CEntityId::ServerId = 0 [static]
 

The local num service id of the local machin.

Definition at line 36 of file entity_id.cpp.

Referenced by CEntityId, NLAIAGENT::CIdent::CIdent, and setServiceId.

uint64 NLMISC::CEntityId::Type [private]
 

Type of the entity.

Definition at line 58 of file entity_id.h.

const CEntityId NLMISC::CEntityId::Unknown [static]
 

Unknow CEntityId is similar as an NULL pointer.


The documentation for this struct was generated from the following files: