asdm::EntityId Class Reference

description More...

#include <EntityId.h>

Public Member Functions
	EntityId ()
	EntityId constructors. More...
	EntityId (const EntityId &)
	EntityId (const std::string &id) throw (InvalidArgumentException)
	EntityId (asdmIDLTypes::IDLEntityId &) throw (InvalidArgumentException)
virtual	~EntityId ()
	EntityId destructor. More...
EntityId &	operator= (const EntityId &)
bool	equals (const EntityId &) const
bool	operator== (const EntityId &) const
bool	operator!= (const EntityId &) const
std::string	toString () const
asdmIDLTypes::IDLEntityId	toIDLEntityId () const
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream. More...
bool	isNull () const
std::string	getId () const
void	setId (std::string e)

Static Public Member Functions
static EntityId	getEntityId (StringTokenizer &t) throw (InvalidArgumentException)
static std::string	validate (std::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. More...

Private Attributes
std::string	id

Friends
std::ostream &	operator<< (std::ostream &, const EntityId &)
	Friend functions. More...
std::istream &	operator>> (std::istream &, EntityId &)

Detailed Description

description

Version

1.00 Jan. 7, 2005

Author

Allen Farris

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

Definition at line 56 of file EntityId.h.

Constructor & Destructor Documentation

asdm::EntityId::EntityId ( )

inline

EntityId constructors.

Definition at line 109 of file EntityId.h.

asdm::EntityId::EntityId ( const EntityId &  t )

inline

Definition at line 111 of file EntityId.h.

asdm::EntityId::EntityId	(	const std::string &	id	)
throw	(	InvalidArgumentException
	)

asdm::EntityId::EntityId	(	asdmIDLTypes::IDLEntityId &		)
throw	(	InvalidArgumentException
	)

asdm::EntityId::~EntityId ( )

inlinevirtual

EntityId destructor.

Definition at line 114 of file EntityId.h.

Member Function Documentation

bool asdm::EntityId::equals ( const EntityId &  x ) const

inline

Definition at line 125 of file EntityId.h.

References id.

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

std::string asdm::EntityId::getId ( ) const

inline

Definition at line 149 of file EntityId.h.

References id.

bool asdm::EntityId::isNull ( ) const

inline

Definition at line 121 of file EntityId.h.

Referenced by asdm::EntityRef::isNull().

bool asdm::EntityId::operator!= ( const EntityId &  x ) const

inline

Definition at line 133 of file EntityId.h.

References id.

EntityId & asdm::EntityId::operator= ( const EntityId &  x )

inline

Definition at line 116 of file EntityId.h.

References id.

bool asdm::EntityId::operator== ( const EntityId &  x ) const

inline

Definition at line 129 of file EntityId.h.

References id.

void asdm::EntityId::setId ( std::string  e )

inline

Definition at line 153 of file EntityId.h.

void asdm::EntityId::toBin

(

EndianOSStream &

eoss

)

const

Write the binary representation of this to a EndianOSStream.

asdmIDLTypes::IDLEntityId asdm::EntityId::toIDLEntityId ( ) const

inline

Definition at line 142 of file EntityId.h.

std::string asdm::EntityId::toString ( ) const

inline

Definition at line 137 of file EntityId.h.

References id.

static std::string asdm::EntityId::validate ( std::string  x )

static

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  o, const EntityId &  x  )

friend

Friend functions.

std::istream& operator>> ( std::istream &  i, EntityId &  x  )

friend

Member Data Documentation

std::string asdm::EntityId::id

private

Definition at line 104 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 file:

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