asdm::HolographyTable Class Reference

The HolographyTable class is an Alma table. More...

#include <HolographyTable.h>

Inheritance diagram for asdm::HolographyTable:

Public Member Functions
virtual	~HolographyTable ()
ASDM &	getContainer () const
	Return the container to which this table belongs.
unsigned int	size () const
	Return the number of rows in the table.
std::string	getName () const
	Return the name of this table.
std::string	getVersion () const
	Return the version information about this table.
Entity	getEntity () const
	Return this table's Entity.
void	setEntity (Entity e)
	Set this table's Entity.
std::string	toXML ()
	Produces an XML representation conform to the schema defined for Holography (HolographyTable.xsd).
asdmIDL::HolographyTableIDL *	toIDL ()
	Conversion Methods.
void	toIDL (asdmIDL::HolographyTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table.
void	fromIDL (asdmIDL::HolographyTableIDL x)
	Populate this table from the content of a HolographyTableIDL Corba structure.
HolographyRow *	newRow ()
	====> Row creation.
HolographyRow *	newRow (Length distance, Length focus, int numCorr, vector< HolographyChannelTypeMod::HolographyChannelType > type)
	Create a new row initialized to the specified values.
HolographyRow *	newRow (HolographyRow *row)
	Create a new row using a copy constructor mechanism.
HolographyRow *	add (HolographyRow *x)
	====> Append a row to its table.
std::vector< HolographyRow * >	get ()
	====> Methods returning rows.
const std::vector < HolographyRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
HolographyRow *	getRowByKey (Tag holographyId)
	Returns a HolographyRow* given a key.
HolographyRow *	lookup (Length distance, Length focus, int numCorr, vector< HolographyChannelTypeMod::HolographyChannelType > type)
	Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.
void	setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
BinaryAttributeReaderFunctor *	getUnknownAttributeBinaryReader (const std::string &attributeName) const
Static Public Member Functions
static const std::vector < std::string > &	getKeyName ()
	Return the list of field names that make up key key as an array of strings.
static std::string	name ()
	Return the name of this table.
static const std::vector < std::string > &	getAttributesNames ()
	Return the names of the attributes of this table.
static const std::vector < std::string > &	defaultAttributesNamesInBin ()
	Return the default sorted list of attributes names in the binary representation of the table.
Private Member Functions
	HolographyTable (ASDM &container)
	Create a HolographyTable.
void	autoIncrement (std::string key, HolographyRow *x)
HolographyRow *	checkAndAdd (HolographyRow *x, bool skipCheckUniqueness=false)
	If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.
void	append (HolographyRow *x)
	Brutally append an HolographyRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (HolographyRow *x)
	Brutally append an HolographyRow x to the collection of rows already stored in this table.
void	error ()
void	fromXML (std::string &xmlDoc)
	Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a Holography (HolographyTable.xsd).
void	setFromMIMEFile (const std::string &directory)
	Private methods involved during the build of this table out of the content of file(s) containing an external representation of a Holography table.
void	setFromXMLFile (const std::string &directory)
std::string	toMIME (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
	Serialize this into a stream of bytes and encapsulates that stream into a MIME message.
void	setFromMIME (const std::string &mimeMsg)
	Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.
std::string	MIMEXMLPart (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
	Private methods involved during the export of this table into disk file(s).
void	toFile (std::string directory)
	Stores a representation (binary or XML) of this table into a file.
void	checkPresenceInMemory ()
void	setFromFile (const std::string &directory)
	Reads and parses a file containing a representation of a HolographyTable as those produced by the toFile method.
Private Attributes
ASDM &	container
bool	archiveAsBin
bool	fileAsBin
std::string	version
Entity	entity
std::map< std::string, int >	noAutoIncIds
	A map for the autoincrementation algorithm.
std::vector< HolographyRow * >	privateRows
	A data structure to store the pointers on the table's rows.
std::vector< HolographyRow * >	row
std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors
bool	loadInProgress
	Load the table in memory if necessary.
Friends
class	ASDM

Detailed Description

The HolographyTable class is an Alma table.

Role: Used for Single-Dish holography with a fixed transmitter.

Generated from model's revision "1.64", branch "HEAD"

Attributes of Holography
Name	Type	Expected shape	Comment
Key
holographyId	Tag		identifies a unique row in the table.
Value (Mandatory)
distance	Length		the distance to transmitter.
focus	Length		displacement of the feed from the primary nominal focus.
numCorr	int		the number of stored correlations.
type	vector<HolographyChannelTypeMod::HolographyChannelType >	numCorr	identifies the types of the correlation signals.

Definition at line 151 of file HolographyTable.h.

Constructor & Destructor Documentation

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

asdm::HolographyTable::HolographyTable ( ASDM & container ) [private]

Create a HolographyTable.

This constructor is private because only the container can create tables. All tables must know the container to which they belong.

Parameters:

container

The container to which this table belongs.

Member Function Documentation

HolographyRow* asdm::HolographyTable::add ( HolographyRow * x )

====> Append a row to its table.

Add a row. If there table contains a row whose key's fields are equal to x's ones then return a pointer on this row (i.e. no actual insertion is performed) otherwise add x to the table and return x.

Parameters:

x

. A pointer on the row to be added.

Returns:: a pointer to a HolographyRow.

void asdm::HolographyTable::addWithoutCheckingUnique ( HolographyRow * x ) [private]

Brutally append an HolographyRow x to the collection of rows already stored in this table.

No uniqueness check is done !

Parameters:

HolographyRow*

x a pointer onto the HolographyRow to be appended.

void asdm::HolographyTable::append ( HolographyRow * x ) [private]

Brutally append an HolographyRow x to the collection of rows already stored in this table.

No uniqueness check is done !

Parameters:

HolographyRow*

x a pointer onto the HolographyRow to be appended.

void asdm::HolographyTable::autoIncrement	(	std::string	key,
		HolographyRow *	x
	)			`[private]`

HolographyRow* asdm::HolographyTable::checkAndAdd	(	HolographyRow *	x,
		bool	skipCheckUniqueness = `false`
	)			`[private]`

If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.

Check if *x verifies the key uniqueness rule and throw an exception if not. Append x to its table.

Exceptions:

	DuplicateKey
	UniquenessViolationException

void asdm::HolographyTable::checkPresenceInMemory ( ) [inline, private]

Definition at line 517 of file HolographyTable.h.

References getContainer(), loadInProgress, asdm::Representable::presentInMemory, and setFromFile().

static const std::vector<std::string>& asdm::HolographyTable::defaultAttributesNamesInBin ( ) [static]

Return the default sorted list of attributes names in the binary representation of the table.

Returns:: a const reference to a vector of string

void asdm::HolographyTable::error ( ) [private]

void asdm::HolographyTable::fromIDL ( asdmIDL::HolographyTableIDL x )

Populate this table from the content of a HolographyTableIDL Corba structure.

Exceptions:

	DuplicateKey	Thrown if the method tries to add a row having a key that is already in the table.
	ConversionException

void asdm::HolographyTable::fromXML ( std::string & xmlDoc ) [private]

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a Holography (HolographyTable.xsd).

Exceptions:

ConversionException

const std::vector<HolographyRow *>& asdm::HolographyTable::get ( ) const

Get a const reference on the collection of rows pointers internally hold by the table.

Returns:: A const reference of a vector of pointers of HolographyRow. The elements of this vector are stored in the order in which they have been added to the HolographyTable.

std::vector<HolographyRow *> asdm::HolographyTable::get ( )

====> Methods returning rows.

Get a collection of pointers on the rows of the table.

Returns:: Alls rows in a vector of pointers of HolographyRow. The elements of this vector are stored in the order in which they have been added to the HolographyTable.

static const std::vector<std::string>& asdm::HolographyTable::getAttributesNames ( ) [static]

Return the names of the attributes of this table.

Returns:: a vector of string

ASDM& asdm::HolographyTable::getContainer ( ) const

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::HolographyTable::getEntity ( ) const [virtual]

Return this table's Entity.

Implements asdm::Representable.

static const std::vector<std::string>& asdm::HolographyTable::getKeyName ( ) [static]

Return the list of field names that make up key key as an array of strings.

Returns:: a vector of string.

std::string asdm::HolographyTable::getName ( ) const [virtual]

Return the name of this table.

This is a instance method of the class.

Returns:: the name of this table in a string.

Implements asdm::Representable.

HolographyRow* asdm::HolographyTable::getRowByKey ( Tag holographyId )

Returns a HolographyRow* given a key.

Returns:: a pointer to the row having the key whose values are passed as parameters, or 0 if no row exists for that key.

Parameters:

holographyId

BinaryAttributeReaderFunctor* asdm::HolographyTable::getUnknownAttributeBinaryReader ( const std::string & attributeName ) const

std::string asdm::HolographyTable::getVersion ( ) const

Return the version information about this table.

HolographyRow* asdm::HolographyTable::lookup	(	Length	distance,
		Length	focus,
		int	numCorr,
		vector< HolographyChannelTypeMod::HolographyChannelType >	type
	)

Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.

Returns:: a pointer on this row if any, null otherwise.

Parameters:

	distance
	focus
	numCorr
	type

std::string asdm::HolographyTable::MIMEXMLPart ( const asdm::ByteOrder * byteOrder = asdm::ByteOrder::Machine_Endianity ) [private]

Private methods involved during the export of this table into disk file(s).

static std::string asdm::HolographyTable::name ( ) [static]

Return the name of this table.

This is a static method of the class.

Returns:: the name of this table in a string.

HolographyRow* asdm::HolographyTable::newRow ( HolographyRow * row )

Create a new row using a copy constructor mechanism.

The method creates a new HolographyRow owned by this. Each attribute of the created row is a (deep) copy of the corresponding attribute of row. The method does not add the created row to this, its simply parents it to this, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a new HolographyRow with default values for its attributes.

Parameters:

row

the row which is to be copied.

HolographyRow* asdm::HolographyTable::newRow	(	Length	distance,
		Length	focus,
		int	numCorr,
		vector< HolographyChannelTypeMod::HolographyChannelType >	type
	)

Create a new row initialized to the specified values.

Returns:: a pointer on the created and initialized row.

Parameters:

	distance
	focus
	numCorr
	type

HolographyRow* asdm::HolographyTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a HolographyRow

void asdm::HolographyTable::setEntity ( Entity e ) [virtual]

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

void asdm::HolographyTable::setFromFile ( const std::string & directory ) [private]

Reads and parses a file containing a representation of a HolographyTable as those produced by the toFile method.

This table is populated with the result of the parsing.

Parameters:

directory

The name of the directory containing the file te be read and parsed.

Exceptions:

ConversionException

If any error occurs while reading the files in the directory or parsing them.

Referenced by checkPresenceInMemory().

void asdm::HolographyTable::setFromMIME ( const std::string & mimeMsg ) [private]

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.

Parameters:

mimeMsg

the string containing the MIME message.

Exceptions:

ConversionException

void asdm::HolographyTable::setFromMIMEFile ( const std::string & directory ) [private]

Private methods involved during the build of this table out of the content of file(s) containing an external representation of a Holography table.

void asdm::HolographyTable::setFromXMLFile ( const std::string & directory ) [private]

void asdm::HolographyTable::setUnknownAttributeBinaryReader	(	const std::string &	attributeName,
		BinaryAttributeReaderFunctor *	barFctr
	)

unsigned int asdm::HolographyTable::size ( ) const [virtual]

Return the number of rows in the table.

Returns:: the number of rows in an unsigned int.

Implements asdm::Representable.

void asdm::HolographyTable::toFile ( std::string directory ) [private]

Stores a representation (binary or XML) of this table into a file.

Depending on the boolean value of its private field fileAsBin a binary serialization of this (fileAsBin==true) will be saved in a file "Holography.bin" or an XML representation (fileAsBin==false) will be saved in a file "Holography.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:

directory

The name of directory where the file containing the table's representation will be saved.

void asdm::HolographyTable::toIDL ( asdmIDL::HolographyTableIDL & x ) const

Fills the CORBA data structure passed in parameter with the content of this table.

Parameters:

x

a reference to the asdmIDL::HolographyTableIDL to be populated with the content of this.

asdmIDL::HolographyTableIDL* asdm::HolographyTable::toIDL ( )

Conversion Methods.

Convert this table into a HolographyTableIDL CORBA structure.