casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | Static Private Attributes | List of all members
casa::PlotMSExportParam Class Reference

Specifies export parameters for plotms. More...

#include <PlotMSExportParam.h>

Public Member Functions

 PlotMSExportParam ()
 Constructor, which uses default values. More...
 
 ~PlotMSExportParam ()
 Destructor. More...
 
void fromRecord (const casacore::RecordInterface &record)
 Converts this object to/from a record. More...
 
casacore::Record toRecord () const
 
PMS::ExportRange getExportRange () const
 Convenience methods for returning the standard field values. More...
 
void setExportRange (PMS::ExportRange exportRange)
 Convenience methods for setting the standard field values. More...
 
void setExportRange (casacore::String exportRangeStr)
 
bool operator== (const PlotMSExportParam &other) const
 Equality operators. More...
 
bool operator!= (const PlotMSExportParam &other) const
 
casacore::String summary () const
 Print out a summary. More...
 
void setDefaults ()
 Sets the default values. More...
 

Private Attributes

PMS::ExportRange exportRange_
 The export range. More...
 

Static Private Attributes

static const casacore::String EXPORT_RANGE
 

Detailed Description

Specifies export parameters for plotms.

Definition at line 35 of file PlotMSExportParam.h.

Constructor & Destructor Documentation

casa::PlotMSExportParam::PlotMSExportParam ( )

Constructor, which uses default values.

casa::PlotMSExportParam::~PlotMSExportParam ( )

Destructor.

Member Function Documentation

void casa::PlotMSExportParam::fromRecord ( const casacore::RecordInterface record)

Converts this object to/from a record.

Each field will have a key that is its enum name

PMS::ExportRange casa::PlotMSExportParam::getExportRange ( ) const
inline

Convenience methods for returning the standard field values.

Definition at line 55 of file PlotMSExportParam.h.

References exportRange_.

bool casa::PlotMSExportParam::operator!= ( const PlotMSExportParam other) const
inline

Definition at line 71 of file PlotMSExportParam.h.

References operator==().

bool casa::PlotMSExportParam::operator== ( const PlotMSExportParam other) const

Equality operators.

Referenced by operator!=().

void casa::PlotMSExportParam::setDefaults ( )

Sets the default values.

void casa::PlotMSExportParam::setExportRange ( PMS::ExportRange  exportRange)
inline

Convenience methods for setting the standard field values.

Definition at line 61 of file PlotMSExportParam.h.

References exportRange_.

void casa::PlotMSExportParam::setExportRange ( casacore::String  exportRangeStr)
casacore::String casa::PlotMSExportParam::summary ( ) const

Print out a summary.

casacore::Record casa::PlotMSExportParam::toRecord ( ) const

Member Data Documentation

const casacore::String casa::PlotMSExportParam::EXPORT_RANGE
staticprivate

Definition at line 85 of file PlotMSExportParam.h.

PMS::ExportRange casa::PlotMSExportParam::exportRange_
private

The export range.

Definition at line 84 of file PlotMSExportParam.h.

Referenced by getExportRange(), and setExportRange().


The documentation for this class was generated from the following file: