casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
asdm::CalAmpliTable Class Reference

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

#include <CalAmpliTable.h>

Inheritance diagram for asdm::CalAmpliTable:
asdm::Representable

Public Member Functions

virtual ~CalAmpliTable ()
 
ASDMgetContainer () 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 CalAmpli (CalAmpliTable.xsd). More...
 
asdmIDL::CalAmpliTableIDL * toIDL ()
 Conversion Methods. More...
 
void toIDL (asdmIDL::CalAmpliTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table. More...
 
void fromIDL (asdmIDL::CalAmpliTableIDL x)
 Populate this table from the content of a CalAmpliTableIDL Corba structure. More...
 
CalAmpliRownewRow ()
 ====> Row creation. More...
 
CalAmpliRownewRow (std::string antennaName, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, ReceiverBandMod::ReceiverBand receiverBand, BasebandNameMod::BasebandName basebandName, Tag calDataId, Tag calReductionId, int numReceptor, std::vector< PolarizationTypeMod::PolarizationType > polarizationTypes, ArrayTime startValidTime, ArrayTime endValidTime, std::vector< Frequency > frequencyRange, std::vector< float > apertureEfficiency, std::vector< float > apertureEfficiencyError)
 Create a new row initialized to the specified values. More...
 
CalAmpliRownewRow (CalAmpliRow *row)
 Create a new row using a copy constructor mechanism. More...
 
CalAmpliRowadd (CalAmpliRow *x)
 ====> Append a row to its table. More...
 
std::vector< CalAmpliRow * > get ()
 ====> Methods returning rows. More...
 
const std::vector< CalAmpliRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table. More...
 
CalAmpliRowgetRowByKey (std::string antennaName, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, ReceiverBandMod::ReceiverBand receiverBand, BasebandNameMod::BasebandName basebandName, Tag calDataId, Tag calReductionId)
 Returns a CalAmpliRow* given a key. More...
 
CalAmpliRowlookup (std::string antennaName, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, ReceiverBandMod::ReceiverBand receiverBand, BasebandNameMod::BasebandName basebandName, Tag calDataId, Tag calReductionId, int numReceptor, std::vector< PolarizationTypeMod::PolarizationType > polarizationTypes, ArrayTime startValidTime, ArrayTime endValidTime, std::vector< Frequency > frequencyRange, std::vector< float > apertureEfficiency, std::vector< float > apertureEfficiencyError)
 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)
 
