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 <alma/ASDM/ArrayTime.h>
        

        
#include <alma/ASDM/Tag.h>
        

        
#include <alma/ASDM/Interval.h>
        




        

        

        

        

        

        
#include <alma/Enumerations/CBasebandName.h>
        

        

        

        

        

        

        

        

        

        



#include <alma/ASDM/ConversionException.h>
#include <alma/ASDM/DuplicateKey.h>
#include <alma/ASDM/UniquenessViolationException.h>
#include <alma/ASDM/NoSuchRow.h>
#include <alma/ASDM/DuplicateKey.h>


#ifndef WITHOUT_ACS
#include <asdmIDLC.h>
#endif

#include <alma/ASDM/Representable.h>

#include <pthread.h>

namespace asdm {

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

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

public:


        static const std::vector<std::string>& getKeyName();


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

         static const std::vector<std::string>& defaultAttributesNamesInBin();
         
        Entity getEntity() const;

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

#ifndef WITHOUT_ACS
        // Conversion Methods
        asdmIDL::AnnotationTableIDL *toIDL() ;
        
         void toIDL(asdmIDL::AnnotationTableIDL& x) const;
         
#endif

#ifndef WITHOUT_ACS

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


         AnnotationRow *newRow(AnnotationRow *row); 

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

        
        
        
         AnnotationRow* add(AnnotationRow* x) ;



        //
        // ====> Methods returning rows.
        //
                
        std::vector<AnnotationRow *> get() ;
        
         const std::vector<AnnotationRow *>& get() const ;
        


 
        
        AnnotationRow* getRowByKey(Tag annotationId);

                



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


        void setUnknownAttributeBinaryReader(const std::string& attributeName, BinaryAttributeReaderFunctor* barFctr);
        BinaryAttributeReaderFunctor* getUnknownAttributeBinaryReader(const std::string& attributeName) const;

private:

        AnnotationTable (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;
        

        
        

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


        AnnotationRow* checkAndAdd(AnnotationRow* x, bool skipCheckUniqueness=false) ;
        
         void append(AnnotationRow* x) ;
         
         void addWithoutCheckingUnique(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.
   std::vector<AnnotationRow * > privateRows;
   

                        
        std::vector<AnnotationRow *> row;

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

        
        void fromXML(std::string& xmlDoc) ;
                
        std::map<std::string, BinaryAttributeReaderFunctor *> unknownAttributes2Functors;

        void setFromMIMEFile(const std::string& directory);
        /*
        void openMIMEFile(const std::string& directory);
        */
        void setFromXMLFile(const std::string& directory);
        
        std::string toMIME(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity);
  
        
         void setFromMIME(const std::string & mimeMsg);
        
        std::string MIMEXMLPart(const asdm::ByteOrder* byteOrder=asdm::ByteOrder::Machine_Endianity);
        
          void toFile(std::string directory);
          
          bool loadInProgress;
          void checkPresenceInMemory() {
                if (!presentInMemory && !loadInProgress) {
                        loadInProgress = true;
                        setFromFile(getContainer().getDirectory());
                        presentInMemory = true;
                        loadInProgress = false;
                }
          }
         void setFromFile(const std::string& directory);        
 
};

} // End namespace asdm

#endif /* AnnotationTable_CLASS */