asdm::Entity Class Reference

The Entity class is an identification of a persistant entity in the ALMA archive. More...

#include <Entity.h>

List of all members.

Public Member Functions
	Entity ()
	Entity (const string &s)
	Entity (IDLEntity &)
	Entity (string entityId, string entityIdEncrypted, string entityTypeName, string entityVersion, string instanceVersion)
virtual	~Entity ()
bool	operator== (const Entity &) const
bool	equals (const Entity &) const
bool	operator!= (const Entity &) const
bool	isNull () const
string	toString () const
string	toXML () const
IDLEntity	toIDLEntity () const
void	setFromXML (string xml)
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream.
EntityId	getEntityId () const
string	getEntityIdEncrypted () const
string	getEntityTypeName () const
string	getEntityVersion () const
string	getInstanceVersion () const
void	setEntityId (EntityId e)
void	setEntityIdEncrypted (string s)
void	setEntityTypeName (string s)
void	setEntityVersion (string s)
void	setInstanceVersion (string s)
	Entity ()
	Entity (const string &s)
	Entity (IDLEntity &)
	Entity (string entityId, string entityIdEncrypted, string entityTypeName, string entityVersion, string instanceVersion)
virtual	~Entity ()
bool	operator== (const Entity &) const
bool	equals (const Entity &) const
bool	operator!= (const Entity &) const
bool	isNull () const
string	toString () const
string	toXML () const
IDLEntity	toIDLEntity () const
void	setFromXML (string xml)
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream.
EntityId	getEntityId () const
string	getEntityIdEncrypted () const
string	getEntityTypeName () const
string	getEntityVersion () const
string	getInstanceVersion () const
void	setEntityId (EntityId e)
void	setEntityIdEncrypted (string s)
void	setEntityTypeName (string s)
void	setEntityVersion (string s)
void	setInstanceVersion (string s)
Static Public Member Functions
static Entity	getEntity (StringTokenizer &t)
static Entity	fromBin (EndianIStream &eis)
	Read the binary representation of an Enity from a EndianIStream and use the read value to set an Entity.
static Entity	getEntity (StringTokenizer &t)
static Entity	fromBin (EndianIStream &eis)
	Read the binary representation of an Enity from a EndianIStream and use the read value to set an Entity.
Private Member Functions
string	getXMLValue (string xml, string parm) const
string	validXML () const
string	getXMLValue (string xml, string parm) const
string	validXML () const
Private Attributes
EntityId	entityId
string	entityIdEncrypted
string	entityTypeName
string	entityVersion
string	instanceVersion
Friends
ostream &	operator<< (ostream &, const Entity &)
istream &	operator>> (istream &, Entity &)
ostream &	operator<< (ostream &, const Entity &)
istream &	operator>> (istream &, Entity &)

---

Detailed Description

The Entity class is an identification of a persistant entity in the ALMA archive.

It easily maps onto an EntityT object in ACS system entities.

Exceptions:

InvalidArgumentException

Version:

1.00 Jan. 7, 2005

Author:

Allen Farris

Definition at line 66 of file Entity.h.

---

Constructor & Destructor Documentation

asdm::Entity::Entity

(

)

asdm::Entity::Entity

(

const string &

s

)

asdm::Entity::Entity

(

IDLEntity &

)

asdm::Entity::Entity	(	string	entityId,
		string	entityIdEncrypted,
		string	entityTypeName,
		string	entityVersion,
		string	instanceVersion
	)

virtual asdm::Entity::~Entity

(

)

[virtual]

asdm::Entity::Entity

(

)

asdm::Entity::Entity

(

const string &

s

)

asdm::Entity::Entity

(

IDLEntity &

)

asdm::Entity::Entity	(	string	entityId,
		string	entityIdEncrypted,
		string	entityTypeName,
		string	entityVersion,
		string	instanceVersion
	)

virtual asdm::Entity::~Entity

(

)

[virtual]

---

Member Function Documentation

bool asdm::Entity::equals

(

const Entity &

)

const

bool asdm::Entity::equals

(

const Entity &

)

const

static Entity asdm::Entity::fromBin

(

EndianIStream &

eis

)

[static]

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

Parameters:

eis	the EndianStream to be read

Returns:

an Entity

Referenced by asdm::TableStreamReader< T, R >::open().

static Entity asdm::Entity::fromBin

(

EndianIStream &

eis

)

[static]

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

Parameters:

eis	the EndianStream to be read

Returns:

an Entity

static Entity asdm::Entity::getEntity

(

StringTokenizer &

t

)

[static]

static Entity asdm::Entity::getEntity

(

StringTokenizer &

t

)

[static]

EntityId asdm::Entity::getEntityId

(

)

const

EntityId asdm::Entity::getEntityId

(

)

const

string asdm::Entity::getEntityIdEncrypted

(

)

const

string asdm::Entity::getEntityIdEncrypted

(

)

const

string asdm::Entity::getEntityTypeName

(

)

const

string asdm::Entity::getEntityTypeName

(

)

const

string asdm::Entity::getEntityVersion

(

)

const

string asdm::Entity::getEntityVersion

(

)

const

string asdm::Entity::getInstanceVersion

(

)

const

string asdm::Entity::getInstanceVersion

(

)

const

string asdm::Entity::getXMLValue	(	string	xml,
		string	parm
	)		const [private]

string asdm::Entity::getXMLValue	(	string	xml,
		string	parm
	)		const [private]

bool asdm::Entity::isNull

(

)

const

bool asdm::Entity::isNull

(

)

const

bool asdm::Entity::operator!=

(

const Entity &

)

const

bool asdm::Entity::operator!=

(

const Entity &

)

const

bool asdm::Entity::operator==

(

const Entity &

)

const

bool asdm::Entity::operator==

(

const Entity &

)

const

void asdm::Entity::setEntityId

(

EntityId

e

)

void asdm::Entity::setEntityId

(

EntityId

e

)

void asdm::Entity::setEntityIdEncrypted

(

string

s

)

void asdm::Entity::setEntityIdEncrypted

(

string

s

)

void asdm::Entity::setEntityTypeName

(

string

s

)

void asdm::Entity::setEntityTypeName

(

string

s

)

void asdm::Entity::setEntityVersion

(

string

s

)

void asdm::Entity::setEntityVersion

(

string

s

)

void asdm::Entity::setFromXML

(

string

xml

)

void asdm::Entity::setFromXML

(

string

xml

)

void asdm::Entity::setInstanceVersion

(

string

s

)

void asdm::Entity::setInstanceVersion

(

string

s

)

void asdm::Entity::toBin

(

EndianOSStream &

eoss

)

const

Write the binary representation of this to a EndianOSStream.

void asdm::Entity::toBin

(

EndianOSStream &

eoss

)

const

Write the binary representation of this to a EndianOSStream.

IDLEntity asdm::Entity::toIDLEntity

(

)

const

IDLEntity asdm::Entity::toIDLEntity

(

)

const

string asdm::Entity::toString

(

)

const

string asdm::Entity::toString

(

)

const

string asdm::Entity::toXML

(

)

const

string asdm::Entity::toXML

(

)

const

string asdm::Entity::validXML

(

)

const [private]

string asdm::Entity::validXML

(

)

const [private]

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	,
		const Entity &
	)		[friend]

ostream& operator<<	(	ostream &	,
		const Entity &
	)		[friend]

istream& operator>>	(	istream &	,
		Entity &
	)		[friend]

istream& operator>>	(	istream &	,
		Entity &
	)		[friend]

---

Member Data Documentation

EntityId asdm::Entity::entityId [private]

Definition at line 120 of file Entity.h.

string asdm::Entity::entityIdEncrypted [private]

Definition at line 121 of file Entity.h.

string asdm::Entity::entityTypeName [private]

Definition at line 122 of file Entity.h.

string asdm::Entity::entityVersion [private]

Definition at line 123 of file Entity.h.

string asdm::Entity::instanceVersion [private]

Definition at line 124 of file Entity.h.

---

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

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