/* * ALMA - Atacama Large Millimeter Array * (c) European Southern Observatory, 2002 * (c) Associated Universities Inc., 2002 * Copyright by ESO (in the framework of the ALMA collaboration), * Copyright by AUI (in the framework of the ALMA collaboration), * All rights reserved. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY, without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * Warning! * -------------------------------------------------------------------- * | This is generated code! Do not modify this file. | * | If you do, all changes will be lost when the file is re-generated. | * -------------------------------------------------------------------- * * File CalHolographyTable.h */ #ifndef CalHolographyTable_CLASS #define CalHolographyTable_CLASS #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifndef WITHOUT_ACS #include #endif #include #include namespace asdm { //class asdm::ASDM; //class asdm::CalHolographyRow; class ASDM; class CalHolographyRow; /** * The CalHolographyTable class is an Alma table. *
* * \par Role * Result of holography calibration performed by TelCal. *
* Generated from model's revision "-1", branch "" * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Attributes of CalHolography
Name Type Expected shape Comment
Key
antennaName std::string    the name of the antenna.
calDataId Tag    refers to a unique row in CalData Table.
calReductionId Tag    refers to a unique row in CalReduction Table.
Value
(Mandatory)
antennaMake AntennaMakeMod::AntennaMake    identifies the antenna make.
startValidTime ArrayTime    Start time of result validity period
endValidTime ArrayTime    the end time of result validity period.
ambientTemperature Temperature    the ambient temperature.
focusPosition std::vector 3  the focus position.
frequencyRange std::vector 2  the range of frequencies for which the measurement is valid.
illuminationTaper double    the amplitude illumination taper.
numReceptor (numReceptor) int    the number of receptors.
polarizationTypes std::vector numReceptor  identifies the polarization types (one value per receptor).
numPanelModes (numPanelModes) int    the number panel modes fitted.
receiverBand ReceiverBandMod::ReceiverBand    identifies the receiver band.
beamMapUID EntityRef    refers to the beam map image.
rawRMS Length    the RMS of the pathlength residuals.
weightedRMS Length    the weigthted RMS of the pathlength residuals.
surfaceMapUID EntityRef    refers to the resulting antenna surface map image.
direction std::vector 2  the direction of the source.
Value
(Optional)
numScrew(numScrew) int     the number of screws.
screwName std::vector numScrew   the names of the screws (one value per screw).
screwMotion std::vector numScrew   the prescribed screw motions (one value per screw).
screwMotionError std::vector numScrew   the uncertainties on the prescribed screw motions (one value per screw).
gravCorrection bool     indicates if a gravitational correction was applied (true) or not (false).
gravOptRange std::vector 2   the range of gravitational optimization.
tempCorrection bool     indicates if a temperature correction was applied (true) or not (false).
tempOptRange std::vector 2   the range of temperature optimization.
*/ class CalHolographyTable : public Representable { friend class ASDM; public: /** * Return the list of field names that make up key key * as an array of strings. * @return a vector of string. */ static const std::vector& getKeyName(); virtual ~CalHolographyTable(); /** * Return the container to which this table belongs. * * @return the ASDM containing this table. */ ASDM &getContainer() const; /** * Return the number of rows in the table. * * @return the number of rows in an unsigned int. */ unsigned int size() const; /** * Return the name of this table. * * This is a instance method of the class. * * @return the name of this table in a string. */ std::string getName() const; /** * Return the name of this table. * * This is a static method of the class. * * @return the name of this table in a string. */ static std::string name() ; /** * Return the version information about this table. * */ std::string getVersion() const ; /** * Return the names of the attributes of this table. * * @return a vector of string */ static const std::vector& getAttributesNames(); /** * Return the default sorted list of attributes names in the binary representation of the table. * * @return a const reference to a vector of string */ static const std::vector& defaultAttributesNamesInBin(); /** * Return this table's Entity. */ Entity getEntity() const; /** * Set this table's Entity. * @param e An entity. */ void setEntity(Entity e); /** * Produces an XML representation conform * to the schema defined for CalHolography (CalHolographyTable.xsd). * * @returns a string containing the XML representation. * @throws ConversionException */ std::string toXML() ; #ifndef WITHOUT_ACS // Conversion Methods /** * Convert this table into a CalHolographyTableIDL CORBA structure. * * @return a pointer to a CalHolographyTableIDL */ asdmIDL::CalHolographyTableIDL *toIDL() ; /** * Fills the CORBA data structure passed in parameter * with the content of this table. * * @param x a reference to the asdmIDL::CalHolographyTableIDL to be populated * with the content of this. */ void toIDL(asdmIDL::CalHolographyTableIDL& x) const; #endif #ifndef WITHOUT_ACS /** * Populate this table from the content of a CalHolographyTableIDL Corba structure. * * @throws DuplicateKey Thrown if the method tries to add a row having a key that is already in the table. * @throws ConversionException */ void fromIDL(asdmIDL::CalHolographyTableIDL x) ; #endif // // ====> Row creation. // /** * Create a new row with default values. * @return a pointer on a CalHolographyRow */ CalHolographyRow *newRow(); /** * Create a new row initialized to the specified values. * @return a pointer on the created and initialized row. * @param antennaName * @param calDataId * @param calReductionId * @param antennaMake * @param startValidTime * @param endValidTime * @param ambientTemperature * @param focusPosition * @param frequencyRange * @param illuminationTaper * @param numReceptor * @param polarizationTypes * @param numPanelModes * @param receiverBand * @param beamMapUID * @param rawRMS * @param weightedRMS * @param surfaceMapUID * @param direction */ CalHolographyRow *newRow(std::string antennaName, Tag calDataId, Tag calReductionId, AntennaMakeMod::AntennaMake antennaMake, ArrayTime startValidTime, ArrayTime endValidTime, Temperature ambientTemperature, std::vector focusPosition, std::vector frequencyRange, double illuminationTaper, int numReceptor, std::vector polarizationTypes, int numPanelModes, ReceiverBandMod::ReceiverBand receiverBand, EntityRef beamMapUID, Length rawRMS, Length weightedRMS, EntityRef surfaceMapUID, std::vector direction); /** * Create a new row using a copy constructor mechanism. * * The method creates a new CalHolographyRow 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 CalHolographyRow with default values for its attributes. * * @param row the row which is to be copied. */ CalHolographyRow *newRow(CalHolographyRow *row); // // ====> Append a row to its table. // /** * Add a row. * @param x a pointer to the CalHolographyRow to be added. * * @return a pointer to a CalHolographyRow. If the table contains a CalHolographyRow whose attributes (key and mandatory values) are equal to x ones * then returns a pointer on that CalHolographyRow, otherwise returns x. * * @throw DuplicateKey { thrown when the table contains a CalHolographyRow with a key equal to the x one but having * and a value section different from x one } * */ CalHolographyRow* add(CalHolographyRow* x) ; // // ====> Methods returning rows. // /** * Get a collection of pointers on the rows of the table. * @return Alls rows in a vector of pointers of CalHolographyRow. The elements of this vector are stored in the order * in which they have been added to the CalHolographyTable. */ std::vector get() ; /** * Get a const reference on the collection of rows pointers internally hold by the table. * @return A const reference of a vector of pointers of CalHolographyRow. The elements of this vector are stored in the order * in which they have been added to the CalHolographyTable. * */ const std::vector& get() const ; /** * Returns a CalHolographyRow* given a key. * @return a pointer to the row having the key whose values are passed as parameters, or 0 if * no row exists for that key. * @param antennaName * @param calDataId * @param calReductionId * */ CalHolographyRow* getRowByKey(std::string antennaName, Tag calDataId, Tag calReductionId); /** * Look up the table for a row whose all attributes * are equal to the corresponding parameters of the method. * @return a pointer on this row if any, null otherwise. * * @param antennaName * @param calDataId * @param calReductionId * @param antennaMake * @param startValidTime * @param endValidTime * @param ambientTemperature * @param focusPosition * @param frequencyRange * @param illuminationTaper * @param numReceptor * @param polarizationTypes * @param numPanelModes * @param receiverBand * @param beamMapUID * @param rawRMS * @param weightedRMS * @param surfaceMapUID * @param direction */ CalHolographyRow* lookup(std::string antennaName, Tag calDataId, Tag calReductionId, AntennaMakeMod::AntennaMake antennaMake, ArrayTime startValidTime, ArrayTime endValidTime, Temperature ambientTemperature, std::vector focusPosition, std::vector frequencyRange, double illuminationTaper, int numReceptor, std::vector polarizationTypes, int numPanelModes, ReceiverBandMod::ReceiverBand receiverBand, EntityRef beamMapUID, Length rawRMS, Length weightedRMS, EntityRef surfaceMapUID, std::vector direction); void setUnknownAttributeBinaryReader(const std::string& attributeName, BinaryAttributeReaderFunctor* barFctr); BinaryAttributeReaderFunctor* getUnknownAttributeBinaryReader(const std::string& attributeName) const; private: /** * Create a CalHolographyTable. *

* This constructor is private because only the * container can create tables. All tables must know the container * to which they belong. * @param container The container to which this table belongs. */ CalHolographyTable (ASDM & container); ASDM & container; bool archiveAsBin; // If true archive binary else archive XML bool fileAsBin ; // If true file binary else file XML std::string version ; Entity entity; /** * 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. * @throws DuplicateKey */ CalHolographyRow* checkAndAdd(CalHolographyRow* x, bool skipCheckUniqueness=false) ; /** * Brutally append an CalHolographyRow x to the collection of rows already stored in this table. No uniqueness check is done ! * * @param CalHolographyRow* x a pointer onto the CalHolographyRow to be appended. */ void append(CalHolographyRow* x) ; /** * Brutally append an CalHolographyRow x to the collection of rows already stored in this table. No uniqueness check is done ! * * @param CalHolographyRow* x a pointer onto the CalHolographyRow to be appended. */ void addWithoutCheckingUnique(CalHolographyRow* x) ; // A data structure to store the pointers on the table's rows. // In all cases we maintain a private vector of CalHolographyRow s. std::vector privateRows; std::vector row; void error() ; //throw(ConversionException); /** * Populate this table from the content of a XML document that is required to * be conform to the XML schema defined for a CalHolography (CalHolographyTable.xsd). * @throws ConversionException * */ void fromXML(std::string& xmlDoc) ; std::map unknownAttributes2Functors; /** * Private methods involved during the build of this table out of the content * of file(s) containing an external representation of a CalHolography table. */ void setFromMIMEFile(const std::string& directory); /* void openMIMEFile(const std::string& directory); */ void setFromXMLFile(const std::string& directory); /** * Serialize this into a stream of bytes and encapsulates that stream into a MIME message. * @returns a string containing the MIME message. * * @param byteOrder a const pointer to a static instance of the class ByteOrder. * */ std::string toMIME(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity); /** * Extracts the binary part of a MIME message and deserialize its content * to fill this with the result of the deserialization. * @param mimeMsg the string containing the MIME message. * @throws ConversionException */ void setFromMIME(const std::string & mimeMsg); /** * Private methods involved during the export of this table into disk file(s). */ std::string MIMEXMLPart(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity); /** * 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 "CalHolography.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalHolography.xml". * The file is always written in a directory whose name is passed as a parameter. * @param directory The name of directory where the file containing the table's representation will be saved. * */ void toFile(std::string directory); /** * Load the table in memory if necessary. */ bool loadInProgress; void checkPresenceInMemory() { if (!presentInMemory && !loadInProgress) { loadInProgress = true; setFromFile(getContainer().getDirectory()); presentInMemory = true; loadInProgress = false; } } /** * Reads and parses a file containing a representation of a CalHolographyTable as those produced by the toFile method. * This table is populated with the result of the parsing. * @param directory The name of the directory containing the file te be read and parsed. * @throws ConversionException If any error occurs while reading the * files in the directory or parsing them. * */ void setFromFile(const std::string& directory); }; } // End namespace asdm #endif /* CalHolographyTable_CLASS */