AnnotationTable.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 AnnotationTable.h
00032  */
00033  
00034 #ifndef AnnotationTable_CLASS
00035 #define AnnotationTable_CLASS
00036 
00037 #include <string>
00038 #include <vector>
00039 #include <map>
00040 #include <set>
00041 using std::string;
00042 using std::vector;
00043 using std::map;
00044 
00045 #include <Angle.h>
00046 #include <AngularRate.h>
00047 #include <ArrayTime.h>
00048 #include <ArrayTimeInterval.h>
00049 #include <Complex.h>
00050 #include <Entity.h>
00051 #include <EntityId.h>
00052 #include <EntityRef.h>
00053 #include <Flux.h>
00054 #include <Frequency.h>
00055 #include <Humidity.h>
00056 #include <Interval.h>
00057 #include <Length.h>
00058 #include <PartId.h>
00059 #include <Pressure.h>
00060 #include <Speed.h>
00061 #include <Tag.h>
00062 #include <Temperature.h>
00063 #include <ConversionException.h>
00064 #include <DuplicateKey.h>
00065 #include <UniquenessViolationException.h>
00066 #include <NoSuchRow.h>
00067 #include <DuplicateKey.h>
00068 
00069 /*
00070 #include <Enumerations.h>
00071 using namespace enumerations;
00072 */
00073 
00074 
00075 
00076 
00077         
00078 
00079         
00080 
00081         
00082 
00083         
00084 
00085         
00086 
00087         
00088 
00089         
00090 #include "CBasebandName.h"
00091 using namespace BasebandNameMod;
00092         
00093 
00094         
00095 
00096         
00097 
00098         
00099 
00100         
00101 
00102         
00103 
00104         
00105 
00106         
00107 
00108 
00109 #ifndef WITHOUT_ACS
00110 #include <asdmIDLC.h>
00111 using asdmIDL::AnnotationTableIDL;
00112 #endif
00113 
00114 using asdm::Angle;
00115 using asdm::AngularRate;
00116 using asdm::ArrayTime;
00117 using asdm::Complex;
00118 using asdm::Entity;
00119 using asdm::EntityId;
00120 using asdm::EntityRef;
00121 using asdm::Flux;
00122 using asdm::Frequency;
00123 using asdm::Humidity;
00124 using asdm::Interval;
00125 using asdm::Length;
00126 using asdm::PartId;
00127 using asdm::Pressure;
00128 using asdm::Speed;
00129 using asdm::Tag;
00130 using asdm::Temperature;
00131 
00132 using asdm::DuplicateKey;
00133 using asdm::ConversionException;
00134 using asdm::NoSuchRow;
00135 using asdm::DuplicateKey;
00136 
00137 #include <Representable.h>
00138 
00139 namespace asdm {
00140 
00141 //class asdm::ASDM;
00142 //class asdm::AnnotationRow;
00143 
00144 class ASDM;
00145 class AnnotationRow;
00260 class AnnotationTable : public Representable {
00261         friend class asdm::ASDM;
00262 
00263 public:
00264 
00265 
00271         static vector<string> getKeyName();
00272 
00273 
00274         virtual ~AnnotationTable();
00275         
00281         ASDM &getContainer() const;
00282         
00288         unsigned int size() ;
00289         
00295         string getName() const;
00296 
00300         Entity getEntity() const;
00301 
00306         void setEntity(Entity e);
00307 
00308         //
00309         // ====> Row creation.
00310         //
00311         
00316         AnnotationRow *newRow();
00317         
00322         AnnotationRow* newRowEmpty();
00323 
00324         
00336         AnnotationRow *newRow(ArrayTime time, string issue, string details);
00337         
00342         AnnotationRow *newRowFull(ArrayTime time, string issue, string details);
00343 
00344 
00357          AnnotationRow *newRow(AnnotationRow *row); 
00358 
00363          AnnotationRow *newRowCopy(AnnotationRow *row); 
00364 
00365         //
00366         // ====> Append a row to its table.
00367         //
00368 
00369         
00370         
00371         
00381          AnnotationRow* add(AnnotationRow* x) ;
00382 
00383 
00384 
00385         //
00386         // ====> Methods returning rows.
00387         //
00388                 
00394         vector<AnnotationRow *> get() ;
00395         
00396 
00397 
00398  
00399         
00409         AnnotationRow* getRowByKey(Tag annotationId);
00410 
00411                 
00412 
00413 
00414 
00428         AnnotationRow* lookup(ArrayTime time, string issue, string details); 
00429 
00430 
00431 #ifndef WITHOUT_ACS
00432         // Conversion Methods
00438         AnnotationTableIDL *toIDL() ;
00439 #endif
00440 
00441 #ifndef WITHOUT_ACS
00442 
00448         void fromIDL(AnnotationTableIDL x) throw(DuplicateKey,ConversionException);
00449 #endif
00450 
00454         char *toFITS() const throw(ConversionException);
00455 
00459         void fromFITS(char *fits) throw(ConversionException);
00460 
00464         string toVOTable() const throw(ConversionException);
00465 
00469         void fromVOTable(string vo) throw(ConversionException);
00470 
00477         string toXML()  throw(ConversionException);
00478         
00484         void fromXML(string xmlDoc) throw(ConversionException);
00485         
00491         string toMIME();
00492         
00499          void setFromMIME(const string & mimeMsg);
00500         
00510           void toFile(string directory);
00511           
00520          void setFromFile(const string& directory);     
00521 
00522 private:
00523 
00532         AnnotationTable (ASDM & container);
00533 
00534         ASDM & container;
00535         
00536         bool archiveAsBin; // If true archive binary else archive XML
00537         bool fileAsBin ; // If true file binary else file XML   
00538         
00539         Entity entity;
00540         
00541 
00542         // A map for the autoincrementation algorithm
00543         map<string,int>  noAutoIncIds;
00544         void autoIncrement(string key, AnnotationRow* x);
00545 
00546 
00550         static string tableName;
00551 
00552 
00556         static vector<string> key;
00557 
00558 
00564         AnnotationRow* checkAndAdd(AnnotationRow* x) throw (DuplicateKey, UniquenessViolationException);
00565 
00566 
00567 
00568 // A data structure to store the pointers on the table's rows.
00569 
00570 // In all cases we maintain a private ArrayList of AnnotationRow s.
00571    vector<AnnotationRow * > privateRows;
00572    
00573 
00574                         
00575         vector<AnnotationRow *> row;
00576 
00577 
00578         void error() throw(ConversionException);
00579 
00580 };
00581 
00582 } // End namespace asdm
00583 
00584 #endif /* AnnotationTable_CLASS */

Generated on Thu Aug 27 21:08:35 2009 for NRAOCASA by  doxygen 1.5.1