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

#include <EntityRef.h>

Public Member Functions
	EntityRef ()
	EntityRef (const string &s)
	EntityRef constructors.
	EntityRef (IDLEntityRef &)
	EntityRef (string entityId, string partId, string entityTypeName, string instanceVersion)
virtual	~EntityRef ()
	EntityRef destructor.
bool	operator== (const EntityRef &) const
bool	equals (const EntityRef &) const
bool	operator!= (const EntityRef &) const
bool	isNull () const
string	toString () const
string	toXML () const throw (InvalidDataException)
IDLEntityRef	toIDLEntityRef () const
void	setFromXML (string xml)
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream.
EntityId	getEntityId () const
	Getters and Setters.
PartId	getPartId () const
string	getEntityTypeName () const
string	getInstanceVersion () const
void	setEntityId (EntityId e)
void	setPartId (PartId s)
void	setEntityTypeName (string s)
void	setInstanceVersion (string s)
	EntityRef ()
	EntityRef (const string &s)
	EntityRef (IDLEntityRef &)
	EntityRef (string entityId, string partId, string entityTypeName, string instanceVersion)
virtual	~EntityRef ()
bool	operator== (const EntityRef &) const
bool	equals (const EntityRef &) const
bool	operator!= (const EntityRef &) const
bool	isNull () const
string	toString () const
string	toXML () const throw (InvalidDataException)
IDLEntityRef	toIDLEntityRef () const
void	setFromXML (string xml)
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream.
EntityId	getEntityId () const
PartId	getPartId () const
string	getEntityTypeName () const
string	getInstanceVersion () const
void	setEntityId (EntityId e)
void	setPartId (PartId s)
void	setEntityTypeName (string s)
void	setInstanceVersion (string s)
Static Public Member Functions
static EntityRef	getEntityRef (StringTokenizer &t) throw (InvalidArgumentException)
static void	toBin (const vector< EntityRef > &entityRef, EndianOSStream &eoss)
	Write the binary representation of a vector of EntityRef to an EndianOSStream.
static EntityRef	fromBin (EndianIStream &eis)
	Read the binary representation of an EntityRef from a EndianIStream and use the read value to set an EntityRef.
static vector< EntityRef >	from1DBin (EndianIStream &eis)
	Read the binary representation of a vector of EntityRef from an EndianIStream and use the read value to set a vector of EntityRef.
static EntityRef	getEntityRef (StringTokenizer &t) throw (InvalidArgumentException)
static void	toBin (const vector< EntityRef > &entityRef, EndianOSStream &eoss)
	Write the binary representation of a vector of EntityRef to an EndianOSStream.
static EntityRef	fromBin (EndianIStream &eis)
	Read the binary representation of an EntityRef from a EndianIStream and use the read value to set an EntityRef.
static vector< EntityRef >	from1DBin (EndianIStream &eis)
	Read the binary representation of a vector of EntityRef from an EndianIStream and use the read value to set a vector of EntityRef.
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
PartId	partId
string	entityTypeName
string	instanceVersion
Friends
ostream &	operator<< (ostream &, const EntityRef &)
	Friend functions.
ostream &	operator<< (ostream &, const EntityRef &)
	Friend functions.

Detailed Description

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

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

Version:: 1.00 Jan. 7, 2005

Author:: Allen Farris

Definition at line 63 of file EntityRef.h.

Constructor & Destructor Documentation

asdm::EntityRef::EntityRef ( )

asdm::EntityRef::EntityRef ( const string & s ) [inline]

EntityRef constructors.

Definition at line 137 of file EntityRef.h.

asdm::EntityRef::EntityRef ( IDLEntityRef & )

asdm::EntityRef::EntityRef	(	string	entityId,
		string	partId,
		string	entityTypeName,
		string	instanceVersion
	)

asdm::EntityRef::~EntityRef ( ) [inline, virtual]

EntityRef destructor.

Definition at line 142 of file EntityRef.h.

asdm::EntityRef::EntityRef ( )

asdm::EntityRef::EntityRef ( const string & s )

asdm::EntityRef::EntityRef ( IDLEntityRef & )

asdm::EntityRef::EntityRef	(	string	entityId,
		string	partId,
		string	entityTypeName,
		string	instanceVersion
	)

virtual asdm::EntityRef::~EntityRef ( ) [virtual]

Member Function Documentation

bool asdm::EntityRef::equals ( const EntityRef & x ) const [inline]

Definition at line 152 of file EntityRef.h.

bool asdm::EntityRef::equals ( const EntityRef & ) const

