DtEventId Class Reference

Represents Events in the RPR FOM. More...

Collaboration diagram for DtEventId:

List of all members.

Public Member Functions
	DtEventId (const char *str)
	Construct a DtEventId from a character string consisting of the event number followed by a colon, and then an object name.
	DtEventId (const DtGlobalObjectDesignator &des, int eventNum)
	Construct a DtEventId from a name and an event number.
	DtEventId (const DtNetEventId &netId)
	Construct a DtEventId from network representation.
	DtEventId (const DtEventId &netId)
	Copy constructor.
DtEventId &	operator= (const DtEventId &orig)
	Assignment operator.
	DtEventId ()
	Same as DtEventId("", 0);.
	~DtEventId ()
	Destructor.
void	setFromNet (const DtNetEventId &netId)
	Set from network representation.
DtNetEventId *	netRep () const
	Convert to network representation. Returns ptr to internal memory.
int	netSize () const
	Return the size of the network implementation.
int	operator== (const DtEventId &otherGuy) const
	Equivalence operators.
int	operator!= (const DtEventId &otherGuy) const
void	setEventNum (int eventNum)
	Set event number component.
int	eventNum () const
	Get event number component.
const DtGlobalObjectDesignator &	objectId () const
	Get object designator component.
void	setObjectId (const DtGlobalObjectDesignator &name)
	Set object designator component.
const DtGlobalObjectDesignator &	globalId () const
	Get object designator component.
void	setGlobalId (const DtGlobalObjectDesignator &name)
	Set object designator component.
const char *	string () const
	Convert to string.
Static Public Member Functions
static const DtEventId &	nullId ()
	Return a null DtEventId.
Protected Member Functions
void	init (const DtGlobalObjectDesignator &des, int eventNum)
	initialize
Protected Attributes
DtString	myObjName
int	myEventNum
DtNetEventId *	myNetRep
DtString	myStringRep

---

Detailed Description

Represents Events in the RPR FOM.

Events are represented in the form num:string, where num is the eventId and string an DtGlobalObjectIdentifier

---

Constructor & Destructor Documentation

DtEventId::DtEventId

(

const char *

str

)

Construct a DtEventId from a character string consisting of the event number followed by a colon, and then an object name.

For example: DtEventId event("36:Object1");

DtEventId::DtEventId	(	const DtGlobalObjectDesignator &	des,
		int	eventNum
	)

Construct a DtEventId from a name and an event number.

DtEventId::DtEventId

(

const DtNetEventId &

netId

)

Construct a DtEventId from network representation.

DtEventId::DtEventId

(

const DtEventId &

netId

)

Copy constructor.

DtEventId::DtEventId

(

)

Same as DtEventId("", 0);.

DtEventId::~DtEventId

(

)

Destructor.

---

Member Function Documentation

int DtEventId::eventNum

(

)

const

Get event number component.

const DtGlobalObjectDesignator& DtEventId::globalId

(

)

const

Get object designator component.

void DtEventId::init	(	const DtGlobalObjectDesignator &	des,
		int	eventNum
	)		[protected]

initialize

DtNetEventId* DtEventId::netRep

(

)

const

Convert to network representation. Returns ptr to internal memory.

int DtEventId::netSize

(

)

const

Return the size of the network implementation.

static const DtEventId& DtEventId::nullId

(

)

[static]

Return a null DtEventId.

const DtGlobalObjectDesignator& DtEventId::objectId

(

)

const

Get object designator component.

int DtEventId::operator!=

(

const DtEventId &

otherGuy

)

const

DtEventId& DtEventId::operator=

(

const DtEventId &

orig

)

Assignment operator.

int DtEventId::operator==

(

const DtEventId &

otherGuy

)

const

Equivalence operators.

void DtEventId::setEventNum

(

int

eventNum

)

Set event number component.

void DtEventId::setFromNet

(

const DtNetEventId &

netId

)

Set from network representation.

void DtEventId::setGlobalId

(

const DtGlobalObjectDesignator &

name

)

Set object designator component.

void DtEventId::setObjectId

(

const DtGlobalObjectDesignator &

name

)

Set object designator component.

const char* DtEventId::string

(

)

const

Convert to string.

---

Member Data Documentation

int DtEventId::myEventNum [protected]

DtNetEventId* DtEventId::myNetRep [protected]

DtString DtEventId::myObjName [protected]

DtString DtEventId::myStringRep [protected]

---

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

• eventId.h