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::PlotMSIterParam Class Reference

Specifies iteration parameters for plotms. More...

#include <PlotMSIterParam.h>

Public Member Functions

 PlotMSIterParam ()
 Static //. More...
 
 ~PlotMSIterParam ()
 Destructor. More...
 
void fromRecord (const casacore::RecordInterface &record)
 Converts this object to/from a record. More...
 
casacore::Record toRecord () const
 
PMS::Axis iterAxis () const
 Convenience methods for returning the standard field values. More...
 
casacore::String iterAxisStr () const
 
casacore::Bool isCommonAxisX () const
 
casacore::Bool isCommonAxisY () const
 
casacore::Bool isGlobalAxisX () const
 
casacore::Bool isGlobalAxisY () const
 
casacore::Int getGridRow () const
 
casacore::Int getGridCol () const
 
void setIterAxis (PMS::Axis iterAxis)
 Convenience methods for setting the standard field values. More...
 
void setIterAxis (casacore::String iterAxisStr)
 
void setCommonAxisX (casacore::Bool commonAxisX)
 
void setCommonAxisY (casacore::Bool commonAxisY)
 
void setGlobalScaleX (casacore::Bool globalAxisX)
 
void setGlobalScaleY (casacore::Bool globalAxisY)
 
void setGridRow (casacore::Int nx)
 
void setGridCol (casacore::Int ny)
 
bool isIteration () const
 
bool operator== (const PlotMSIterParam &other) const
 Equality operators. More...
 
bool operator!= (const PlotMSIterParam &other) const
 
casacore::String summary () const
 Print out a summary. More...
 
void setDefaults ()
 Sets the default values. More...
 

Private Attributes

PMS::Axis iterAxis_
 The Iteration axis. More...
 
casacore::Bool globalScaleX_
 global scale X and Y axes More...
 
casacore::Bool globalScaleY_
 
casacore::Bool commonAxisX_
 Whether to use a common axis when the grid consists of multiple plots and the axis has a global scale. More...
 
casacore::Bool commonAxisY_
 
casacore::Int gridRow
 The location of the plot in rows and columns. More...
 
casacore::Int gridCol
 

Static Private Attributes

static const casacore::String ITER_AXIS
 
static const casacore::String GLOBAL_SCALE_X
 
static const casacore::String GLOBAL_SCALE_Y
 
static const casacore::String COMMON_AXIS_X
 
static const casacore::String COMMON_AXIS_Y
 
static const casacore::String ROW_INDEX
 
static const casacore::String COL_INDEX
 

Detailed Description

Specifies iteration parameters for plotms.

Definition at line 35 of file PlotMSIterParam.h.

Constructor & Destructor Documentation

casa::PlotMSIterParam::PlotMSIterParam ( )

Static //.

None

Non-Static //

Constructor, which uses default values.

casa::PlotMSIterParam::~PlotMSIterParam ( )

Destructor.

Member Function Documentation

void casa::PlotMSIterParam::fromRecord ( const casacore::RecordInterface &  record)

Converts this object to/from a record.

Each field will have a key that is its enum name

casacore::Int casa::PlotMSIterParam::getGridCol ( ) const
inline

Definition at line 67 of file PlotMSIterParam.h.

References gridCol.

Referenced by casa::PMS_PP_Iteration::getGridCol().

casacore::Int casa::PlotMSIterParam::getGridRow ( ) const
inline

Definition at line 66 of file PlotMSIterParam.h.

References gridRow.

Referenced by casa::PMS_PP_Iteration::getGridRow().

casacore::Bool casa::PlotMSIterParam::isCommonAxisX ( ) const
inline

Definition at line 62 of file PlotMSIterParam.h.

References commonAxisX_.

Referenced by casa::PMS_PP_Iteration::isCommonAxisX().

casacore::Bool casa::PlotMSIterParam::isCommonAxisY ( ) const
inline

Definition at line 63 of file PlotMSIterParam.h.

References commonAxisY_.

Referenced by casa::PMS_PP_Iteration::isCommonAxisY().

casacore::Bool casa::PlotMSIterParam::isGlobalAxisX ( ) const
inline

Definition at line 64 of file PlotMSIterParam.h.

References globalScaleX_.

Referenced by casa::PMS_PP_Iteration::isGlobalScaleX().

casacore::Bool casa::PlotMSIterParam::isGlobalAxisY ( ) const
inline

Definition at line 65 of file PlotMSIterParam.h.

References globalScaleY_.

Referenced by casa::PMS_PP_Iteration::isGlobalScaleY().

bool casa::PlotMSIterParam::isIteration ( ) const
PMS::Axis casa::PlotMSIterParam::iterAxis ( ) const
inline

Convenience methods for returning the standard field values.

Definition at line 60 of file PlotMSIterParam.h.

References iterAxis_.

Referenced by casa::PMS_PP_Iteration::iterationAxis(), and setIterAxis().

casacore::String casa::PlotMSIterParam::iterAxisStr ( ) const
inline

Definition at line 61 of file PlotMSIterParam.h.

References casa::PMS::axis, and iterAxis_.

bool casa::PlotMSIterParam::operator!= ( const PlotMSIterParam &  other) const
inline