static vector<EntityRef> asdm::EntityRef::from1DBin ( EndianIStream & eis ) [static]

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

Parameters:

dis	the EndianIStream to be read

Returns:: a vector of EntityRef

static vector<EntityRef> asdm::EntityRef::from1DBin ( EndianIStream & eis ) [static]

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

Parameters:

dis	the EndianIStream to be read

Returns:: a vector of EntityRef

static EntityRef asdm::EntityRef::fromBin ( EndianIStream & eis ) [static]

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

Parameters:

eis	the EndianStream to be read

Returns:: an EntityRef

static EntityRef asdm::EntityRef::fromBin ( EndianIStream & eis ) [static]

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

Parameters:

eis	the EndianStream to be read

Returns:: an EntityRef

EntityId asdm::EntityRef::getEntityId ( ) const

EntityId asdm::EntityRef::getEntityId ( ) const [inline]

Getters and Setters.

Definition at line 158 of file EntityRef.h.

static EntityRef asdm::EntityRef::getEntityRef ( StringTokenizer & t ) throw (InvalidArgumentException) [static]

string asdm::EntityRef::getEntityTypeName ( ) const [inline]

Definition at line 166 of file EntityRef.h.

string asdm::EntityRef::getEntityTypeName ( ) const

string asdm::EntityRef::getInstanceVersion ( ) const [inline]

Definition at line 170 of file EntityRef.h.

string asdm::EntityRef::getInstanceVersion ( ) const

PartId asdm::EntityRef::getPartId ( ) const

PartId asdm::EntityRef::getPartId ( ) const [inline]

Definition at line 162 of file EntityRef.h.

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

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

bool asdm::EntityRef::isNull ( ) const [inline]

Definition at line 144 of file EntityRef.h.

bool asdm::EntityRef::isNull ( ) const

bool asdm::EntityRef::operator!= ( const EntityRef & ) const

bool asdm::EntityRef::operator== ( const EntityRef & ) const

void asdm::EntityRef::setEntityId ( EntityId e ) [inline]

Definition at line 174 of file EntityRef.h.

References casa::C::e.

void asdm::EntityRef::setEntityId ( EntityId e )

void asdm::EntityRef::setEntityTypeName ( string s ) [inline]

Definition at line 182 of file EntityRef.h.

void asdm::EntityRef::setEntityTypeName ( string s )

void asdm::EntityRef::setFromXML ( string xml )

void asdm::EntityRef::setInstanceVersion ( string s )

void asdm::EntityRef::setInstanceVersion ( string s ) [inline]

Definition at line 186 of file EntityRef.h.

void asdm::EntityRef::setPartId ( PartId s ) [inline]

Definition at line 178 of file EntityRef.h.

void asdm::EntityRef::setPartId ( PartId s )

void asdm::EntityRef::toBin ( EndianOSStream & eoss ) const

Write the binary representation of this to a EndianOSStream.

void asdm::EntityRef::toBin ( EndianOSStream & eoss ) const

Write the binary representation of this to a EndianOSStream.

static void asdm::EntityRef::toBin	(	const vector< EntityRef > &	entityRef,
		EndianOSStream &	eoss
	)		`[static]`

Write the binary representation of a vector of EntityRef to an EndianOSStream.

static void asdm::EntityRef::toBin	(	const vector< EntityRef > &	entityRef,
		EndianOSStream &	eoss
	)		`[static]`

Write the binary representation of a vector of EntityRef to an EndianOSStream.

IDLEntityRef asdm::EntityRef::toIDLEntityRef ( ) const

string asdm::EntityRef::toString ( ) const

string asdm::EntityRef::toString ( ) const [inline]

Definition at line 148 of file EntityRef.h.

string asdm::EntityRef::toXML ( ) const throw (InvalidDataException)

Referenced by asdm::operator<<().

string asdm::EntityRef::toXML ( ) const throw (InvalidDataException)

string asdm::EntityRef::validXML ( ) const [private]

Friends And Related Function Documentation

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

Friend functions.

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

Friend functions.

Member Data Documentation

EntityId asdm::EntityRef::entityId [private]

Definition at line 126 of file EntityRef.h.

string asdm::EntityRef::entityTypeName [private]

Definition at line 128 of file EntityRef.h.

string asdm::EntityRef::instanceVersion [private]

Definition at line 129 of file EntityRef.h.

PartId asdm::EntityRef::partId [private]

Definition at line 127 of file EntityRef.h.

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

code/alma/ASDM/EntityRef.h
code/alma_v3/ASDM/EntityRef.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation