SpectralWindowRow.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 SpectralWindowRow.h
 */
 
#ifndef SpectralWindowRow_CLASS
#define SpectralWindowRow_CLASS

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

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






         
#include <Tag.h>
        

         
#include <Frequency.h>
        




        

        
#include "CBasebandName.h"
        

        
#include "CNetSideband.h"
        

        

        

        
#include "CSidebandProcessingMode.h"
        

        

        
#include "CWindowFunction.h"
        

        

        

        

        

        

        
#include "CCorrelationBit.h"
        

        

        

        

        

        

        
#include "CFrequencyReferenceCode.h"
        

        

        

        

        

        

        

        

        
#include "CSpectralResolutionType.h"
        



#include <ConversionException.h>
#include <NoSuchRow.h>
#include <IllegalAccessException.h>

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

/*\file SpectralWindow.h
    \brief Generated from model's revision "1.64", branch "HEAD"
*/

namespace asdm {

//class asdm::SpectralWindowTable;


// class asdm::SpectralWindowRow;
class SpectralWindowRow;

// class asdm::SpectralWindowRow;
class SpectralWindowRow;

// class asdm::DopplerRow;
class DopplerRow;
        

class SpectralWindowRow;
typedef void (SpectralWindowRow::*SpectralWindowAttributeFromBin) (EndianIStream& eis);
typedef void (SpectralWindowRow::*SpectralWindowAttributeFromText) (const string& s);

class SpectralWindowRow {
friend class asdm::SpectralWindowTable;
friend class asdm::RowTransformer<SpectralWindowRow>;
//friend class asdm::TableStreamReader<SpectralWindowTable, SpectralWindowRow>;

public:

        virtual ~SpectralWindowRow();

        SpectralWindowTable &getTable() const;
        
        bool isAdded() const;
                
        // Intrinsic Table Attributes //
        
        
        // ===> Attribute spectralWindowId
        
        
        

        
        Tag getSpectralWindowId() const;
        
 
        
        
        
        


        
        // ===> Attribute basebandName
        
        
        

        
        BasebandNameMod::BasebandName getBasebandName() const;
        
 
        
        
        void setBasebandName (BasebandNameMod::BasebandName basebandName);
                
        
        
        


        
        // ===> Attribute netSideband
        
        
        

        
        NetSidebandMod::NetSideband getNetSideband() const;
        
 
        
        
        void setNetSideband (NetSidebandMod::NetSideband netSideband);
                
        
        
        


        
        // ===> Attribute numChan
        
        
        

        
        int getNumChan() const;
        
 
        
        
        void setNumChan (int numChan);
                
        
        
        


        
        // ===> Attribute refFreq
        
        
        

        
        Frequency getRefFreq() const;
        
 
        
        
        void setRefFreq (Frequency refFreq);
                
        
        
        


        
        // ===> Attribute sidebandProcessingMode
        
        
        

        
        SidebandProcessingModeMod::SidebandProcessingMode getSidebandProcessingMode() const;
        
 
        
        
        void setSidebandProcessingMode (SidebandProcessingModeMod::SidebandProcessingMode sidebandProcessingMode);
                
        
        
        


        
        // ===> Attribute totBandwidth
        
        
        

        
        Frequency getTotBandwidth() const;
        
 
        
        
        void setTotBandwidth (Frequency totBandwidth);
                
        
        
        


        
        // ===> Attribute windowFunction
        
        
        

        
        WindowFunctionMod::WindowFunction getWindowFunction() const;
        
 
        
        
        void setWindowFunction (WindowFunctionMod::WindowFunction windowFunction);
                
        
        
        


        
        // ===> Attribute chanFreqStart, which is optional
        
        
        
        bool isChanFreqStartExists() const;
        

        
        Frequency getChanFreqStart() const;
        
 
        
        
        void setChanFreqStart (Frequency chanFreqStart);
                
        
        
        
        void clearChanFreqStart ();
        


        
        // ===> Attribute chanFreqStep, which is optional
        
        
        
        bool isChanFreqStepExists() const;
        

        
        Frequency getChanFreqStep() const;
        
 
        
        
        void setChanFreqStep (Frequency chanFreqStep);
                
        
        
        
        void clearChanFreqStep ();
        


        
        // ===> Attribute chanFreqArray, which is optional
        
        
        
        bool isChanFreqArrayExists() const;
        

        
        vector<Frequency > getChanFreqArray() const;
        
 
        
        
        void setChanFreqArray (vector<Frequency > chanFreqArray);
                
        
        
        
        void clearChanFreqArray ();
        


        
        // ===> Attribute chanWidth, which is optional
        
        
        
        bool isChanWidthExists() const;
        

        
        Frequency getChanWidth() const;
        
 
        
        
        void setChanWidth (Frequency chanWidth);
                
        
        
        
        void clearChanWidth ();
        


        
        // ===> Attribute chanWidthArray, which is optional
        
        
        
        bool isChanWidthArrayExists() const;
        

        
        vector<Frequency > getChanWidthArray() const;
        
 
        
        
        void setChanWidthArray (vector<Frequency > chanWidthArray);
                
        
        
        
        void clearChanWidthArray ();
        


        
        // ===> Attribute correlationBit, which is optional
        
        
        
        bool isCorrelationBitExists() const;
        

        
        CorrelationBitMod::CorrelationBit getCorrelationBit() const;
        
 
        
        
        void setCorrelationBit (CorrelationBitMod::CorrelationBit correlationBit);
                
        
        
        
        void clearCorrelationBit ();
        


        
        // ===> Attribute effectiveBw, which is optional
        
        
        
        bool isEffectiveBwExists() const;
        

        
        Frequency getEffectiveBw() const;
        
 
        
        
        void setEffectiveBw (Frequency effectiveBw);
                
        
        
        
        void clearEffectiveBw ();
        


        
        // ===> Attribute effectiveBwArray, which is optional
        
        
        
        bool isEffectiveBwArrayExists() const;
        

        
        vector<Frequency > getEffectiveBwArray() const;
        
 
        
        
        void setEffectiveBwArray (vector<Frequency > effectiveBwArray);
                
        
        
        
        void clearEffectiveBwArray ();
        


        
        // ===> Attribute freqGroup, which is optional
        
        
        
        bool isFreqGroupExists() const;
        

        
        int getFreqGroup() const;
        
 
        
        
        void setFreqGroup (int freqGroup);
                
        
        
        
        void clearFreqGroup ();
        


        
        // ===> Attribute freqGroupName, which is optional
        
        
        
        bool isFreqGroupNameExists() const;
        

        
        string getFreqGroupName() const;
        
 
        
        
        void setFreqGroupName (string freqGroupName);
                
        
        
        
        void clearFreqGroupName ();
        


        
        // ===> Attribute lineArray, which is optional
        
        
        
        bool isLineArrayExists() const;
        

        
        vector<bool > getLineArray() const;
        
 
        
        
        void setLineArray (vector<bool > lineArray);
                
        
        
        
        void clearLineArray ();
        


        
        // ===> Attribute measFreqRef, which is optional
        
        
        
        bool isMeasFreqRefExists() const;
        

        
        FrequencyReferenceCodeMod::FrequencyReferenceCode getMeasFreqRef() const;
        
 
        
        
        void setMeasFreqRef (FrequencyReferenceCodeMod::FrequencyReferenceCode measFreqRef);
                
        
        
        
        void clearMeasFreqRef ();
        


        
        // ===> Attribute name, which is optional
        
        
        
        bool isNameExists() const;
        

        
        string getName() const;
        
 
        
        
        void setName (string name);
                
        
        
        
        void clearName ();
        


        
        // ===> Attribute oversampling, which is optional
        
        
        
        bool isOversamplingExists() const;
        

        
        bool getOversampling() const;
        
 
        
        
        void setOversampling (bool oversampling);
                
        
        
        
        void clearOversampling ();
        


        
        // ===> Attribute quantization, which is optional
        
        
        
        bool isQuantizationExists() const;
        

        
        bool getQuantization() const;
        
 
        
        
        void setQuantization (bool quantization);
                
        
        
        
        void clearQuantization ();
        


        
        // ===> Attribute refChan, which is optional
        
        
        
        bool isRefChanExists() const;
        

        
        double getRefChan() const;
        
 
        
        
        void setRefChan (double refChan);
                
        
        
        
        void clearRefChan ();
        


        
        // ===> Attribute resolution, which is optional
        
        
        
        bool isResolutionExists() const;
        

        
        Frequency getResolution() const;
        
 
        
        
        void setResolution (Frequency resolution);
                
        
        
        
        void clearResolution ();
        


        
        // ===> Attribute resolutionArray, which is optional
        
        
        
        bool isResolutionArrayExists() const;
        

        
        vector<Frequency > getResolutionArray() const;
        
 
        
        
        void setResolutionArray (vector<Frequency > resolutionArray);
                
        
        
        
        void clearResolutionArray ();
        


        
        // ===> Attribute numAssocValues, which is optional
        
        
        
        bool isNumAssocValuesExists() const;
        

        
        int getNumAssocValues() const;
        
 
        
        
        void setNumAssocValues (int numAssocValues);
                
        
        
        
        void clearNumAssocValues ();
        


        
        // ===> Attribute assocNature, which is optional
        
        
        
        bool isAssocNatureExists() const;
        

        
        vector<SpectralResolutionTypeMod::SpectralResolutionType > getAssocNature() const;
        
 
        
        
        void setAssocNature (vector<SpectralResolutionTypeMod::SpectralResolutionType > assocNature);
                
        
        
        
        void clearAssocNature ();
        


        // Extrinsic Table Attributes //
        
        
        // ===> Attribute assocSpectralWindowId, which is optional
        
        
        
        bool isAssocSpectralWindowIdExists() const;
        

        
        vector<Tag>  getAssocSpectralWindowId() const;
        
 
        
        
        void setAssocSpectralWindowId (vector<Tag>  assocSpectralWindowId);
                
        
        
        
        void clearAssocSpectralWindowId ();
        


        
        // ===> Attribute dopplerId, which is optional
        
        
        
        bool isDopplerIdExists() const;
        

        
        int getDopplerId() const;
        
 
        
        
        void setDopplerId (int dopplerId);
                
        
        
        
        void clearDopplerId ();
        


        
        // ===> Attribute imageSpectralWindowId, which is optional
        
        
        
        bool isImageSpectralWindowIdExists() const;
        

        
        Tag getImageSpectralWindowId() const;
        
 
        
        
        void setImageSpectralWindowId (Tag imageSpectralWindowId);
                
        
        
        
        void clearImageSpectralWindowId ();
        


        // Links //
        
        
                
        void setAssocSpectralWindowId (int i, Tag assocSpectralWindowId)  ;
                        
        

        
                 
 void addAssocSpectralWindowId(Tag id); 

 void addAssocSpectralWindowId(const vector<Tag> & id); 
 

 const Tag getAssocSpectralWindowId(int i);
 
 SpectralWindowRow* getSpectralWindowUsingAssocSpectralWindowId(int i); 
 
 vector<SpectralWindowRow *> getSpectralWindowsUsingAssocSpectralWindowId(); 
  

        

        

        
                
         SpectralWindowRow* getSpectralWindowUsingImageSpectralWindowId();
         

        

        

        
                
        // ===> Slice link from a row of SpectralWindow table to a collection of row of Doppler table.
        
        vector <DopplerRow *> getDopplers();
        
        

        

        
        
        
        bool compareNoAutoInc(BasebandNameMod::BasebandName basebandName, NetSidebandMod::NetSideband netSideband, int numChan, Frequency refFreq, SidebandProcessingModeMod::SidebandProcessingMode sidebandProcessingMode, Frequency totBandwidth, WindowFunctionMod::WindowFunction windowFunction);
        
        

        
        bool compareRequiredValue(BasebandNameMod::BasebandName basebandName, NetSidebandMod::NetSideband netSideband, int numChan, Frequency refFreq, SidebandProcessingModeMod::SidebandProcessingMode sidebandProcessingMode, Frequency totBandwidth, WindowFunctionMod::WindowFunction windowFunction); 
                 
        
        bool equalByRequiredValue(SpectralWindowRow* x) ;
        
#ifndef WITHOUT_ACS

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

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

        void setFromXML (std::string rowDoc) ;

        // binary-deserialization material from an EndianIStream  //

        std::map<std::string, SpectralWindowAttributeFromBin> fromBinMethods;
void spectralWindowIdFromBin( EndianIStream& eis);
void basebandNameFromBin( EndianIStream& eis);
void netSidebandFromBin( EndianIStream& eis);
void numChanFromBin( EndianIStream& eis);
void refFreqFromBin( EndianIStream& eis);
void sidebandProcessingModeFromBin( EndianIStream& eis);
void totBandwidthFromBin( EndianIStream& eis);
void windowFunctionFromBin( EndianIStream& eis);

void chanFreqStartFromBin( EndianIStream& eis);
void chanFreqStepFromBin( EndianIStream& eis);
void chanFreqArrayFromBin( EndianIStream& eis);
void chanWidthFromBin( EndianIStream& eis);
void chanWidthArrayFromBin( EndianIStream& eis);
void correlationBitFromBin( EndianIStream& eis);
void effectiveBwFromBin( EndianIStream& eis);
void effectiveBwArrayFromBin( EndianIStream& eis);
void freqGroupFromBin( EndianIStream& eis);
void freqGroupNameFromBin( EndianIStream& eis);
void lineArrayFromBin( EndianIStream& eis);
void measFreqRefFromBin( EndianIStream& eis);
void nameFromBin( EndianIStream& eis);
void oversamplingFromBin( EndianIStream& eis);
void quantizationFromBin( EndianIStream& eis);
void refChanFromBin( EndianIStream& eis);
void resolutionFromBin( EndianIStream& eis);
void resolutionArrayFromBin( EndianIStream& eis);
void numAssocValuesFromBin( EndianIStream& eis);
void assocNatureFromBin( EndianIStream& eis);
void assocSpectralWindowIdFromBin( EndianIStream& eis);
void imageSpectralWindowIdFromBin( EndianIStream& eis);
void dopplerIdFromBin( EndianIStream& eis);


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

private:
        SpectralWindowTable &table;
        bool hasBeenAdded;

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


        SpectralWindowRow (SpectralWindowTable &table);

         SpectralWindowRow (SpectralWindowTable &table, SpectralWindowRow &row);
                
        // Intrinsic Table Attributes //
        
        
        // ===> Attribute spectralWindowId
        
        

        Tag spectralWindowId;

        
        
        
        void setSpectralWindowId (Tag spectralWindowId);
                
        

        
        // ===> Attribute basebandName
        
        

        BasebandNameMod::BasebandName basebandName;

        
        
        

        
        // ===> Attribute netSideband
        
        

        NetSidebandMod::NetSideband netSideband;

        
        
        

        
        // ===> Attribute numChan
        
        

        int numChan;

        
        
        

        
        // ===> Attribute refFreq
        
        

        Frequency refFreq;

        
        
        

        
        // ===> Attribute sidebandProcessingMode
        
        

        SidebandProcessingModeMod::SidebandProcessingMode sidebandProcessingMode;

        
        
        

        
        // ===> Attribute totBandwidth
        
        

        Frequency totBandwidth;

        
        
        

        
        // ===> Attribute windowFunction
        
        

        WindowFunctionMod::WindowFunction windowFunction;

        
        
        

        
        // ===> Attribute chanFreqStart, which is optional
        
        
        bool chanFreqStartExists;
        

        Frequency chanFreqStart;

        
        
        

        
        // ===> Attribute chanFreqStep, which is optional
        
        
        bool chanFreqStepExists;
        

        Frequency chanFreqStep;

        
        
        

        
        // ===> Attribute chanFreqArray, which is optional
        
        
        bool chanFreqArrayExists;
        

        vector<Frequency > chanFreqArray;

        
        
        

        
        // ===> Attribute chanWidth, which is optional
        
        
        bool chanWidthExists;
        

        Frequency chanWidth;

        
        
        

        
        // ===> Attribute chanWidthArray, which is optional
        
        
        bool chanWidthArrayExists;
        

        vector<Frequency > chanWidthArray;

        
        
        

        
        // ===> Attribute correlationBit, which is optional
        
        
        bool correlationBitExists;
        

        CorrelationBitMod::CorrelationBit correlationBit;

        
        
        

        
        // ===> Attribute effectiveBw, which is optional
        
        
        bool effectiveBwExists;
        

        Frequency effectiveBw;

        
        
        

        
        // ===> Attribute effectiveBwArray, which is optional
        
        
        bool effectiveBwArrayExists;
        

        vector<Frequency > effectiveBwArray;

        
        
        

        
        // ===> Attribute freqGroup, which is optional
        
        
        bool freqGroupExists;
        

        int freqGroup;

        
        
        

        
        // ===> Attribute freqGroupName, which is optional
        
        
        bool freqGroupNameExists;
        

        string freqGroupName;

        
        
        

        
        // ===> Attribute lineArray, which is optional
        
        
        bool lineArrayExists;
        

        vector<bool > lineArray;

        
        
        

        
        // ===> Attribute measFreqRef, which is optional
        
        
        bool measFreqRefExists;
        

        FrequencyReferenceCodeMod::FrequencyReferenceCode measFreqRef;

        
        
        

        
        // ===> Attribute name, which is optional
        
        
        bool nameExists;
        

        string name;

        
        
        

        
        // ===> Attribute oversampling, which is optional
        
        
        bool oversamplingExists;
        

        bool oversampling;

        
        
        

        
        // ===> Attribute quantization, which is optional
        
        
        bool quantizationExists;
        

        bool quantization;

        
        
        

        
        // ===> Attribute refChan, which is optional
        
        
        bool refChanExists;
        

        double refChan;

        
        
        

        
        // ===> Attribute resolution, which is optional
        
        
        bool resolutionExists;
        

        Frequency resolution;

        
        
        

        
        // ===> Attribute resolutionArray, which is optional
        
        
        bool resolutionArrayExists;
        

        vector<Frequency > resolutionArray;

        
        
        

        
        // ===> Attribute numAssocValues, which is optional
        
        
        bool numAssocValuesExists;
        

        int numAssocValues;

        
        
        

        
        // ===> Attribute assocNature, which is optional
        
        
        bool assocNatureExists;
        

        vector<SpectralResolutionTypeMod::SpectralResolutionType > assocNature;

        
        
        

        // Extrinsic Table Attributes //
        
        
        // ===> Attribute assocSpectralWindowId, which is optional
        
        
        bool assocSpectralWindowIdExists;
        

        vector<Tag>  assocSpectralWindowId;

        
        
        

        
        // ===> Attribute dopplerId, which is optional
        
        
        bool dopplerIdExists;
        

        int dopplerId;

        
        
        

        
        // ===> Attribute imageSpectralWindowId, which is optional
        
        
        bool imageSpectralWindowIdExists;
        

        Tag imageSpectralWindowId;

        
        
        

        // Links //
        
        
                


        

        
                

         

        

        
                


        

        
/*
        // binary-deserialization material from an EndianIStream  //
        std::map<std::string, SpectralWindowAttributeFromBin> fromBinMethods;
void spectralWindowIdFromBin( EndianIStream& eis);
void basebandNameFromBin( EndianIStream& eis);
void netSidebandFromBin( EndianIStream& eis);
void numChanFromBin( EndianIStream& eis);
void refFreqFromBin( EndianIStream& eis);
void sidebandProcessingModeFromBin( EndianIStream& eis);
void totBandwidthFromBin( EndianIStream& eis);
void windowFunctionFromBin( EndianIStream& eis);

void chanFreqStartFromBin( EndianIStream& eis);
void chanFreqStepFromBin( EndianIStream& eis);
void chanFreqArrayFromBin( EndianIStream& eis);
void chanWidthFromBin( EndianIStream& eis);
void chanWidthArrayFromBin( EndianIStream& eis);
void correlationBitFromBin( EndianIStream& eis);
void effectiveBwFromBin( EndianIStream& eis);
void effectiveBwArrayFromBin( EndianIStream& eis);
void freqGroupFromBin( EndianIStream& eis);
void freqGroupNameFromBin( EndianIStream& eis);
void lineArrayFromBin( EndianIStream& eis);
void measFreqRefFromBin( EndianIStream& eis);
void nameFromBin( EndianIStream& eis);
void oversamplingFromBin( EndianIStream& eis);
void quantizationFromBin( EndianIStream& eis);
void refChanFromBin( EndianIStream& eis);
void resolutionFromBin( EndianIStream& eis);
void resolutionArrayFromBin( EndianIStream& eis);
void numAssocValuesFromBin( EndianIStream& eis);
void assocNatureFromBin( EndianIStream& eis);
void assocSpectralWindowIdFromBin( EndianIStream& eis);
void imageSpectralWindowIdFromBin( EndianIStream& eis);
void dopplerIdFromBin( EndianIStream& eis);

*/
        
        // text-deserialization material //
        std::map<std::string, SpectralWindowAttributeFromText> fromTextMethods;
        
void spectralWindowIdFromText (const string & s);
        
        
void basebandNameFromText (const string & s);
        
        
void netSidebandFromText (const string & s);
        
        
void numChanFromText (const string & s);
        
        
void refFreqFromText (const string & s);
        
        
void sidebandProcessingModeFromText (const string & s);
        
        
void totBandwidthFromText (const string & s);
        
        
void windowFunctionFromText (const string & s);
        

        
void chanFreqStartFromText (const string & s);
        
        
void chanFreqStepFromText (const string & s);
        
        
void chanFreqArrayFromText (const string & s);
        
        
void chanWidthFromText (const string & s);
        
        
void chanWidthArrayFromText (const string & s);
        
        
void correlationBitFromText (const string & s);
        
        
void effectiveBwFromText (const string & s);
        
        
void effectiveBwArrayFromText (const string & s);
        
        
void freqGroupFromText (const string & s);
        
        
void freqGroupNameFromText (const string & s);
        
        
void lineArrayFromText (const string & s);
        
        
void measFreqRefFromText (const string & s);
        
        
void nameFromText (const string & s);
        
        
void oversamplingFromText (const string & s);
        
        
void quantizationFromText (const string & s);
        
        
void refChanFromText (const string & s);
        
        
void resolutionFromText (const string & s);
        
        
void resolutionArrayFromText (const string & s);
        
        
void numAssocValuesFromText (const string & s);
        
        
void assocNatureFromText (const string & s);
        
        
void assocSpectralWindowIdFromText (const string & s);
        
        
void imageSpectralWindowIdFromText (const string & s);
        
        
void dopplerIdFromText (const string & s);
        
        
        
         void toBin(EndianOSStream& eoss);
                 
};

} // End namespace asdm

#endif /* SpectralWindow_CLASS */