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

#include <CalAntennaSolutionsTable.h>

Inheritance diagram for asdm::CalAntennaSolutionsTable:

Public Member Functions
virtual	~CalAntennaSolutionsTable ()

ASDM &	getContainer () const
	Return the container to which this table belongs. More...

unsigned int	size () const
	Return the number of rows in the table. More...

std::string	getName () const
	Return the name of this table. More...

std::string	getVersion () const
	Return the version information about this table. More...

Entity	getEntity () const
	Return this table's Entity. More...

void	setEntity (Entity e)
	Set this table's Entity. More...

std::string	toXML ()
	Produces an XML representation conform to the schema defined for CalAntennaSolutions (CalAntennaSolutionsTable.xsd). More...

asdmIDL::CalAntennaSolutionsTableIDL *	toIDL ()
	Conversion Methods. More...

void	toIDL (asdmIDL::CalAntennaSolutionsTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table. More...

void	fromIDL (asdmIDL::CalAntennaSolutionsTableIDL x)
	Populate this table from the content of a CalAntennaSolutionsTableIDL Corba structure. More...

CalAntennaSolutionsRow *	newRow ()
	====> Row creation. More...

CalAntennaSolutionsRow *	newRow (std::string antennaName, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, ReceiverBandMod::ReceiverBand receiverBand, BasebandNameMod::BasebandName basebandName, Tag calDataId, Tag calReductionId, Tag spectralWindowId, ArrayTime startValidTime, ArrayTime endValidTime, int numReceptor, std::string refAntennaName, std::vector< Angle > direction, std::vector< Frequency > frequencyRange, Interval integrationTime, std::vector< PolarizationTypeMod::PolarizationType > polarizationTypes, bool correctionValidity, std::vector< float > phaseAnt, std::vector< float > phaseAntRMS, std::vector< float > amplitudeAnt, std::vector< float > amplitudeAntRMS)
	Create a new row initialized to the specified values. More...

CalAntennaSolutionsRow *	newRow (CalAntennaSolutionsRow *row)
	Create a new row using a copy constructor mechanism. More...

CalAntennaSolutionsRow *	add (CalAntennaSolutionsRow *x)
	====> Append a row to its table. More...

std::vector < CalAntennaSolutionsRow * >	get ()
	====> Methods returning rows. More...

const std::vector < CalAntennaSolutionsRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table. More...

CalAntennaSolutionsRow *	getRowByKey (std::string antennaName, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, ReceiverBandMod::ReceiverBand receiverBand, BasebandNameMod::BasebandName basebandName, Tag calDataId, Tag calReductionId, Tag spectralWindowId)
	Returns a CalAntennaSolutionsRow* given a key. More...

CalAntennaSolutionsRow *	lookup (std::string antennaName, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, ReceiverBandMod::ReceiverBand receiverBand, BasebandNameMod::BasebandName basebandName, Tag calDataId, Tag calReductionId, Tag spectralWindowId, ArrayTime startValidTime, ArrayTime endValidTime, int numReceptor, std::string refAntennaName, std::vector< Angle > direction, std::vector< Frequency > frequencyRange, Interval integrationTime, std::vector< PolarizationTypeMod::PolarizationType > polarizationTypes, bool correctionValidity, std::vector< float > phaseAnt, std::vector< float > phaseAntRMS, std::vector< float > amplitudeAnt, std::vector< float > amplitudeAntRMS)
	Look up the table for a row whose all attributes are equal to the corresponding parameters of the method. More...

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

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

Public Member Functions inherited from asdm::Representable
virtual	~Representable ()

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. More...

static std::string	name ()
	Return the name of this table. More...

static const std::vector < std::string > &	getAttributesNames ()
	Return the names of the attributes of this table. More...

static const std::vector < std::string > &	defaultAttributesNamesInBin ()
	Return the default sorted list of attributes names in the binary representation of the table. More...

Private Member Functions
	CalAntennaSolutionsTable (ASDM &container)
	Create a CalAntennaSolutionsTable. More...

CalAntennaSolutionsRow *	checkAndAdd (CalAntennaSolutionsRow *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. More...

void	append (CalAntennaSolutionsRow *x)
	Brutally append an CalAntennaSolutionsRow x to the collection of rows already stored in this table. More...

void	addWithoutCheckingUnique (CalAntennaSolutionsRow *x)
	Brutally append an CalAntennaSolutionsRow x to the collection of rows already stored in this table. More...

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 CalAntennaSolutions (CalAntennaSolutionsTable.xsd). More...

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 CalAntennaSolutions table. More...

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. More...

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. More...

std::string	MIMEXMLPart (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
	Private methods involved during the export of this table into disk file(s). More...

void	toFile (std::string directory)
	Stores a representation (binary or XML) of this table into a file. More...

void	checkPresenceInMemory ()

void	setFromFile (const std::string &directory)
	Reads and parses a file containing a representation of a CalAntennaSolutionsTable as those produced by the toFile method. More...

Private Attributes
ASDM &	container

bool	archiveAsBin

bool	fileAsBin

std::string	version

Entity	entity

std::vector < CalAntennaSolutionsRow * >	privateRows
	A data structure to store the pointers on the table's rows. More...

std::vector < CalAntennaSolutionsRow * >	row

std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors

bool	loadInProgress
	Load the table in memory if necessary. More...

Friends
class	ASDM

Additional Inherited Members
Protected Attributes inherited from asdm::Representable
bool	presentInMemory

bool	loadInProgress

uint32_t	declaredSize

Detailed Description

The CalAntennaSolutionsTable class is an Alma table.

Role: Results of atmosphere calibration by TelCal. This calibration determines the system temperatures corrected for atmospheric absorption. Ionospheric effects are not dealt with in the Table. Note: spectralWindowId was added here after SDMs with this table were produced by ALMA. No xml versions of this table were produced prior to that change, only bin versions.

Generated from model's revision "-1", branch ""

Attributes of CalAntennaSolutions
Name	Type	Expected shape	Comment
Key
antennaName	std::string		the name of the antenna.
atmPhaseCorrection	AtmPhaseCorrectionMod::AtmPhaseCorrection		describes how the atmospheric phase correction has been applied.
receiverBand	ReceiverBandMod::ReceiverBand		identifies the receiver band.
basebandName	BasebandNameMod::BasebandName		identifies the baseband.
calDataId	Tag		refers to a unique row in CalData Table.
calReductionId	Tag		refers to a unique row in CalReduction Table.
spectralWindowId	Tag		Identifies a unique row in the SpectralWindow table.
Value (Mandatory)
startValidTime	ArrayTime		the start time of result validity period.
endValidTime	ArrayTime		the end time of result validity period.
numReceptor (numReceptor)	int		the number of receptors.
refAntennaName	std::string		The reference anntenna name.
direction	std::vector<Angle >	2	the direction of the source.
frequencyRange	std::vector<Frequency >	2	the frequency range.
integrationTime	Interval		the integration duration for a data point.
polarizationTypes	std::vector<PolarizationTypeMod::PolarizationType >	numReceptor	the polarizations of the receptors (an array with one value per receptor).
correctionValidity	bool		the deduced validity of atmospheric path length correction (from water vapor radiometers).
phaseAnt	std::vector<float >	numReceptor	the anntenna based phase solution averaged over the scan.
phaseAntRMS	std::vector<float >	numReceptor	the RMS of the phase fluctuations relative to the antenna based average phase.
amplitudeAnt	std::vector<float >	numReceptor	the antennna based amplitude solution averaged over the scan.
amplitudeAntRMS	std::vector<float >	numReceptor	the RMS of the amplitude fluctuations relattive to the antenna based average amplitude (one value per receptor per antenna).

Definition at line 310 of file CalAntennaSolutionsTable.h.

Constructor & Destructor Documentation

virtual asdm::CalAntennaSolutionsTable::~CalAntennaSolutionsTable ( )

virtual

asdm::CalAntennaSolutionsTable::CalAntennaSolutionsTable ( ASDM & container )

private

Create a CalAntennaSolutionsTable.

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

CalAntennaSolutionsRow* asdm::CalAntennaSolutionsTable::add ( CalAntennaSolutionsRow * x )

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

Add a row.

Parameters

x	a pointer to the CalAntennaSolutionsRow to be added.

Returns: a pointer to a CalAntennaSolutionsRow. If the table contains a CalAntennaSolutionsRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that CalAntennaSolutionsRow, otherwise returns x.

Exceptions

DuplicateKey { thrown when the table contains a CalAntennaSolutionsRow with a key equal to the x one but having and a value section different from x one }

void asdm::CalAntennaSolutionsTable::addWithoutCheckingUnique ( CalAntennaSolutionsRow * x )

private

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

No uniqueness check is done !

Parameters

CalAntennaSolutionsRow* x a pointer onto the CalAntennaSolutionsRow to be appended.

void asdm::CalAntennaSolutionsTable::append ( CalAntennaSolutionsRow * x )

private

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

No uniqueness check is done !

Parameters

CalAntennaSolutionsRow* x a pointer onto the CalAntennaSolutionsRow to be appended.

CalAntennaSolutionsRow* asdm::CalAntennaSolutionsTable::checkAndAdd	(	CalAntennaSolutionsRow *	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

void asdm::CalAntennaSolutionsTable::checkPresenceInMemory ( )

inlineprivate

Definition at line 752 of file CalAntennaSolutionsTable.h.

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

static const std::vector<std::string>& asdm::CalAntennaSolutionsTable::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::CalAntennaSolutionsTable::error ( )

private

void asdm::CalAntennaSolutionsTable::fromIDL ( asdmIDL::CalAntennaSolutionsTableIDL x )

Populate this table from the content of a CalAntennaSolutionsTableIDL 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::CalAntennaSolutionsTable::fromXML ( std::string & xmlDoc )

privatevirtual

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

Exceptions

ConversionException

Implements asdm::Representable.

std::vector<CalAntennaSolutionsRow *> asdm::CalAntennaSolutionsTable::get ( )

====> Methods returning rows.

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

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

const std::vector<CalAntennaSolutionsRow *>& asdm::CalAntennaSolutionsTable::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 CalAntennaSolutionsRow. The elements of this vector are stored in the order in which they have been added to the CalAntennaSolutionsTable.

static const std::vector<std::string>& asdm::CalAntennaSolutionsTable::getAttributesNames ( )

static

Return the names of the attributes of this table.

Returns: a vector of string

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

Return the container to which this table belongs.

Returns: the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::CalAntennaSolutionsTable::getEntity ( ) const

virtual

Return this table's Entity.

Implements asdm::Representable.

static const std::vector<std::string>& asdm::CalAntennaSolutionsTable::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::CalAntennaSolutionsTable::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.

CalAntennaSolutionsRow* asdm::CalAntennaSolutionsTable::getRowByKey	(	std::string	antennaName,
		AtmPhaseCorrectionMod::AtmPhaseCorrection	atmPhaseCorrection,
		ReceiverBandMod::ReceiverBand	receiverBand,
		BasebandNameMod::BasebandName	basebandName,
		Tag	calDataId,
		Tag	calReductionId,
		Tag	spectralWindowId
	)

Returns a CalAntennaSolutionsRow* 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

antennaName
atmPhaseCorrection
receiverBand
basebandName
calDataId
calReductionId
spectralWindowId

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

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

Return the version information about this table.

CalAntennaSolutionsRow* asdm::CalAntennaSolutionsTable::lookup	(	std::string	antennaName,
		AtmPhaseCorrectionMod::AtmPhaseCorrection	atmPhaseCorrection,
		ReceiverBandMod::ReceiverBand	receiverBand,
		BasebandNameMod::BasebandName	basebandName,
		Tag	calDataId,
		Tag	calReductionId,
		Tag	spectralWindowId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		int	numReceptor,
		std::string	refAntennaName,
		std::vector< Angle >	direction,
		std::vector< Frequency >	frequencyRange,
		Interval	integrationTime,
		std::vector< PolarizationTypeMod::PolarizationType >	polarizationTypes,
		bool	correctionValidity,
		std::vector< float >	phaseAnt,
		std::vector< float >	phaseAntRMS,
		std::vector< float >	amplitudeAnt,
		std::vector< float >	amplitudeAntRMS
	)

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

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

Parameters

antennaName
atmPhaseCorrection
receiverBand
basebandName
calDataId
calReductionId
spectralWindowId
startValidTime
endValidTime
numReceptor
refAntennaName
direction
frequencyRange
integrationTime
polarizationTypes
correctionValidity
phaseAnt
phaseAntRMS
amplitudeAnt
amplitudeAntRMS

std::string asdm::CalAntennaSolutionsTable::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::CalAntennaSolutionsTable::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.

CalAntennaSolutionsRow* asdm::CalAntennaSolutionsTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns: a pointer on a CalAntennaSolutionsRow

CalAntennaSolutionsRow* asdm::CalAntennaSolutionsTable::newRow	(	std::string	antennaName,
		AtmPhaseCorrectionMod::AtmPhaseCorrection	atmPhaseCorrection,
		ReceiverBandMod::ReceiverBand	receiverBand,
		BasebandNameMod::BasebandName	basebandName,
		Tag	calDataId,
		Tag	calReductionId,
		Tag	spectralWindowId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		int	numReceptor,
		std::string	refAntennaName,
		std::vector< Angle >	direction,
		std::vector< Frequency >	frequencyRange,
		Interval	integrationTime,
		std::vector< PolarizationTypeMod::PolarizationType >	polarizationTypes,
		bool	correctionValidity,
		std::vector< float >	phaseAnt,
		std::vector< float >	phaseAntRMS,
		std::vector< float >	amplitudeAnt,
		std::vector< float >	amplitudeAntRMS
	)

Create a new row initialized to the specified values.

Returns: a pointer on the created and initialized row.

Parameters

antennaName
atmPhaseCorrection
receiverBand
basebandName
calDataId
calReductionId
spectralWindowId
startValidTime
endValidTime
numReceptor
refAntennaName
direction
frequencyRange
integrationTime
polarizationTypes
correctionValidity
phaseAnt
phaseAntRMS
amplitudeAnt
amplitudeAntRMS

CalAntennaSolutionsRow* asdm::CalAntennaSolutionsTable::newRow ( CalAntennaSolutionsRow * row )

Create a new row using a copy constructor mechanism.

The method creates a new CalAntennaSolutionsRow 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 CalAntennaSolutionsRow with default values for its attributes.

Parameters

row	the row which is to be copied.

void asdm::CalAntennaSolutionsTable::setEntity ( Entity e )

virtual

Set this table's Entity.

Parameters

e	An entity.

Implements asdm::Representable.

void asdm::CalAntennaSolutionsTable::setFromFile ( const std::string & directory )

private

Reads and parses a file containing a representation of a CalAntennaSolutionsTable 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::CalAntennaSolutionsTable::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::CalAntennaSolutionsTable::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 CalAntennaSolutions table.

void asdm::CalAntennaSolutionsTable::setFromXMLFile ( const std::string & directory )

private

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

unsigned int asdm::CalAntennaSolutionsTable::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::CalAntennaSolutionsTable::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 "CalAntennaSolutions.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalAntennaSolutions.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.

asdmIDL::CalAntennaSolutionsTableIDL* asdm::CalAntennaSolutionsTable::toIDL ( )

Conversion Methods.

Convert this table into a CalAntennaSolutionsTableIDL CORBA structure.