BinaryAttributeReaderFunctorgetUnknownAttributeBinaryReader (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

 CalAmpliTable (ASDM &container)
 Create a CalAmpliTable. More...
 
CalAmpliRowcheckAndAdd (CalAmpliRow *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 (CalAmpliRow *x)
 Brutally append an CalAmpliRow x to the collection of rows already stored in this table. More...
 
void addWithoutCheckingUnique (CalAmpliRow *x)
 Brutally append an CalAmpliRow 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 CalAmpli (CalAmpliTable.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 CalAmpli 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 CalAmpliTable as those produced by the toFile method. More...
 

Private Attributes

ASDMcontainer
 
bool archiveAsBin
 
bool fileAsBin
 
std::string version
 
Entity entity
 
std::vector< CalAmpliRow * > privateRows
 A data structure to store the pointers on the table's rows. More...
 
std::vector< CalAmpliRow * > 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 CalAmpliTable class is an Alma table.


Role
Amplitude Calibration Result from Telescope Calibration. This calibration checks that observing amplitude calibrators provide reasonable results: From the antenna-based fringe amplitudes rough aperture efficiencies are determined.

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

Attributes of CalAmpli
Name Type Expected shape

Comment

Key

antennaName

std::string  

 the antenna's name.

atmPhaseCorrection

AtmPhaseCorrectionMod::AtmPhaseCorrection  

 qualifies how the atmospheric phase correction has been applied.

receiverBand

ReceiverBandMod::ReceiverBand  

 the name of the receiver band.

basebandName

BasebandNameMod::BasebandName  

 The name of the 'baseband pair' which is measured. For ALMA a baseband pair is the signal path identified by a second local oscillator and has two polarizations. BB ALL may be used if all basebands are fitted together.

calDataId

Tag  

 refers to a unique row in CalData Table.

calReductionId

Tag  

 refers to a unique row in CalReduction Table.

Value
(Mandatory)

numReceptor (numReceptor) int  

 the number of receptors.

polarizationTypes std::vector<PolarizationTypeMod::PolarizationType > numReceptor

 the polarizations of the receptors (an array containing one value per receptor).

startValidTime ArrayTime  

 the start time of result validity period.

endValidTime ArrayTime  

 the end time of result validity period.

frequencyRange std::vector<Frequency > 2

 the frequency range over which the result is valid.

apertureEfficiency std::vector<float > numReceptor

 the aperture efficiency without correction.

apertureEfficiencyError std::vector<float > numReceptor

 the aperture efficiency error.

Value
(Optional)

correctionValidity bool  

  the correction validity.

Definition at line 251 of file CalAmpliTable.h.

Constructor & Destructor Documentation

virtual asdm::CalAmpliTable::~CalAmpliTable ( )
virtual
asdm::CalAmpliTable::CalAmpliTable ( ASDM container)
private

Create a CalAmpliTable.

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

Parameters
containerThe container to which this table belongs.

Member Function Documentation

CalAmpliRow* asdm::CalAmpliTable::add ( CalAmpliRow x)

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

Add a row.

Parameters
xa pointer to the CalAmpliRow to be added.
Returns
a pointer to a CalAmpliRow. If the table contains a CalAmpliRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that CalAmpliRow, otherwise returns x.
Exceptions
DuplicateKey{ thrown when the table contains a CalAmpliRow with a key equal to the x one but having and a value section different from x one }
void asdm::CalAmpliTable::addWithoutCheckingUnique ( CalAmpliRow x)
private

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

No uniqueness check is done !

Parameters
CalAmpliRow*x a pointer onto the CalAmpliRow to be appended.
void asdm::CalAmpliTable::append ( CalAmpliRow x)
private

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

No uniqueness check is done !

Parameters
CalAmpliRow*x a pointer onto the CalAmpliRow to be appended.
CalAmpliRow* asdm::CalAmpliTable::checkAndAdd ( CalAmpliRow 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::CalAmpliTable::checkPresenceInMemory ( )
inlineprivate
static const std::vector<std::string>& asdm::CalAmpliTable::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::CalAmpliTable::error ( )
private
void asdm::CalAmpliTable::fromIDL ( asdmIDL::CalAmpliTableIDL  x)

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

Exceptions
DuplicateKeyThrown if the method tries to add a row having a key that is already in the table.
ConversionException
void asdm::CalAmpliTable::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 CalAmpli (CalAmpliTable.xsd).

Exceptions
ConversionException

Implements asdm::Representable.

std::vector<CalAmpliRow *> asdm::CalAmpliTable::get ( )

====> Methods returning rows.

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

Returns
Alls rows in a vector of pointers of CalAmpliRow. The elements of this vector are stored in the order in which they have been added to the CalAmpliTable.
const std::vector<CalAmpliRow *>& asdm::CalAmpliTable::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 CalAmpliRow. The elements of this vector are stored in the order in which they have been added to the CalAmpliTable.
static const std::vector<std::string>& asdm::CalAmpliTable::getAttributesNames ( )
static

Return the names of the attributes of this table.

Returns
a vector of string
ASDM& asdm::CalAmpliTable::getContainer ( ) const

Return the container to which this table belongs.

Returns
the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::CalAmpliTable::getEntity ( ) const
virtual

Return this table's Entity.

Implements asdm::Representable.

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

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

Returns a CalAmpliRow* 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
BinaryAttributeReaderFunctor* asdm::CalAmpliTable::getUnknownAttributeBinaryReader ( const std::string &  attributeName) const
std::string asdm::CalAmpliTable::getVersion ( ) const

Return the version information about this table.

CalAmpliRow* asdm::CalAmpliTable::lookup ( std::string  antennaName,
AtmPhaseCorrectionMod::AtmPhaseCorrection  atmPhaseCorrection,
ReceiverBandMod::ReceiverBand  receiverBand,
BasebandNameMod::BasebandName  basebandName,
Tag  calDataId,
Tag  calReductionId,
int  numReceptor,
std::vector< PolarizationTypeMod::PolarizationType >  polarizationTypes,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
std::vector< Frequency frequencyRange,
std::vector< float >  apertureEfficiency,
std::vector< float >  apertureEfficiencyError 
)

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
numReceptor
polarizationTypes
startValidTime
endValidTime
frequencyRange
apertureEfficiency
apertureEfficiencyError
std::string asdm::CalAmpliTable::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::CalAmpliTable::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.
CalAmpliRow* asdm::CalAmpliTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns
a pointer on a CalAmpliRow
CalAmpliRow* asdm::CalAmpliTable::newRow ( std::string  antennaName,
AtmPhaseCorrectionMod::AtmPhaseCorrection  atmPhaseCorrection,
ReceiverBandMod::ReceiverBand  receiverBand,
BasebandNameMod::BasebandName  basebandName,
Tag  calDataId,
Tag  calReductionId,
int  numReceptor,
std::vector< PolarizationTypeMod::PolarizationType >  polarizationTypes,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
std::vector< Frequency frequencyRange,
std::vector< float >  apertureEfficiency,
std::vector< float >  apertureEfficiencyError 
)

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
numReceptor
polarizationTypes
startValidTime
endValidTime
frequencyRange
apertureEfficiency
apertureEfficiencyError
CalAmpliRow* asdm::CalAmpliTable::newRow ( CalAmpliRow row)

Create a new row using a copy constructor mechanism.

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

Parameters
rowthe row which is to be copied.
void asdm::CalAmpliTable::setEntity ( Entity  e)
virtual

Set this table's Entity.

Parameters
eAn entity.

Implements asdm::Representable.

void asdm::CalAmpliTable::setFromFile ( const std::string &  directory)
private

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

This table is populated with the result of the parsing.

Parameters
directoryThe name of the directory containing the file te be read and parsed.
Exceptions
ConversionExceptionIf any error occurs while reading the files in the directory or parsing them.

Referenced by checkPresenceInMemory().

void asdm::CalAmpliTable::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
mimeMsgthe string containing the MIME message.
Exceptions
ConversionException
void asdm::CalAmpliTable::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 CalAmpli table.

void asdm::CalAmpliTable::setFromXMLFile ( const std::string &  directory)
private
void asdm::CalAmpliTable::setUnknownAttributeBinaryReader ( const std::string &  attributeName,
BinaryAttributeReaderFunctor barFctr 
)
unsigned int asdm::CalAmpliTable::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::CalAmpliTable::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 "CalAmpli.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalAmpli.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters
directoryThe name of directory where the file containing the table's representation will be saved.
asdmIDL::CalAmpliTableIDL* asdm::CalAmpliTable::toIDL ( )

Conversion Methods.

Convert this table into a CalAmpliTableIDL CORBA structure.

Returns
a pointer to a CalAmpliTableIDL
void asdm::CalAmpliTable::toIDL ( asdmIDL::CalAmpliTableIDL &  x) const

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

Parameters
xa reference to the asdmIDL::CalAmpliTableIDL to be populated with the content of this.
std::string asdm::CalAmpliTable::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
byteOrdera const pointer to a static instance of the class ByteOrder.
std::string asdm::CalAmpliTable::toXML ( )
virtual

Produces an XML representation conform to the schema defined for CalAmpli (CalAmpliTable.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 252 of file CalAmpliTable.h.

Member Data Documentation

bool asdm::CalAmpliTable::archiveAsBin
private

Definition at line 553 of file CalAmpliTable.h.

ASDM& asdm::CalAmpliTable::container
private

Definition at line 551 of file CalAmpliTable.h.

Entity asdm::CalAmpliTable::entity
private

Definition at line 558 of file CalAmpliTable.h.

bool asdm::CalAmpliTable::fileAsBin
private

Definition at line 554 of file CalAmpliTable.h.

bool asdm::CalAmpliTable::loadInProgress
private

Load the table in memory if necessary.

Definition at line 662 of file CalAmpliTable.h.

Referenced by checkPresenceInMemory().

std::vector<CalAmpliRow * > asdm::CalAmpliTable::privateRows
private

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

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

Definition at line 595 of file CalAmpliTable.h.

std::vector<CalAmpliRow *> asdm::CalAmpliTable::row
private

Definition at line 599 of file CalAmpliTable.h.

std::map<std::string, BinaryAttributeReaderFunctor *> asdm::CalAmpliTable::unknownAttributes2Functors
private

Definition at line 613 of file CalAmpliTable.h.

std::string asdm::CalAmpliTable::version
private

Definition at line 556 of file CalAmpliTable.h.


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