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

#include <CalAppPhaseTable.h>

Inheritance diagram for asdm::CalAppPhaseTable:

Public Member Functions
virtual	~CalAppPhaseTable ()

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 CalAppPhase (CalAppPhaseTable.xsd). More...

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

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

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

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

CalAppPhaseRow *	newRow (BasebandNameMod::BasebandName basebandName, int scanNumber, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, ArrayTime adjustTime, std::string adjustToken, std::string phasingMode, int numPhasedAntennas, std::vector< std::string > phasedAntennas, int refAntennaIndex, int candRefAntennaIndex, std::string phasePacking, int numReceptors, int numChannels, int numPhaseValues, std::vector< float > phaseValues, int numCompare, int numEfficiencies, std::vector< std::string > compareArray, std::vector< int > efficiencyIndices, std::vector< std::vector< float > > efficiencies, std::vector< float > quality, std::string phasedSumAntenna)
	Create a new row initialized to the specified values. More...

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

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

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

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

CalAppPhaseRow *	getRowByKey (BasebandNameMod::BasebandName basebandName, int scanNumber, Tag calDataId, Tag calReductionId)
	Returns a CalAppPhaseRow* given a key. More...

CalAppPhaseRow *	lookup (BasebandNameMod::BasebandName basebandName, int scanNumber, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, ArrayTime adjustTime, std::string adjustToken, std::string phasingMode, int numPhasedAntennas, std::vector< std::string > phasedAntennas, int refAntennaIndex, int candRefAntennaIndex, std::string phasePacking, int numReceptors, int numChannels, int numPhaseValues, std::vector< float > phaseValues, int numCompare, int numEfficiencies, std::vector< std::string > compareArray, std::vector< int > efficiencyIndices, std::vector< std::vector< float > > efficiencies, std::vector< float > quality, std::string phasedSumAntenna)
	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
	CalAppPhaseTable (ASDM &container)
	Create a CalAppPhaseTable. More...

