PulsarRow.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 PulsarRow.h
 */
 
#ifndef PulsarRow_CLASS
#define PulsarRow_CLASS

#include <vector>
#include <string>
#include <set>

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






         
#include <alma/ASDM/ArrayTime.h>
        

         
#include <alma/ASDM/Frequency.h>
        

         
#include <alma/ASDM/Tag.h>
        

         
#include <alma/ASDM/Interval.h>
        




        

        

        

        

        

        

        

        

        

        

        

        



#include <alma/ASDM/ConversionException.h>
#include <alma/ASDM/NoSuchRow.h>
#include <alma/ASDM/IllegalAccessException.h>

#include <alma/ASDM/RowTransformer.h>
//#include <alma/ASDM/TableStreamReader.h>

/*\file Pulsar.h
    \brief Generated from model's revision "-1", branch ""
*/

namespace asdm {

//class asdm::PulsarTable;

        

class PulsarRow;
typedef void (PulsarRow::*PulsarAttributeFromBin) (EndianIStream& eis);
typedef void (PulsarRow::*PulsarAttributeFromText) (const std::string& s);

class PulsarRow {
friend class asdm::PulsarTable;
friend class asdm::RowTransformer<PulsarRow>;
//friend class asdm::TableStreamReader<PulsarTable, PulsarRow>;

public:

        virtual ~PulsarRow();

        PulsarTable &getTable() const;
        
        bool isAdded() const;
                
        // Intrinsic Table Attributes //
        
        
        // ===> Attribute pulsarId
        
        
        

        
        Tag getPulsarId() const;
        
 
        
        
        
        


        
        // ===> Attribute refTime
        
        
        

        
        ArrayTime getRefTime() const;
        
 
        
        
        void setRefTime (ArrayTime refTime);
                
        
        
        


        
        // ===> Attribute refPulseFreq
        
        
        

        
        Frequency getRefPulseFreq() const;
        
 
        
        
        void setRefPulseFreq (Frequency refPulseFreq);
                
        
        
        


        
        // ===> Attribute refPhase
        
        
        

        
        double getRefPhase() const;
        
 
        
        
        void setRefPhase (double refPhase);
                
        
        
        


        
        // ===> Attribute numBin
        
        
        

        
        int getNumBin() const;
        
 
        
        
        void setNumBin (int numBin);
                
        
        
        


        
        // ===> Attribute numPoly, which is optional
        
        
        
        bool isNumPolyExists() const;
        

        
        int getNumPoly() const;
        
 
        
        
        void setNumPoly (int numPoly);
                
        
        
        
        void clearNumPoly ();
        


        
        // ===> Attribute phasePoly, which is optional
        
        
        
        bool isPhasePolyExists() const;
        

        
        std::vector<double > getPhasePoly() const;
        
 
        
        
        void setPhasePoly (std::vector<double > phasePoly);
                
        
        
        
        void clearPhasePoly ();
        


        
        // ===> Attribute timeSpan, which is optional
        
        
        
        bool isTimeSpanExists() const;
        

        
        Interval getTimeSpan() const;
        
 
        
        
        void setTimeSpan (Interval timeSpan);
                
        
        
        
        void clearTimeSpan ();
        


        
        // ===> Attribute startPhaseBin, which is optional
        
        
        
        bool isStartPhaseBinExists() const;
        

        
        std::vector<float > getStartPhaseBin() const;
        
 
        
        
        void setStartPhaseBin (std::vector<float > startPhaseBin);
                
        
        
        
        void clearStartPhaseBin ();
        


        
        // ===> Attribute endPhaseBin, which is optional
        
        
        
        bool isEndPhaseBinExists() const;
        

        
        std::vector<float > getEndPhaseBin() const;
        
 
        
        
        void setEndPhaseBin (std::vector<float > endPhaseBin);
                
        
        
        
        void clearEndPhaseBin ();
        


        
        // ===> Attribute dispersionMeasure, which is optional
        
        
        
        bool isDispersionMeasureExists() const;
        

        
        double getDispersionMeasure() const;
        
 
        
        
        void setDispersionMeasure (double dispersionMeasure);
                
        
        
        
        void clearDispersionMeasure ();
        


        
        // ===> Attribute refFrequency, which is optional
        
        
        
        bool isRefFrequencyExists() const;
        

        
        Frequency getRefFrequency() const;
        
 
        
        
        void setRefFrequency (Frequency refFrequency);
                
        
        
        
        void clearRefFrequency ();
        


        // Extrinsic Table Attributes //
        
        // Links //
        
        
        
        
        bool compareNoAutoInc(ArrayTime refTime, Frequency refPulseFreq, double refPhase, int numBin);
        
        

        
        bool compareRequiredValue(ArrayTime refTime, Frequency refPulseFreq, double refPhase, int numBin); 
                 
        
        bool equalByRequiredValue(PulsarRow* x) ;
        
#ifndef WITHOUT_ACS

        asdmIDL::PulsarRowIDL *toIDL() const;
        
         void toIDL(asdmIDL::PulsarRowIDL& x) const;
#endif
        
#ifndef WITHOUT_ACS

        void setFromIDL (asdmIDL::PulsarRowIDL x) ;
#endif
        
        std::string toXML() const;

        void setFromXML (std::string rowDoc) ;

        // binary-deserialization material from an EndianIStream  //

        std::map<std::string, PulsarAttributeFromBin> fromBinMethods;
void pulsarIdFromBin( EndianIStream& eis);
void refTimeFromBin( EndianIStream& eis);
void refPulseFreqFromBin( EndianIStream& eis);
void refPhaseFromBin( EndianIStream& eis);
void numBinFromBin( EndianIStream& eis);

void numPolyFromBin( EndianIStream& eis);
void phasePolyFromBin( EndianIStream& eis);
void timeSpanFromBin( EndianIStream& eis);
void startPhaseBinFromBin( EndianIStream& eis);
void endPhaseBinFromBin( EndianIStream& eis);
void dispersionMeasureFromBin( EndianIStream& eis);
void refFrequencyFromBin( EndianIStream& eis);


         static PulsarRow* fromBin(EndianIStream& eis, PulsarTable& table, const std::vector<std::string>& attributesSeq);       
 
         void fromText(const std::string& attributeName, const std::string&  t);

private:
        PulsarTable &table;
        bool hasBeenAdded;

        // This method is used by the Table class when this row is added to the table.
        void isAdded(bool added);


        PulsarRow (PulsarTable &table);

         PulsarRow (PulsarTable &table, PulsarRow *row);
                
        // Intrinsic Table Attributes //
        
        
        // ===> Attribute pulsarId
        
        

        Tag pulsarId;

        
        
        
        void setPulsarId (Tag pulsarId);
                
        

        
        // ===> Attribute refTime
        
        

        ArrayTime refTime;

        
        
        

        
        // ===> Attribute refPulseFreq
        
        

        Frequency refPulseFreq;

        
        
        

        
        // ===> Attribute refPhase
        
        

        double refPhase;

        
        
        

        
        // ===> Attribute numBin
        
        

        int numBin;

        
        
        

        
        // ===> Attribute numPoly, which is optional
        
        
        bool numPolyExists;
        

        int numPoly;

        
        
        

        
        // ===> Attribute phasePoly, which is optional
        
        
        bool phasePolyExists;
        

        std::vector<double > phasePoly;

        
        
        

        
        // ===> Attribute timeSpan, which is optional
        
        
        bool timeSpanExists;
        

        Interval timeSpan;

        
        
        

        
        // ===> Attribute startPhaseBin, which is optional
        
        
        bool startPhaseBinExists;
        

        std::vector<float > startPhaseBin;

        
        
        

        
        // ===> Attribute endPhaseBin, which is optional
        
        
        bool endPhaseBinExists;
        

        std::vector<float > endPhaseBin;

        
        
        

        
        // ===> Attribute dispersionMeasure, which is optional
        
        
        bool dispersionMeasureExists;
        

        double dispersionMeasure;

        
        
        

        
        // ===> Attribute refFrequency, which is optional
        
        
        bool refFrequencyExists;
        

        Frequency refFrequency;

        
        
        

        // Extrinsic Table Attributes //
        
        // Links //
        
        
/*
        // binary-deserialization material from an EndianIStream  //
        std::map<std::string, PulsarAttributeFromBin> fromBinMethods;
void pulsarIdFromBin( EndianIStream& eis);
void refTimeFromBin( EndianIStream& eis);
void refPulseFreqFromBin( EndianIStream& eis);
void refPhaseFromBin( EndianIStream& eis);
void numBinFromBin( EndianIStream& eis);

void numPolyFromBin( EndianIStream& eis);
void phasePolyFromBin( EndianIStream& eis);
void timeSpanFromBin( EndianIStream& eis);
void startPhaseBinFromBin( EndianIStream& eis);
void endPhaseBinFromBin( EndianIStream& eis);
void dispersionMeasureFromBin( EndianIStream& eis);
void refFrequencyFromBin( EndianIStream& eis);

*/
        
        // text-deserialization material //
        std::map<std::string, PulsarAttributeFromText> fromTextMethods;
        
void pulsarIdFromText (const std::string & s);
        
        
void refTimeFromText (const std::string & s);
        
        
void refPulseFreqFromText (const std::string & s);
        
        
void refPhaseFromText (const std::string & s);
        
        
void numBinFromText (const std::string & s);
        

        
void numPolyFromText (const std::string & s);
        
        
void phasePolyFromText (const std::string & s);
        
        
void timeSpanFromText (const std::string & s);
        
        
void startPhaseBinFromText (const std::string & s);
        
        
void endPhaseBinFromText (const std::string & s);
        
        
void dispersionMeasureFromText (const std::string & s);
        
        
void refFrequencyFromText (const std::string & s);
        
        
        
         void toBin(EndianOSStream& eoss);
                 
};

} // End namespace asdm

#endif /* Pulsar_CLASS */