casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
CalGainTable.h
Go to the documentation of this file.
00001 
00002 /*
00003  * ALMA - Atacama Large Millimeter Array
00004  * (c) European Southern Observatory, 2002
00005  * (c) Associated Universities Inc., 2002
00006  * Copyright by ESO (in the framework of the ALMA collaboration),
00007  * Copyright by AUI (in the framework of the ALMA collaboration),
00008  * All rights reserved.
00009  * 
00010  * This library is free software; you can redistribute it and/or
00011  * modify it under the terms of the GNU Lesser General Public
00012  * License as published by the Free software Foundation; either
00013  * version 2.1 of the License, or (at your option) any later version.
00014  * 
00015  * This library is distributed in the hope that it will be useful,
00016  * but WITHOUT ANY WARRANTY, without even the implied warranty of
00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018  * Lesser General Public License for more details.
00019  * 
00020  * You should have received a copy of the GNU Lesser General Public
00021  * License along with this library; if not, write to the Free Software
00022  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
00023  * MA 02111-1307  USA
00024  *
00025  * Warning!
00026  *  -------------------------------------------------------------------- 
00027  * | This is generated code!  Do not modify this file.                  |
00028  * | If you do, all changes will be lost when the file is re-generated. |
00029  *  --------------------------------------------------------------------
00030  *
00031  * File CalGainTable.h
00032  */
00033  
00034 #ifndef CalGainTable_CLASS
00035 #define CalGainTable_CLASS
00036 
00037 #include <string>
00038 #include <vector>
00039 #include <map>
00040 
00041 
00042 
00043         
00044 #include <ArrayTime.h>
00045         
00046 
00047         
00048 #include <Tag.h>
00049         
00050 
00051 
00052 
00053 
00054         
00055 
00056         
00057 
00058         
00059 
00060         
00061 
00062         
00063 
00064         
00065 
00066         
00067 
00068         
00069 
00070         
00071 
00072 
00073 
00074 #include <ConversionException.h>
00075 #include <DuplicateKey.h>
00076 #include <UniquenessViolationException.h>
00077 #include <NoSuchRow.h>
00078 #include <DuplicateKey.h>
00079 
00080 
00081 #ifndef WITHOUT_ACS
00082 #include <asdmIDLC.h>
00083 #endif
00084 
00085 #include <Representable.h>
00086 
00087 #include <pthread.h>
00088 
00089 namespace asdm {
00090 
00091 //class asdm::ASDM;
00092 //class asdm::CalGainRow;
00093 
00094 class ASDM;
00095 class CalGainRow;
00201 class CalGainTable : public Representable {
00202         friend class ASDM;
00203 
00204 public:
00205 
00206 
00212         static const std::vector<std::string>& getKeyName();
00213 
00214 
00215         virtual ~CalGainTable();
00216         
00222         ASDM &getContainer() const;
00223         
00229         unsigned int size() const;
00230         
00238         std::string getName() const;
00239         
00247         static std::string name() ;     
00248         
00253          std::string getVersion() const ;
00254         
00260          static const std::vector<std::string>& getAttributesNames();
00261 
00267          static const std::vector<std::string>& defaultAttributesNamesInBin();
00268          
00272         Entity getEntity() const;
00273 
00278         void setEntity(Entity e);
00279                 
00287         std::string toXML()  ;
00288 
00289 #ifndef WITHOUT_ACS
00290         // Conversion Methods
00296         asdmIDL::CalGainTableIDL *toIDL() ;
00297         
00305          void toIDL(asdmIDL::CalGainTableIDL& x) const;
00306          
00307 #endif
00308 
00309 #ifndef WITHOUT_ACS
00310 
00316         void fromIDL(asdmIDL::CalGainTableIDL x) ;
00317 #endif
00318         
00319         //
00320         // ====> Row creation.
00321         //
00322         
00327         CalGainRow *newRow();
00328         
00329         
00357         CalGainRow *newRow(Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, float gain, bool gainValid, float fit, float fitWeight, bool totalGainValid, float totalFit, float totalFitWeight);
00358         
00359 
00360 
00373          CalGainRow *newRow(CalGainRow *row); 
00374 
00375         //
00376         // ====> Append a row to its table.
00377         //
00378  
00379         
00392         CalGainRow* add(CalGainRow* x) ; 
00393 
00394  
00395 
00396 
00397 
00398         //
00399         // ====> Methods returning rows.
00400         //
00401                 
00407         std::vector<CalGainRow *> get() ;
00408         
00415          const std::vector<CalGainRow *>& get() const ;
00416         
00417 
00418 
00419  
00420         
00432         CalGainRow* getRowByKey(Tag calDataId, Tag calReductionId);
00433 
00434                 
00435 
00436 
00437 
00467         CalGainRow* lookup(Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, float gain, bool gainValid, float fit, float fitWeight, bool totalGainValid, float totalFit, float totalFitWeight); 
00468 
00469 
00470         void setUnknownAttributeBinaryReader(const std::string& attributeName, BinaryAttributeReaderFunctor* barFctr);
00471         BinaryAttributeReaderFunctor* getUnknownAttributeBinaryReader(const std::string& attributeName) const;
00472 
00473 private:
00474 
00483         CalGainTable (ASDM & container);
00484 
00485         ASDM & container;
00486         
00487         bool archiveAsBin; // If true archive binary else archive XML
00488         bool fileAsBin ; // If true file binary else file XML   
00489         
00490         std::string version ; 
00491         
00492         Entity entity;
00493         
00494 
00495 
00503         CalGainRow* checkAndAdd(CalGainRow* x, bool skipCheckUniqueness=false) ;
00504         
00510          void append(CalGainRow* x) ;
00511          
00517          void addWithoutCheckingUnique(CalGainRow* x) ;
00518          
00519          
00520 
00521 
00522 
00523 // A data structure to store the pointers on the table's rows.
00524 
00525 // In all cases we maintain a private vector of CalGainRow s.
00526    std::vector<CalGainRow * > privateRows;
00527    
00528 
00529                         
00530         std::vector<CalGainRow *> row;
00531 
00532         
00533         void error() ; //throw(ConversionException);
00534 
00535         
00542         void fromXML(std::string& xmlDoc) ;
00543                 
00544         std::map<std::string, BinaryAttributeReaderFunctor *> unknownAttributes2Functors;
00545 
00550         void setFromMIMEFile(const std::string& directory);
00551         /*
00552         void openMIMEFile(const std::string& directory);
00553         */
00554         void setFromXMLFile(const std::string& directory);
00555         
00563         std::string toMIME(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity);
00564   
00565         
00572          void setFromMIME(const std::string & mimeMsg);
00573         
00577         std::string MIMEXMLPart(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity);
00578         
00588           void toFile(std::string directory);
00589           
00593           bool loadInProgress;
00594           void checkPresenceInMemory() {
00595                 if (!presentInMemory && !loadInProgress) {
00596                         loadInProgress = true;
00597                         setFromFile(getContainer().getDirectory());
00598                         presentInMemory = true;
00599                         loadInProgress = false;
00600                 }
00601           }
00610          void setFromFile(const std::string& directory);        
00611  
00612 };
00613 
00614 } // End namespace asdm
00615 
00616 #endif /* CalGainTable_CLASS */