/* * 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 CalFocusModelTable.h */ #ifndef CalFocusModelTable_CLASS #define CalFocusModelTable_CLASS #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::CalFocusModelRow; class ASDM; class CalFocusModelRow; /** * The CalFocusModelTable class is an Alma table. *
* * \par Role * Result of focus model calibration performed by TelCal. *
* Generated from model's revision "-1", branch "" * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Attributes of CalFocusModel
Name Type Expected shape Comment
Key
antennaName std::string    the name of the antenna.
receiverBand ReceiverBandMod::ReceiverBand    identifies the receiver band.
polarizationType PolarizationTypeMod::PolarizationType    identifies the polarization type for which this focus model is valid.
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 result validity period.
endValidTime ArrayTime    the end time of result validity period.
antennaMake AntennaMakeMod::AntennaMake    identifies the antenna make.
numCoeff (numCoeff) int    the number of coefficients.
numSourceObs (numSourceObs) int    the number of source directions observed to derive the model.
coeffName std::vector numCoeff  the names given to the coefficients in the model.
coeffFormula std::vector numCoeff  the coefficients formula (one string per coefficient).
coeffValue std::vector numCoeff  the fitted values of the coefficients.
coeffError std::vector numCoeff  the statistical uncertainties on the derived coefficients (one value per coefficient).
coeffFixed std::vector numCoeff  one coefficient was fixed (true) or not fixed (false) (one boolean value per coefficient).
focusModel std::string    the name of this focus model.
focusRMS std::vector 3  the RMS deviations of residuals of focus coordinates.
reducedChiSquared double    a measure of the quality of the least-square fit.
*/ class CalFocusModelTable : 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 ~CalFocusModelTable(); /** * 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 CalFocusModel (CalFocusModelTable.xsd). * * @returns a string containing the XML representation. * @throws ConversionException */ std::string toXML() ; #ifndef WITHOUT_ACS // Conversion Methods /** * Convert this table into a CalFocusModelTableIDL CORBA structure. * * @return a pointer to a CalFocusModelTableIDL */ asdmIDL::CalFocusModelTableIDL *toIDL() ; /** * Fills the CORBA data structure passed in parameter * with the content of this table. * * @param x a reference to the asdmIDL::CalFocusModelTableIDL to be populated * with the content of this. */ void toIDL(asdmIDL::CalFocusModelTableIDL& x) const; #endif #ifndef WITHOUT_ACS /** * Populate this table from the content of a CalFocusModelTableIDL 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::CalFocusModelTableIDL x) ; #endif // // ====> Row creation. // /** * Create a new row with default values. * @return a pointer on a CalFocusModelRow */ CalFocusModelRow *newRow(); /** * Create a new row initialized to the specified values. * @return a pointer on the created and initialized row. * @param antennaName * @param receiverBand * @param polarizationType * @param calDataId * @param calReductionId * @param startValidTime * @param endValidTime * @param antennaMake * @param numCoeff * @param numSourceObs * @param coeffName * @param coeffFormula * @param coeffValue * @param coeffError * @param coeffFixed * @param focusModel * @param focusRMS * @param reducedChiSquared */ CalFocusModelRow *newRow(std::string antennaName, ReceiverBandMod::ReceiverBand receiverBand, PolarizationTypeMod::PolarizationType polarizationType, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, AntennaMakeMod::AntennaMake antennaMake, int numCoeff, int numSourceObs, std::vector coeffName, std::vector coeffFormula, std::vector coeffValue, std::vector coeffError, std::vector coeffFixed, std::string focusModel, std::vector focusRMS, double reducedChiSquared); /** * Create a new row using a copy constructor mechanism. * * The method creates a new CalFocusModelRow 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 CalFocusModelRow with default values for its attributes. * * @param row the row which is to be copied. */ CalFocusModelRow *newRow(CalFocusModelRow *row); // // ====> Append a row to its table. // /** * Add a row. * @param x a pointer to the CalFocusModelRow to be added. * * @return a pointer to a CalFocusModelRow. If the table contains a CalFocusModelRow whose attributes (key and mandatory values) are equal to x ones * then returns a pointer on that CalFocusModelRow, otherwise returns x. * * @throw DuplicateKey { thrown when the table contains a CalFocusModelRow with a key equal to the x one but having * and a value section different from x one } * */ CalFocusModelRow* add(CalFocusModelRow* x) ; // // ====> Methods returning rows. // /** * Get a collection of pointers on the rows of the table. * @return Alls rows in a vector of pointers of CalFocusModelRow. The elements of this vector are stored in the order * in which they have been added to the CalFocusModelTable. */ 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 CalFocusModelRow. The elements of this vector are stored in the order * in which they have been added to the CalFocusModelTable. * */ const std::vector& get() const ; /** * Returns a CalFocusModelRow* 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 receiverBand * @param polarizationType * @param calDataId * @param calReductionId * */ CalFocusModelRow* getRowByKey(std::string antennaName, ReceiverBandMod::ReceiverBand receiverBand, PolarizationTypeMod::PolarizationType polarizationType, 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 receiverBand * @param polarizationType * @param calDataId * @param calReductionId * @param startValidTime * @param endValidTime * @param antennaMake * @param numCoeff * @param numSourceObs * @param coeffName * @param coeffFormula * @param coeffValue * @param coeffError * @param coeffFixed * @param focusModel * @param focusRMS * @param reducedChiSquared */ CalFocusModelRow* lookup(std::string antennaName, ReceiverBandMod::ReceiverBand receiverBand, PolarizationTypeMod::PolarizationType polarizationType, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, AntennaMakeMod::AntennaMake antennaMake, int numCoeff, int numSourceObs, std::vector coeffName, std::vector coeffFormula, std::vector coeffValue, std::vector coeffError, std::vector coeffFixed, std::string focusModel, std::vector focusRMS, double reducedChiSquared); void setUnknownAttributeBinaryReader(const std::string& attributeName, BinaryAttributeReaderFunctor* barFctr); BinaryAttributeReaderFunctor* getUnknownAttributeBinaryReader(const std::string& attributeName) const; private: /** * Create a CalFocusModelTable. *

* 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. */ CalFocusModelTable (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 */ CalFocusModelRow* checkAndAdd(CalFocusModelRow* x, bool skipCheckUniqueness=false) ; /** * Brutally append an CalFocusModelRow x to the collection of rows already stored in this table. No uniqueness check is done ! * * @param CalFocusModelRow* x a pointer onto the CalFocusModelRow to be appended. */ void append(CalFocusModelRow* x) ; /** * Brutally append an CalFocusModelRow x to the collection of rows already stored in this table. No uniqueness check is done ! * * @param CalFocusModelRow* x a pointer onto the CalFocusModelRow to be appended. */ void addWithoutCheckingUnique(CalFocusModelRow* x) ; // A data structure to store the pointers on the table's rows. // In all cases we maintain a private vector of CalFocusModelRow 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 CalFocusModel (CalFocusModelTable.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 CalFocusModel 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 "CalFocusModel.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalFocusModel.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 CalFocusModelTable 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 /* CalFocusModelTable_CLASS */