casa::PlotMSIterParam Class Reference

Specifies iteration parameters for plotms. More...

#include <PlotMSIterParam.h>

Public Member Functions
	PlotMSIterParam ()
	Static //.
	~PlotMSIterParam ()
	Destructor.
void	fromRecord (const RecordInterface &record)
	Converts this object to/from a record.
Record	toRecord () const
PMS::Axis	iterAxis () const
	Convenience methods for returning the standard field values.
String	iterAxisStr () const
Bool	isCommonAxisX () const
Bool	isCommonAxisY () const
Bool	isGlobalAxisX () const
Bool	isGlobalAxisY () const
Int	getGridRow () const
Int	getGridCol () const
void	setIterAxis (PMS::Axis iterAxis)
	Convenience methods for setting the standard field values.
void	setIterAxis (String iterAxisStr)
void	setCommonAxisX (Bool commonAxisX)
void	setCommonAxisY (Bool commonAxisY)
void	setGlobalScaleX (Bool globalAxisX)
void	setGlobalScaleY (Bool globalAxisY)
void	setGridRow (Int nx)
void	setGridCol (Int ny)
bool	isIteration () const
bool	operator== (const PlotMSIterParam &other) const
	Equality operators.
bool	operator!= (const PlotMSIterParam &other) const
String	summary () const
	Print out a summary.
void	setDefaults ()
	Sets the default values.
Private Attributes
PMS::Axis	iterAxis_
	The Iteration axis.
Bool	globalScaleX_
	global scale X and Y axes
Bool	globalScaleY_
Bool	commonAxisX_
	Whether to use a common axis when the grid consists of multiple plots and the axis has a global scale.
Bool	commonAxisY_
Int	gridRow
	The location of the plot in rows and columns.
Int	gridCol
Static Private Attributes
static const String	ITER_AXIS
static const String	GLOBAL_SCALE_X
static const String	GLOBAL_SCALE_Y
static const String	COMMON_AXIS_X
static const String	COMMON_AXIS_Y
static const String	ROW_INDEX
static const 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 RecordInterface & record )

Converts this object to/from a record.

Each field will have a key that is its enum name

Int casa::PlotMSIterParam::getGridCol ( ) const [inline]

Definition at line 67 of file PlotMSIterParam.h.

References gridCol.

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

Int casa::PlotMSIterParam::getGridRow ( ) const [inline]

Definition at line 66 of file PlotMSIterParam.h.

References gridRow.

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

Bool casa::PlotMSIterParam::isCommonAxisX ( ) const [inline]

Definition at line 62 of file PlotMSIterParam.h.

References commonAxisX_.

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

Bool casa::PlotMSIterParam::isCommonAxisY ( ) const [inline]

Definition at line 63 of file PlotMSIterParam.h.

References commonAxisY_.

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

Bool casa::PlotMSIterParam::isGlobalAxisX ( ) const [inline]

Definition at line 64 of file PlotMSIterParam.h.

References globalScaleX_.

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

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().

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 ( Bool commonAxisX ) [inline]

Definition at line 76 of file PlotMSIterParam.h.

References commonAxisX_.

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

void casa::PlotMSIterParam::setCommonAxisY ( 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 ( Bool globalAxisX ) [inline]

Definition at line 78 of file PlotMSIterParam.h.

References globalScaleX_.

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

void casa::PlotMSIterParam::setGlobalScaleY ( Bool globalAxisY ) [inline]

Definition at line 79 of file PlotMSIterParam.h.

References globalScaleY_.

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

void casa::PlotMSIterParam::setGridCol ( 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 ( 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 ( String iterAxisStr ) [inline]

Definition at line 75 of file PlotMSIterParam.h.

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

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_.

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

String casa::PlotMSIterParam::summary ( ) const

Print out a summary.

Record casa::PlotMSIterParam::toRecord ( ) const

Member Data Documentation

const String casa::PlotMSIterParam::COL_INDEX [static, private]

Definition at line 121 of file PlotMSIterParam.h.

const String casa::PlotMSIterParam::COMMON_AXIS_X [static, private]

Definition at line 113 of file PlotMSIterParam.h.

const String casa::PlotMSIterParam::COMMON_AXIS_Y [static, private]

Definition at line 114 of file PlotMSIterParam.h.

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().

Bool casa::PlotMSIterParam::commonAxisY_ [private]

Definition at line 112 of file PlotMSIterParam.h.

Referenced by isCommonAxisY(), and setCommonAxisY().

const String casa::PlotMSIterParam::GLOBAL_SCALE_X [static, private]

Definition at line 107 of file PlotMSIterParam.h.

const String casa::PlotMSIterParam::GLOBAL_SCALE_Y [static, private]

Definition at line 108 of file PlotMSIterParam.h.

Bool casa::PlotMSIterParam::globalScaleX_ [private]

global scale X and Y axes

Definition at line 106 of file PlotMSIterParam.h.

Referenced by isGlobalAxisX(), and setGlobalScaleX().

Bool casa::PlotMSIterParam::globalScaleY_ [private]

Definition at line 106 of file PlotMSIterParam.h.

Referenced by isGlobalAxisY(), and setGlobalScaleY().

Int casa::PlotMSIterParam::gridCol [private]

Definition at line 119 of file PlotMSIterParam.h.

Referenced by getGridCol(), and setGridCol().

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 String casa::PlotMSIterParam::ITER_AXIS [static, private]

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 String casa::PlotMSIterParam::ROW_INDEX [static, private]

Definition at line 120 of file PlotMSIterParam.h.

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

code/plotms/PlotMS/PlotMSIterParam.h

casa::PlotMSIterParam Class Reference

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation