AnnotationTable.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 AnnotationTable.h
 */
 
#ifndef AnnotationTable_CLASS
#define AnnotationTable_CLASS

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



#include <ArrayTime.h>
using  asdm::ArrayTime;

#include <Interval.h>
using  asdm::Interval;

#include <Tag.h>
using  asdm::Tag;




        

        

        

        

        

        
#include "CBasebandName.h"
using namespace BasebandNameMod;
        

        

        

        

        

        

        

        

        



#include <ConversionException.h>
#include <DuplicateKey.h>
#include <UniquenessViolationException.h>
#include <NoSuchRow.h>
#include <DuplicateKey.h>
using asdm::DuplicateKey;
using asdm::ConversionException;
using asdm::NoSuchRow;
using asdm::DuplicateKey;

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

#include <Representable.h>

namespace asdm {

//class asdm::ASDM;
//class asdm::AnnotationRow;

class ASDM;
class AnnotationRow;
class AnnotationTable : public Representable {
        friend class ASDM;

public:


        static vector<string> getKeyName();


        virtual ~AnnotationTable();
        
        ASDM &getContainer() const;
        
        unsigned int size() ;
        
        string getName() const;
        
         static const vector<string>& getAttributesNames();

        Entity getEntity() const;

        void setEntity(Entity e);
                
        string toXML()  ;

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

#ifndef WITHOUT_ACS

        void fromIDL(AnnotationTableIDL x) ;
#endif
        
        //
        // ====> Row creation.
        //
        
        AnnotationRow *newRow();
        
        
        AnnotationRow *newRow(ArrayTime time, string issue, string details);
        


         AnnotationRow *newRow(AnnotationRow *row); 

        //
        // ====> Append a row to its table.
        //

        
        
        
         AnnotationRow* add(AnnotationRow* x) ;



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


 
        
        AnnotationRow* getRowByKey(Tag annotationId);

                



        AnnotationRow* lookup(ArrayTime time, string issue, string details); 


private:

        AnnotationTable (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, AnnotationRow* x);


        static string tableName;
        
        static const vector<string> attributesNames;
        
        static vector<string> initAttributesNames();


        static vector<string> key;


        AnnotationRow* checkAndAdd(AnnotationRow* x) ;



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

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

                        
        vector<AnnotationRow *> row;

        
        void error() ; //throw(ConversionException);

        
        void fromXML(string xmlDoc) ;
                
        void setFromMIMEFile(const string& directory);
        void setFromXMLFile(const string& directory);
        
        string toMIME(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity);
  
        
         void setFromMIME(const string & mimeMsg);
        
        string MIMEXMLPart(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity);
        
          void toFile(string directory);
          
         void setFromFile(const string& directory);     
 
};

} // End namespace asdm

#endif /* AnnotationTable_CLASS */