CalAppPhaseRow *	checkAndAdd (CalAppPhaseRow *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 (CalAppPhaseRow *x)
	Brutally append an CalAppPhaseRow x to the collection of rows already stored in this table. More...

void	addWithoutCheckingUnique (CalAppPhaseRow *x)
	Brutally append an CalAppPhaseRow 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 CalAppPhase (CalAppPhaseTable.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 CalAppPhase 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 CalAppPhaseTable as those produced by the toFile method. More...

Private Attributes
ASDM &	container

bool	archiveAsBin

bool	fileAsBin

std::string	version

Entity	entity

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

std::vector< CalAppPhaseRow * >	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 CalAppPhaseTable class is an Alma table.

Role: The CalAppPhase table is relevant to the ALMA observatory when the antennas are being phased to form a coherent sum during the observation. For each scan, the table provides information about which antennas are included in the sum, their relative phase adjustments, the efficiency of the sum (relative to best performance) and the quality of each antenna participating in the system. This data is used in real-time to provide the phased sum signal, and after the observation to analyze the result.

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

Attributes of CalAppPhase
Name	Type	Expected shape	Comment
Key
basebandName	BasebandNameMod::BasebandName		identifies the baseband.
scanNumber	int		The number of the scan processed by TELCAL. Along with an ExecBlock Id (which should be ExecBlock_0 most of the time), the value of scanNumber can be used as the key to retrieve informations related to the scan (e.g. its start time).
calDataId	Tag		identifies a unique row in the CalData table.
calReductionId	Tag		identifies a unique row in the CalReduction table.
Value (Mandatory)
startValidTime	ArrayTime		start of phasing solution validity.
endValidTime	ArrayTime		end of phasing solution validity.
adjustTime	ArrayTime		The time of the last adjustment to the phasing analysis via the `ParameterTuning` interface.
adjustToken	std::string		A parameter supplied via the `ParameterTuning` interface to indicate the form of adjustment(s) made at adjustTime. Note that TELCAL merely passes this datum and adjustTime through to this table.
phasingMode	std::string		The mode in which the phasing system is being operated.
numPhasedAntennas (numPhasedAntennas)	int		the number of antennas in phased sum, .
phasedAntennas	std::vector<std::string >	numPhasedAntennas	the names of the phased antennas.
refAntennaIndex	int		the index of the reference antenna in the array `phasedAntennas` . It must be an integer value in the interval .
candRefAntennaIndex	int		tne index of a candidate (new) reference antenna in the array phasedAntennas; it must be a integer in the interval .
phasePacking	std::string		how to unpack `phaseValues`.
numReceptors (numReceptors)	int		the number of receptors per antenna, .The number ( $N_r \le 2$ ) of receptors per antenna, usually two (polarizations), but it might be one in special cases.
numChannels (numChannels)	int		the number of data channels, .
numPhaseValues (numPhaseValues)	int		The number of phase data values present in the table, .
phaseValues	std::vector<float >	numPhaseValues	the array of phase data values.
numCompare (numCompare)	int		the number of comparison antennas, .
numEfficiencies (numEfficiencies)	int		the number of efficiencies, .
compareArray	std::vector<std::string >	numCompare	the names of the comparison antennas.
efficiencyIndices	std::vector<int >	numEfficiencies	indices of the antenna(s) in `compareArray` used to calculate `efficiencies`; they must be distinct integers in the interval .
efficiencies	std::vector<std::vector<float > >	numEfficiencies, numChannels	an array of efficiencies of phased sum.
quality	std::vector<float >	numPhasedAntennas+numCompare	quality of phased antennas.
phasedSumAntenna	std::string		the name of the phased sum antenna.
Value (Optional)
typeSupports	std::string		encoding of supporting data values.
numSupports(numSupports)	int		the number of supporting data values, .
phaseSupports	std::vector<float >	numSupports	an array of supporting data values.

Definition at line 363 of file CalAppPhaseTable.h.

Constructor & Destructor Documentation

virtual asdm::CalAppPhaseTable::~CalAppPhaseTable ( )

virtual

asdm::CalAppPhaseTable::CalAppPhaseTable ( ASDM & container )

private

Create a CalAppPhaseTable.

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

CalAppPhaseRow* asdm::CalAppPhaseTable::add ( CalAppPhaseRow * x )

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

Add a row.

Parameters

x	a pointer to the CalAppPhaseRow to be added.

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

Exceptions

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

void asdm::CalAppPhaseTable::addWithoutCheckingUnique ( CalAppPhaseRow * x )

private

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

No uniqueness check is done !

Parameters

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

void asdm::CalAppPhaseTable::append ( CalAppPhaseRow * x )

private

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

No uniqueness check is done !

Parameters

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

CalAppPhaseRow* asdm::CalAppPhaseTable::checkAndAdd	(	CalAppPhaseRow *	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::CalAppPhaseTable::checkPresenceInMemory ( )

inlineprivate

Definition at line 819 of file CalAppPhaseTable.h.

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

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

private

void asdm::CalAppPhaseTable::fromIDL ( asdmIDL::CalAppPhaseTableIDL x )

Populate this table from the content of a CalAppPhaseTableIDL 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::CalAppPhaseTable::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 CalAppPhase (CalAppPhaseTable.xsd).

Exceptions

ConversionException

Implements asdm::Representable.

std::vector<CalAppPhaseRow *> asdm::CalAppPhaseTable::get ( )

====> Methods returning rows.

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

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

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

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

static

Return the names of the attributes of this table.

Returns: a vector of string

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

Return the container to which this table belongs.

Returns: the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::CalAppPhaseTable::getEntity ( ) const

virtual

Return this table's Entity.

Implements asdm::Representable.

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

CalAppPhaseRow* asdm::CalAppPhaseTable::getRowByKey	(	BasebandNameMod::BasebandName	basebandName,
		int	scanNumber,
		Tag	calDataId,
		Tag	calReductionId
	)

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

basebandName
scanNumber
calDataId
calReductionId

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

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

Return the version information about this table.

CalAppPhaseRow* asdm::CalAppPhaseTable::lookup	(	BasebandNameMod::BasebandName	basebandName,
		int	scanNumber,
		Tag	calDataId,
		Tag	calReductionId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		ArrayTime	adjustTime,
		std::string	adjustToken,
		std::string	phasingMode,
		int	numPhasedAntennas,
		std::vector< std::string >	phasedAntennas,
		int	refAntennaIndex,
		int	candRefAntennaIndex,
		std::string	phasePacking,
		int	numReceptors,
		int	numChannels,
		int	numPhaseValues,
		std::vector< float >	phaseValues,
		int	numCompare,
		int	numEfficiencies,
		std::vector< std::string >	compareArray,
		std::vector< int >	efficiencyIndices,
		std::vector< std::vector< float > >	efficiencies,
		std::vector< float >	quality,
		std::string	phasedSumAntenna
	)

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

basebandName
scanNumber
calDataId
calReductionId
startValidTime
endValidTime
adjustTime
adjustToken
phasingMode
numPhasedAntennas
phasedAntennas
refAntennaIndex
candRefAntennaIndex
phasePacking
numReceptors
numChannels
numPhaseValues
phaseValues
numCompare
numEfficiencies
compareArray
efficiencyIndices
efficiencies
quality
phasedSumAntenna

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

CalAppPhaseRow* asdm::CalAppPhaseTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns: a pointer on a CalAppPhaseRow

CalAppPhaseRow* asdm::CalAppPhaseTable::newRow	(	BasebandNameMod::BasebandName	basebandName,
		int	scanNumber,
		Tag	calDataId,
		Tag	calReductionId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		ArrayTime	adjustTime,
		std::string	adjustToken,
		std::string	phasingMode,
		int	numPhasedAntennas,
		std::vector< std::string >	phasedAntennas,
		int	refAntennaIndex,
		int	candRefAntennaIndex,
		std::string	phasePacking,
		int	numReceptors,
		int	numChannels,
		int	numPhaseValues,
		std::vector< float >	phaseValues,
		int	numCompare,
		int	numEfficiencies,
		std::vector< std::string >	compareArray,
		std::vector< int >	efficiencyIndices,
		std::vector< std::vector< float > >	efficiencies,
		std::vector< float >	quality,
		std::string	phasedSumAntenna
	)

Create a new row initialized to the specified values.

Returns: a pointer on the created and initialized row.

Parameters

basebandName
scanNumber
calDataId
calReductionId
startValidTime
endValidTime
adjustTime
adjustToken
phasingMode
numPhasedAntennas
phasedAntennas
refAntennaIndex
candRefAntennaIndex
phasePacking
numReceptors
numChannels
numPhaseValues
phaseValues
numCompare
numEfficiencies
compareArray
efficiencyIndices
efficiencies
quality
phasedSumAntenna

CalAppPhaseRow* asdm::CalAppPhaseTable::newRow ( CalAppPhaseRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters

row	the row which is to be copied.

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

virtual

Set this table's Entity.

Parameters

e	An entity.

Implements asdm::Representable.

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

private

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

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

private

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

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

Conversion Methods.

Convert this table into a CalAppPhaseTableIDL CORBA structure.

Returns: a pointer to a CalAppPhaseTableIDL

void asdm::CalAppPhaseTable::toIDL ( asdmIDL::CalAppPhaseTableIDL & x ) const

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

Parameters

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

std::string asdm::CalAppPhaseTable::toMIME ( const asdm::ByteOrder * byteOrder = asdm::ByteOrder::Machine_Endianity )

private

Serialize this into a stream of bytes and encapsulates that stream into a MIME message.

Returns: a string containing the MIME message.

Parameters

byteOrder a const pointer to a static instance of the class ByteOrder.

std::string asdm::CalAppPhaseTable::toXML ( )

virtual

Produces an XML representation conform to the schema defined for CalAppPhase (CalAppPhaseTable.xsd).

Returns: a string containing the XML representation.

Exceptions

ConversionException

Implements asdm::Representable.

Friends And Related Function Documentation

friend class ASDM

friend

Definition at line 364 of file CalAppPhaseTable.h.

Member Data Documentation

bool asdm::CalAppPhaseTable::archiveAsBin

private

Definition at line 709 of file CalAppPhaseTable.h.

ASDM& asdm::CalAppPhaseTable::container

private

Definition at line 707 of file CalAppPhaseTable.h.

Entity asdm::CalAppPhaseTable::entity

private

Definition at line 714 of file CalAppPhaseTable.h.

bool asdm::CalAppPhaseTable::fileAsBin

private

Definition at line 710 of file CalAppPhaseTable.h.

bool asdm::CalAppPhaseTable::loadInProgress

private

Load the table in memory if necessary.

Definition at line 818 of file CalAppPhaseTable.h.

Referenced by checkPresenceInMemory().

std::vector<CalAppPhaseRow * > asdm::CalAppPhaseTable::privateRows

private

A data structure to store the pointers on the table's rows.

In all cases we maintain a private vector of CalAppPhaseRow s.

Definition at line 751 of file CalAppPhaseTable.h.

std::vector<CalAppPhaseRow *> asdm::CalAppPhaseTable::row

private

Definition at line 755 of file CalAppPhaseTable.h.

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

private

Definition at line 769 of file CalAppPhaseTable.h.

std::string asdm::CalAppPhaseTable::version

private

Definition at line 712 of file CalAppPhaseTable.h.

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

casa/code/alma/ASDM/CalAppPhaseTable.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation