PlotMSExportParam.h

Go to the documentation of this file.
00001 //# PlotMSExportParam.h: Export parameters container
00002 //# Copyright (C) 2009
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //# $Id: $
00027 #ifndef PLOTMSEXPORTPARAM_H_
00028 #define PLOTMSEXPORTPARAM_H_
00029 
00030 #include <plotms/PlotMS/PlotMSConstants.h>
00031 
00032 namespace casa {
00033 
00034 // Specifies export parameters for plotms
00035 class PlotMSExportParam {
00036 public:
00037     
00038   // Constructor, which uses default values.
00039   PlotMSExportParam();
00040     
00041   // Destructor.
00042   ~PlotMSExportParam();
00043     
00044     
00045   // Converts this object to/from a record.  Each field will have a key that
00046   // is its enum name
00047   // <group>
00048   void fromRecord(const RecordInterface& record);
00049   Record toRecord() const;
00050   // </group>
00051 
00052 
00053   // Convenience methods for returning the standard field values.
00054   // <group>
00055   PMS::ExportRange getExportRange() const { return exportRange_; };
00056   // </group>
00057   
00058   
00059   // Convenience methods for setting the standard field values.
00060   // <group>
00061   void setExportRange(PMS::ExportRange exportRange) {
00062           exportRange_ = exportRange;
00063   };
00064   void setExportRange(String exportRangeStr);
00065   // </group>
00066   
00067   
00068   // Equality operators.
00069   // <group>
00070   bool operator==(const PlotMSExportParam& other) const;
00071   bool operator!=(const PlotMSExportParam& other) const {
00072     return !(operator==(other)); }
00073   // </group>
00074 
00075   // Print out a summary
00076   String summary() const;
00077 
00078   // Sets the default values.
00079   void setDefaults();
00080   
00081 private:
00082 
00083   // The export range
00084   PMS::ExportRange exportRange_;
00085   static const String EXPORT_RANGE;
00086 };
00087 
00088 }
00089 
00090 #endif /* PLOTMSEXPORTPARAM_H_ */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1