DataDescriptionTable.h

Go to the documentation of this file.

/*
 * 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 DataDescriptionTable.h
 */
 
#ifndef DataDescriptionTable_CLASS
#define DataDescriptionTable_CLASS

#include <string>
#include <vector>
#include <map>
#include <set>
using std::string;
using std::vector;
using std::map;

#include <Angle.h>
#include <AngularRate.h>
#include <ArrayTime.h>
#include <ArrayTimeInterval.h>
#include <Complex.h>
#include <Entity.h>
#include <EntityId.h>
#include <EntityRef.h>
#include <Flux.h>
#include <Frequency.h>
#include <Humidity.h>
#include <Interval.h>
#include <Length.h>
#include <PartId.h>
#include <Pressure.h>
#include <Speed.h>
#include <Tag.h>
#include <Temperature.h>
#include <ConversionException.h>
#include <DuplicateKey.h>
#include <UniquenessViolationException.h>
#include <NoSuchRow.h>
#include <DuplicateKey.h>

#ifndef WITHOUT_ACS
#include <asdmIDLC.h>
using asdmIDL::DataDescriptionTableIDL;
#endif

using asdm::Angle;
using asdm::AngularRate;
using asdm::ArrayTime;
using asdm::Complex;
using asdm::Entity;
using asdm::EntityId;
using asdm::EntityRef;
using asdm::Flux;
using asdm::Frequency;
using asdm::Humidity;
using asdm::Interval;
using asdm::Length;
using asdm::PartId;
using asdm::Pressure;
using asdm::Speed;
using asdm::Tag;
using asdm::Temperature;

using asdm::DuplicateKey;
using asdm::ConversionException;
using asdm::NoSuchRow;
using asdm::DuplicateKey;

#include <Representable.h>

namespace asdm {

//class asdm::ASDM;
//class asdm::DataDescriptionRow;

class ASDM;
class DataDescriptionRow;
class DataDescriptionTable : public Representable {
        friend class asdm::ASDM;

public:


        static vector<string> getKeyName();


        virtual ~DataDescriptionTable();
        
        ASDM &getContainer() const;
        
        unsigned int size() ;
        
        string getName() const;

         static const vector<string>& getAttributesNames();

        Entity getEntity() const;

        void setEntity(Entity e);

        //
        // ====> Row creation.
        //
        
        DataDescriptionRow *newRow();
        
        DataDescriptionRow *newRowEmpty();
        
        DataDescriptionRow *newRow(Tag polOrHoloId, Tag spectralWindowId);
        
        DataDescriptionRow *newRowFull(Tag polOrHoloId, Tag spectralWindowId);
        
         DataDescriptionRow *newRow(DataDescriptionRow *row); 
         
         DataDescriptionRow *newRowCopy(DataDescriptionRow *row);       
         
        //
        // ====> Append a row to its table.
        //

        
        
        
         DataDescriptionRow* add(DataDescriptionRow* x) ;



        //
        // ====> Methods returning rows.
        //
                
        vector<DataDescriptionRow *> get() ;
        


 
        
        DataDescriptionRow* getRowByKey(Tag dataDescriptionId);

                



        DataDescriptionRow* lookup(Tag polarizationId, Tag spectralWindowId); 


#ifndef WITHOUT_ACS
        // Conversion Methods
        DataDescriptionTableIDL *toIDL() ;
#endif

#ifndef WITHOUT_ACS

        void fromIDL(DataDescriptionTableIDL x) throw(DuplicateKey,ConversionException);
#endif

        char *toFITS() const throw(ConversionException);

        void fromFITS(char *fits) throw(ConversionException);

        string toVOTable() const throw(ConversionException);

        void fromVOTable(string vo) throw(ConversionException);

        string toXML()  throw(ConversionException);
        
        void fromXML(string xmlDoc) throw(ConversionException);

        string toMIME();
        
         void setFromMIME(const string & mimeMsg);
        
          void toFile(string directory);
          
         void setFromFile(const string& directory);               
          
private:

        DataDescriptionTable (ASDM & container);

        ASDM & container;
        
        bool archiveAsBin; // If true archive binary else archive XML
        bool fileAsBin ; // If true file binary else file XML           
        
        Entity entity;
        

        // A map for the autoincrementation algorithm
        map<string,int>  noAutoIncIds;
        void autoIncrement(string key, DataDescriptionRow* x);


        static string tableName;

        static const vector<string> attributesNames;

        static vector<string> initAttributesNames();

        static vector<string> key;


        DataDescriptionRow* checkAndAdd(DataDescriptionRow* x) throw (DuplicateKey, UniquenessViolationException);



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

// In all cases we maintain a private ArrayList of DataDescriptionRow s.
   vector<DataDescriptionRow * > privateRows;
   

                        
        vector<DataDescriptionRow *> row;



        void getByRequiredValue(vector <DataDescriptionRow*>& vin, vector <DataDescriptionRow*>& vout,  Tag polarizationId, Tag spectralWindowId);







        void error() throw(ConversionException);

};

} // End namespace asdm

#endif /* DataDescriptionTable_CLASS */