Definition at line 89 of file PlotMSIterParam.h.

References operator==().

bool casa::PlotMSIterParam::operator== ( const PlotMSIterParam &  other) const

Equality operators.

Referenced by operator!=().

void casa::PlotMSIterParam::setCommonAxisX ( casacore::Bool  commonAxisX)
inline

Definition at line 76 of file PlotMSIterParam.h.

References commonAxisX_.

Referenced by casa::PMS_PP_Iteration::setCommonAxisX().

void casa::PlotMSIterParam::setCommonAxisY ( casacore::Bool  commonAxisY)
inline

Definition at line 77 of file PlotMSIterParam.h.

References commonAxisY_.

Referenced by casa::PMS_PP_Iteration::setCommonAxisY().

void casa::PlotMSIterParam::setDefaults ( )

Sets the default values.

void casa::PlotMSIterParam::setGlobalScaleX ( casacore::Bool  globalAxisX)
inline

Definition at line 78 of file PlotMSIterParam.h.

References globalScaleX_.

Referenced by casa::PMS_PP_Iteration::setGlobalScaleX().

void casa::PlotMSIterParam::setGlobalScaleY ( casacore::Bool  globalAxisY)
inline

Definition at line 79 of file PlotMSIterParam.h.

References globalScaleY_.

Referenced by casa::PMS_PP_Iteration::setGlobalScaleY().

void casa::PlotMSIterParam::setGridCol ( casacore::Int  ny)
inline

Definition at line 81 of file PlotMSIterParam.h.

References gridCol, and casacore::max().

Referenced by casa::PMS_PP_Iteration::setGridCol().

void casa::PlotMSIterParam::setGridRow ( casacore::Int  nx)
inline

Definition at line 80 of file PlotMSIterParam.h.

References gridRow, and casacore::max().

Referenced by casa::PMS_PP_Iteration::setGridRow().

void casa::PlotMSIterParam::setIterAxis ( PMS::Axis  iterAxis)
inline

Convenience methods for setting the standard field values.

Definition at line 74 of file PlotMSIterParam.h.

References iterAxis(), and iterAxis_.

Referenced by casa::PMS_PP_Iteration::setIterationAxis().

void casa::PlotMSIterParam::setIterAxis ( casacore::String  iterAxisStr)
inline

Definition at line 75 of file PlotMSIterParam.h.

References casa::PMS::axis, and iterAxis_.

casacore::String casa::PlotMSIterParam::summary ( ) const

Print out a summary.

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

Member Data Documentation

const casacore::String casa::PlotMSIterParam::COL_INDEX
staticprivate

Definition at line 121 of file PlotMSIterParam.h.

const casacore::String casa::PlotMSIterParam::COMMON_AXIS_X
staticprivate

Definition at line 113 of file PlotMSIterParam.h.

const casacore::String casa::PlotMSIterParam::COMMON_AXIS_Y
staticprivate

Definition at line 114 of file PlotMSIterParam.h.

casacore::Bool casa::PlotMSIterParam::commonAxisX_
private

Whether to use a common axis when the grid consists of multiple plots and the axis has a global scale.

Definition at line 112 of file PlotMSIterParam.h.

Referenced by isCommonAxisX(), and setCommonAxisX().

casacore::Bool casa::PlotMSIterParam::commonAxisY_
private

Definition at line 112 of file PlotMSIterParam.h.

Referenced by isCommonAxisY(), and setCommonAxisY().

const casacore::String casa::PlotMSIterParam::GLOBAL_SCALE_X
staticprivate

Definition at line 107 of file PlotMSIterParam.h.

const casacore::String casa::PlotMSIterParam::GLOBAL_SCALE_Y
staticprivate

Definition at line 108 of file PlotMSIterParam.h.

casacore::Bool casa::PlotMSIterParam::globalScaleX_
private

global scale X and Y axes

Definition at line 106 of file PlotMSIterParam.h.

Referenced by isGlobalAxisX(), and setGlobalScaleX().

casacore::Bool casa::PlotMSIterParam::globalScaleY_
private

Definition at line 106 of file PlotMSIterParam.h.

Referenced by isGlobalAxisY(), and setGlobalScaleY().

casacore::Int casa::PlotMSIterParam::gridCol
private

Definition at line 119 of file PlotMSIterParam.h.

Referenced by getGridCol(), and setGridCol().

casacore::Int casa::PlotMSIterParam::gridRow
private

The location of the plot in rows and columns.

Definition at line 118 of file PlotMSIterParam.h.

Referenced by getGridRow(), and setGridRow().

const casacore::String casa::PlotMSIterParam::ITER_AXIS
staticprivate

Definition at line 103 of file PlotMSIterParam.h.

PMS::Axis casa::PlotMSIterParam::iterAxis_
private

The Iteration axis.

Definition at line 102 of file PlotMSIterParam.h.

Referenced by iterAxis(), iterAxisStr(), and setIterAxis().

const casacore::String casa::PlotMSIterParam::ROW_INDEX
staticprivate

Definition at line 120 of file PlotMSIterParam.h.

The documentation for this class was generated from the following file:
Generated on Sun Sep 1 2019 23:33:20 for casa by   doxygen 1.8.5