asdm::CalFocusTable Class Reference

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

#include <CalFocusTable.h>

Inheritance diagram for asdm::CalFocusTable:
asdm::Representable

List of all members.

Public Member Functions

virtual ~CalFocusTable ()
ASDMgetContainer () 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 CalFocus (CalFocusTable.xsd).
asdmIDL::CalFocusTableIDL * toIDL ()
 Conversion Methods.
void toIDL (asdmIDL::CalFocusTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table.
void fromIDL (asdmIDL::CalFocusTableIDL x)
 Populate this table from the content of a CalFocusTableIDL Corba structure.
CalFocusRownewRow ()
 ====> Row creation.
CalFocusRownewRow (string antennaName, ReceiverBandMod::ReceiverBand receiverBand, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, Temperature ambientTemperature, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, FocusMethodMod::FocusMethod focusMethod, vector< Frequency > frequencyRange, vector< Angle > pointingDirection, int numReceptor, vector< PolarizationTypeMod::PolarizationType > polarizationTypes, vector< bool > wereFixed, vector< vector< Length > > offset, vector< vector< Length > > offsetError, vector< vector< bool > > offsetWasTied, vector< vector< double > > reducedChiSquared, vector< vector< Length > > position)
 Create a new row initialized to the specified values.
CalFocusRownewRow (CalFocusRow *row)
 Create a new row using a copy constructor mechanism.
CalFocusRowadd (CalFocusRow *x)
 ====> Append a row to its table.
std::vector< CalFocusRow * > get ()
 ====> Methods returning rows.
const std::vector< CalFocusRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
CalFocusRowgetRowByKey (string antennaName, ReceiverBandMod::ReceiverBand receiverBand, Tag calDataId, Tag calReductionId)
 Returns a CalFocusRow* given a key.
CalFocusRowlookup (string antennaName, ReceiverBandMod::ReceiverBand receiverBand, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, Temperature ambientTemperature, AtmPhaseCorrectionMod::AtmPhaseCorrection atmPhaseCorrection, FocusMethodMod::FocusMethod focusMethod, vector< Frequency > frequencyRange, vector< Angle > pointingDirection, int numReceptor, vector< PolarizationTypeMod::PolarizationType > polarizationTypes, vector< bool > wereFixed, vector< vector< Length > > offset, vector< vector< Length > > offsetError, vector< vector< bool > > offsetWasTied, vector< vector< double > > reducedChiSquared, vector< vector< Length > > position)
 Look up the table for a row whose all attributes are equal to the corresponding parameters of the method.
void setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
BinaryAttributeReaderFunctorgetUnknownAttributeBinaryReader (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

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

Private Attributes

ASDMcontainer
bool archiveAsBin
bool fileAsBin
std::string version
Entity entity
std::vector< CalFocusRow * > privateRows
 A data structure to store the pointers on the table's rows.
std::vector< CalFocusRow * > row
std::map< std::string,
BinaryAttributeReaderFunctor * > 
unknownAttributes2Functors
bool loadInProgress
 Load the table in memory if necessary.

Friends

class ASDM

Detailed Description

The CalFocusTable class is an Alma table.


Role
Result of focus calibration performed on-line by TelCal.

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

Attributes of CalFocus

Name

Type

Expected shape

Comment

Key

antennaName

string

 

 the name of the antenna.

receiverBand

ReceiverBandMod::ReceiverBand

 

 identifies the receiver band.

calDataId

Tag

 

 refers to a unique row in CalData Table.

calReductionId

Tag

 

 refers to a unique row in CalReduction Table.

Value
(Mandatory)

startValidTime

ArrayTime

 

 the start time of the result validity period.

endValidTime

ArrayTime

 

 the end time of the result validity period.

ambientTemperature

Temperature

 

 the ambient temperature.

atmPhaseCorrection

AtmPhaseCorrectionMod::AtmPhaseCorrection

 

 qualifies how the atmospheric phase correction has been applied.

focusMethod

FocusMethodMod::FocusMethod

 

 identifies the method used during the calibration.

frequencyRange

vector<Frequency >

2

 the frequency range over which the result is valid.

pointingDirection

vector<Angle >

2

 the antenna pointing direction (horizontal coordinates).

numReceptor ($N_{Rece}$)

int

 

 the number of receptors.

polarizationTypes

vector<PolarizationTypeMod::PolarizationType >

numReceptor

 identifies the polarization types (one value per receptor).

wereFixed

vector<bool >

3

 coordinates were fixed (true) or not fixed (false) (one value per individual coordinate).

offset

vector<vector<Length > >

numReceptor, 3

 the measured focus offsets in X,Y,Z (one triple of values per receptor).

offsetError

vector<vector<Length > >

numReceptor, 3

 the statistical uncertainties on measured focus offsets (one triple per receptor).

offsetWasTied

vector<vector<bool > >

numReceptor, 3

 focus was tied (true) or not tied (false) (one value per receptor and focus individual coordinate).

reducedChiSquared

vector<vector<double > >

numReceptor, 3

 a measure of the quality of the fit (one triple per receptor).

position

vector<vector<Length > >

numReceptor, 3

 the absolute focus position in X,Y,Z (one triple of values per receptor).

Value
(Optional)

polarizationsAveraged

bool

 

  Polarizations were averaged.

focusCurveWidth

vector<vector<Length > >

numReceptor, 3

  half power width of fitted focus curve (one triple per receptor).

focusCurveWidthError

vector<vector<Length > >

numReceptor, 3

  Uncertainty of the focus curve width.

focusCurveWasFixed

vector<bool >

3

  each coordinate of the focus curve width was set (true) or not set (false) to an assumed value.

offIntensity

vector<Temperature >

numReceptor

  the off intensity levels (one value per receptor).

offIntensityError

vector<Temperature >

numReceptor

  the uncertainties on the off intensity levels (one value per receptor).

offIntensityWasFixed

bool

 

  the off intensity level was fixed (true) or not fixed (false).

peakIntensity

vector<Temperature >

numReceptor

  the maximum intensities (one value per receptor).

peakIntensityError

vector<Temperature >

numReceptor

  the uncertainties on the maximum intensities (one value per receptor).

peakIntensityWasFixed

bool

 

  the maximum intensity was fixed (true) or not fixed (false).

astigmPlus

vector<Length >

numReceptor

  the astigmatism component with 0 degree symmetry axis.

astigmPlusError

vector<Length >

numReceptor

  the statistical error on astigmPlus

astigmMult

vector<Length >

numReceptor

  the astigmatism component with 45 degrees symmetry axis.

astigmMultError

vector<Length >

numReceptor

  the statistical error on astigmMult

illumOffset

vector<vector<Length > >

numReceptor, 2

  the illumination offset of the primary reflector expressed as a pair of values.

illumOffsetError

vector<vector<Length > >

numReceptor, 2

  the statistical error on illumOffset.

fitRMS

vector<Length >

numReceptor

  The RMS of the half path length after removing the best fit parabola.

Definition at line 457 of file CalFocusTable.h.


Constructor & Destructor Documentation

virtual asdm::CalFocusTable::~CalFocusTable (  )  [virtual]
asdm::CalFocusTable::CalFocusTable ( ASDM container  )  [private]

Create a CalFocusTable.

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

CalFocusRow* asdm::CalFocusTable::add ( CalFocusRow x  ) 

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

Add a row.

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

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

No uniqueness check is done !

Parameters:
CalFocusRow* x a pointer onto the CalFocusRow to be appended.
void asdm::CalFocusTable::append ( CalFocusRow x  )  [private]

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

No uniqueness check is done !

Parameters:
CalFocusRow* x a pointer onto the CalFocusRow to be appended.
CalFocusRow* asdm::CalFocusTable::checkAndAdd ( CalFocusRow 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::CalFocusTable::checkPresenceInMemory (  )  [inline, private]
static const std::vector<std::string>& asdm::CalFocusTable::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::CalFocusTable::error (  )  [private]
void asdm::CalFocusTable::fromIDL ( asdmIDL::CalFocusTableIDL  x  ) 

Populate this table from the content of a CalFocusTableIDL 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::CalFocusTable::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 CalFocus (CalFocusTable.xsd).

Exceptions:
ConversionException 
const std::vector<CalFocusRow *>& asdm::CalFocusTable::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 CalFocusRow. The elements of this vector are stored in the order in which they have been added to the CalFocusTable.
std::vector<CalFocusRow *> asdm::CalFocusTable::get (  ) 

====> Methods returning rows.

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

Returns:
Alls rows in a vector of pointers of CalFocusRow. The elements of this vector are stored in the order in which they have been added to the CalFocusTable.
static const std::vector<std::string>& asdm::CalFocusTable::getAttributesNames (  )  [static]

Return the names of the attributes of this table.

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

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

CalFocusRow* asdm::CalFocusTable::getRowByKey ( string  antennaName,
ReceiverBandMod::ReceiverBand  receiverBand,
Tag  calDataId,
Tag  calReductionId 
)

Returns a CalFocusRow* 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 
receiverBand 
calDataId 
calReductionId 
BinaryAttributeReaderFunctor* asdm::CalFocusTable::getUnknownAttributeBinaryReader ( const std::string &  attributeName  )  const
std::string asdm::CalFocusTable::getVersion (  )  const

Return the version information about this table.

CalFocusRow* asdm::CalFocusTable::lookup ( string  antennaName,
ReceiverBandMod::ReceiverBand  receiverBand,
Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
Temperature  ambientTemperature,
AtmPhaseCorrectionMod::AtmPhaseCorrection  atmPhaseCorrection,
FocusMethodMod::FocusMethod  focusMethod,
vector< Frequency frequencyRange,
vector< Angle pointingDirection,
int  numReceptor,
vector< PolarizationTypeMod::PolarizationType >  polarizationTypes,
vector< bool >  wereFixed,
vector< vector< Length > >  offset,
vector< vector< Length > >  offsetError,
vector< vector< bool > >  offsetWasTied,
vector< vector< double > >  reducedChiSquared,
vector< vector< Length > >  position 
)

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 
receiverBand 
calDataId 
calReductionId 
startValidTime 
endValidTime 
ambientTemperature 
atmPhaseCorrection 
focusMethod 
frequencyRange 
pointingDirection 
numReceptor 
polarizationTypes 
wereFixed 
offset 
offsetError 
offsetWasTied 
reducedChiSquared 
position 
std::string asdm::CalFocusTable::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::CalFocusTable::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.
CalFocusRow* asdm::CalFocusTable::newRow ( CalFocusRow row  ) 

Create a new row using a copy constructor mechanism.

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

Parameters:
row the row which is to be copied.
CalFocusRow* asdm::CalFocusTable::newRow ( string  antennaName,
ReceiverBandMod::ReceiverBand  receiverBand,
Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
Temperature  ambientTemperature,
AtmPhaseCorrectionMod::AtmPhaseCorrection  atmPhaseCorrection,
FocusMethodMod::FocusMethod  focusMethod,
vector< Frequency frequencyRange,
vector< Angle pointingDirection,
int  numReceptor,
vector< PolarizationTypeMod::PolarizationType >  polarizationTypes,
vector< bool >  wereFixed,
vector< vector< Length > >  offset,
vector< vector< Length > >  offsetError,
vector< vector< bool > >  offsetWasTied,
vector< vector< double > >  reducedChiSquared,
vector< vector< Length > >  position 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
antennaName 
receiverBand 
calDataId 
calReductionId 
startValidTime 
endValidTime 
ambientTemperature 
atmPhaseCorrection 
focusMethod 
frequencyRange 
pointingDirection 
numReceptor 
polarizationTypes 
wereFixed 
offset 
offsetError 
offsetWasTied 
reducedChiSquared 
position 
CalFocusRow* asdm::CalFocusTable::newRow (  ) 

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a CalFocusRow
void asdm::CalFocusTable::setEntity ( Entity  e  )  [virtual]

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

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

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

void asdm::CalFocusTable::setFromXMLFile ( const std::string &  directory  )  [private]
void asdm::CalFocusTable::setUnknownAttributeBinaryReader ( const std::string &  attributeName,
BinaryAttributeReaderFunctor barFctr 
)
unsigned int asdm::CalFocusTable::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::CalFocusTable::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 "CalFocus.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalFocus.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::CalFocusTable::toIDL ( asdmIDL::CalFocusTableIDL &  x  )  const

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

Parameters:
x a reference to the asdmIDL::CalFocusTableIDL to be populated with the content of this.
asdmIDL::CalFocusTableIDL* asdm::CalFocusTable::toIDL (  ) 

Conversion Methods.

Convert this table into a CalFocusTableIDL CORBA structure.

Returns:
a pointer to a CalFocusTableIDL
std::string asdm::CalFocusTable::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::CalFocusTable::toXML (  )  [virtual]

Produces an XML representation conform to the schema defined for CalFocus (CalFocusTable.xsd).

Returns:
a string containing the XML representation.
Exceptions:
ConversionException 

Implements asdm::Representable.


Friends And Related Function Documentation

friend class ASDM [friend]

Reimplemented from asdm::Representable.

Definition at line 458 of file CalFocusTable.h.


Member Data Documentation

Definition at line 779 of file CalFocusTable.h.

Definition at line 777 of file CalFocusTable.h.

Definition at line 784 of file CalFocusTable.h.

Definition at line 780 of file CalFocusTable.h.

Load the table in memory if necessary.

Reimplemented from asdm::Representable.

Definition at line 888 of file CalFocusTable.h.

Referenced by checkPresenceInMemory().

std::vector<CalFocusRow * > asdm::CalFocusTable::privateRows [private]

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

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

Definition at line 821 of file CalFocusTable.h.

std::vector<CalFocusRow *> asdm::CalFocusTable::row [private]

Definition at line 825 of file CalFocusTable.h.

Definition at line 839 of file CalFocusTable.h.

std::string asdm::CalFocusTable::version [private]

Definition at line 782 of file CalFocusTable.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1