asdm::EntityId Class Reference

description More...

#include <EntityId.h>

List of all members.

Public Member Functions
	EntityId ()
	EntityId constructors.
	EntityId (const EntityId &)
	EntityId (const string &id) throw (InvalidArgumentException)
	EntityId (IDLEntityId &) throw (InvalidArgumentException)
virtual	~EntityId ()
	EntityId destructor.
EntityId &	operator= (const EntityId &)
bool	equals (const EntityId &) const
bool	operator== (const EntityId &) const
bool	operator!= (const EntityId &) const
string	toString () const
IDLEntityId	toIDLEntityId () const
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream.
bool	isNull () const
string	getId () const
void	setId (string e)
	EntityId ()
	EntityId (const EntityId &)
	EntityId (const string &id) throw (InvalidArgumentException)
	EntityId (IDLEntityId &) throw (InvalidArgumentException)
virtual	~EntityId ()
EntityId &	operator= (const EntityId &)
bool	equals (const EntityId &) const
bool	operator== (const EntityId &) const
bool	operator!= (const EntityId &) const
string	toString () const
IDLEntityId	toIDLEntityId () const
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream.
bool	isNull () const
string	getId () const
void	setId (string e)
Static Public Member Functions
static EntityId	getEntityId (StringTokenizer &t) throw (InvalidArgumentException)
static string	validate (string x)
static EntityId	fromBin (EndianIStream &eis)
	Read the binary representation of an EntityId from a EndianIStream and use the read value to set an EntityId.
static EntityId	getEntityId (StringTokenizer &t) throw (InvalidArgumentException)
static string	validate (string x)
static EntityId	fromBin (EndianIStream &eis)
	Read the binary representation of an EntityId from a EndianIStream and use the read value to set an EntityId.
Private Attributes
string	id
Friends
ostream &	operator<< (ostream &, const EntityId &)
	Friend functions.
istream &	operator>> (istream &, EntityId &)
ostream &	operator<< (ostream &, const EntityId &)
	Friend functions.
istream &	operator>> (istream &, EntityId &)

---

Detailed Description

description

Version:

1.00 Jan. 7, 2005

Author:

Allen Farris

Michel Caillat, added == and =! operators. June 2005.

Definition at line 62 of file EntityId.h.

---

Constructor & Destructor Documentation

asdm::EntityId::EntityId

(

)

[inline]

EntityId constructors.

Definition at line 115 of file EntityId.h.

asdm::EntityId::EntityId

(

const EntityId &

t

)

[inline]

Definition at line 117 of file EntityId.h.

asdm::EntityId::EntityId

(

const string &

id

)

throw (InvalidArgumentException)

asdm::EntityId::EntityId

(

IDLEntityId &

)

throw (InvalidArgumentException)

asdm::EntityId::~EntityId

(

)

[inline, virtual]

EntityId destructor.

Definition at line 120 of file EntityId.h.

asdm::EntityId::EntityId

(

)

asdm::EntityId::EntityId

(

const EntityId &

)

asdm::EntityId::EntityId

(

const string &

id

)

throw (InvalidArgumentException)

asdm::EntityId::EntityId

(

IDLEntityId &

)

throw (InvalidArgumentException)

virtual asdm::EntityId::~EntityId

(

)

[virtual]

---

Member Function Documentation

bool asdm::EntityId::equals

(

const EntityId &

x

)

const [inline]

Definition at line 131 of file EntityId.h.

References id.

bool asdm::EntityId::equals

(

const EntityId &

)

const

static EntityId asdm::EntityId::fromBin

(

EndianIStream &

eis

)

[static]

Read the binary representation of an EntityId from a EndianIStream and use the read value to set an EntityId.

Parameters:

eis	the EndianStream to be read

Returns:

an EntityId

Exceptions:

InvalidArgumentException

static EntityId asdm::EntityId::fromBin

(

EndianIStream &

eis

)

[static]

Read the binary representation of an EntityId from a EndianIStream and use the read value to set an EntityId.

Parameters:

eis	the EndianStream to be read

Returns:

an EntityId

Exceptions:

InvalidArgumentException

static EntityId asdm::EntityId::getEntityId

(

StringTokenizer &

t

)

throw (InvalidArgumentException) [static]

static EntityId asdm::EntityId::getEntityId

(

StringTokenizer &

t

)

throw (InvalidArgumentException) [static]

string asdm::EntityId::getId

(

)

const

string asdm::EntityId::getId

(

)

const [inline]

Definition at line 155 of file EntityId.h.

References id.

bool asdm::EntityId::isNull

(

)

const [inline]

Definition at line 127 of file EntityId.h.

bool asdm::EntityId::isNull

(

)

const

bool asdm::EntityId::operator!=

(

const EntityId &

)

const

bool asdm::EntityId::operator!=

(

const EntityId &

x

)

const [inline]

Definition at line 139 of file EntityId.h.

References id.

EntityId& asdm::EntityId::operator=

(

const EntityId &

)

EntityId & asdm::EntityId::operator=

(

const EntityId &

x

)

[inline]

Definition at line 122 of file EntityId.h.

References id.

bool asdm::EntityId::operator==

(

const EntityId &

)

const

bool asdm::EntityId::operator==

(

const EntityId &

x

)

const [inline]

Definition at line 135 of file EntityId.h.

References id.

void asdm::EntityId::setId

(

string

e

)

void asdm::EntityId::setId

(

string

e

)

[inline]

Definition at line 159 of file EntityId.h.

void asdm::EntityId::toBin

(

EndianOSStream &

eoss

)

const

Write the binary representation of this to a EndianOSStream.

void asdm::EntityId::toBin

(

EndianOSStream &

eoss

)

const

Write the binary representation of this to a EndianOSStream.

IDLEntityId asdm::EntityId::toIDLEntityId

(

)

const [inline]

Definition at line 148 of file EntityId.h.

IDLEntityId asdm::EntityId::toIDLEntityId

(

)

const

string asdm::EntityId::toString

(

)

const

string asdm::EntityId::toString

(

)

const [inline]

Definition at line 143 of file EntityId.h.

References id.

static string asdm::EntityId::validate

(

string

x

)

[static]

static string asdm::EntityId::validate

(

string

x

)

[static]

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	o,
		const EntityId &	x
	)		[friend]

Friend functions.

ostream& operator<<	(	ostream &	o,
		const EntityId &	x
	)		[friend]

Friend functions.

istream& operator>>	(	istream &	i,
		EntityId &	x
	)		[friend]

istream& operator>>	(	istream &	i,
		EntityId &	x
	)		[friend]

---

Member Data Documentation

string asdm::EntityId::id [private]

Definition at line 110 of file EntityId.h.

Referenced by equals(), getId(), operator!=(), asdm::operator<<(), operator=(), operator==(), asdm::operator>>(), and toString().

---

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

• code/alma/ASDM/EntityId.h
• code/alma_v3/ASDM/EntityId.h