asdm::EntityRef Class Reference

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

#include <EntityRef.h>

Public Member Functions
	EntityRef ()
	EntityRef (const std::string &s)
	EntityRef constructors. More...
	EntityRef (asdmIDLTypes::IDLEntityRef &)
	EntityRef (std::string entityId, std::string partId, std::string entityTypeName, std::string instanceVersion)
virtual	~EntityRef ()
	EntityRef destructor. More...
bool	operator== (const EntityRef &) const
bool	equals (const EntityRef &) const
bool	operator!= (const EntityRef &) const
bool	isNull () const
std::string	toString () const
std::string	toXML () const throw (InvalidDataException)
asdmIDLTypes::IDLEntityRef	toIDLEntityRef () const
void	setFromXML (std::string xml)
void	toBin (EndianOSStream &eoss) const
	Write the binary representation of this to a EndianOSStream. More...
EntityId	getEntityId () const
	Getters and Setters. More...
PartId	getPartId () const
std::string	getEntityTypeName () const
std::string	getInstanceVersion () const
void	setEntityId (EntityId e)
void	setPartId (PartId s)
void	setEntityTypeName (std::string s)
void	setInstanceVersion (std::string s)

Static Public Member Functions
static EntityRef	getEntityRef (StringTokenizer &t) throw (InvalidArgumentException)
static void	toBin (const std::vector< EntityRef > &entityRef, EndianOSStream &eoss)
	Write the binary representation of a vector of EntityRef to an EndianOSStream. More...
static EntityRef	fromBin (EndianIStream &eis)
	Read the binary representation of an EntityRef from a EndianIStream and use the read value to set an EntityRef. More...
static std::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. More...

Private Member Functions
std::string	getXMLValue (std::string xml, std::string parm) const
std::string	validXML () const

Private Attributes
EntityId	entityId
PartId	partId
std::string	entityTypeName
std::string	instanceVersion

Friends
std::ostream &	operator<< (std::ostream &, const EntityRef &)
	Friend functions. More...

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 58 of file EntityRef.h.

Constructor & Destructor Documentation

asdm::EntityRef::EntityRef

(

)

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

inline

EntityRef constructors.

Definition at line 132 of file EntityRef.h.

References setFromXML().

asdm::EntityRef::EntityRef

(

asdmIDLTypes::IDLEntityRef &

)

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

asdm::EntityRef::~EntityRef ( )

inlinevirtual

EntityRef destructor.

Definition at line 137 of file EntityRef.h.

Member Function Documentation

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

inline

Definition at line 147 of file EntityRef.h.

static std::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

EntityId asdm::EntityRef::getEntityId ( ) const

inline

Getters and Setters.

Definition at line 153 of file EntityRef.h.

References entityId.

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

static

std::string asdm::EntityRef::getEntityTypeName ( ) const

inline

Definition at line 161 of file EntityRef.h.

References entityTypeName.

std::string asdm::EntityRef::getInstanceVersion ( ) const

inline

Definition at line 165 of file EntityRef.h.

References instanceVersion.

PartId asdm::EntityRef::getPartId ( ) const

inline

Definition at line 157 of file EntityRef.h.

References partId.

std::string asdm::EntityRef::getXMLValue ( std::string  xml, std::string  parm  ) const

private

bool asdm::EntityRef::isNull ( ) const

inline

Definition at line 139 of file EntityRef.h.

References entityId, and asdm::EntityId::isNull().

bool asdm::EntityRef::operator!=

(

const EntityRef &

)

const

bool asdm::EntityRef::operator==

(

const EntityRef &

)

const

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

inline

Definition at line 169 of file EntityRef.h.

References casacore::C::e, and entityId.

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

inline

Definition at line 177 of file EntityRef.h.

References entityTypeName.

void asdm::EntityRef::setFromXML

(

std::string

xml

)

Referenced by EntityRef().

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

inline

Definition at line 181 of file EntityRef.h.

References instanceVersion.

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

inline

Definition at line 173 of file EntityRef.h.

References partId.

void asdm::EntityRef::toBin

(

EndianOSStream &

eoss

)

const

Write the binary representation of this to a EndianOSStream.

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

static

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

asdmIDLTypes::IDLEntityRef asdm::EntityRef::toIDLEntityRef

(

)

const

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

inline

Definition at line 143 of file EntityRef.h.

References toXML().

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

Referenced by asdm::operator<<(), and toString().

std::string asdm::EntityRef::validXML ( ) const

private

Friends And Related Function Documentation

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

friend

Friend functions.

Member Data Documentation

EntityId asdm::EntityRef::entityId

private

Definition at line 121 of file EntityRef.h.

Referenced by getEntityId(), isNull(), and setEntityId().

std::string asdm::EntityRef::entityTypeName

private

Definition at line 123 of file EntityRef.h.

Referenced by getEntityTypeName(), and setEntityTypeName().

std::string asdm::EntityRef::instanceVersion

private

Definition at line 124 of file EntityRef.h.

Referenced by getInstanceVersion(), and setInstanceVersion().

PartId asdm::EntityRef::partId

private

Definition at line 122 of file EntityRef.h.

Referenced by getPartId(), and setPartId().

---

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

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