casa::PlotMSIterParam Class Reference

Specifies iteration parameters for plotms. More...

#include <PlotMSIterParam.h>

List of all members.

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	xSelfScale () const
Bool	ySelfScale () const
Int	Nx () const
Int	Ny () const
void	setIterAxis (PMS::Axis iterAxis)
	Convenience methods for setting the standard field values.
void	setIterAxis (String iterAxisStr)
void	setXSelfScale (Bool xSelfScale)
void	setYSelfScale (Bool ySelfScale)
void	setNx (Int nx)
void	setNy (Int ny)
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	xSelfScale_
	Self-scale the X and Y axes.
Bool	ySelfScale_
Int	Nx_
	The number of plots in X and Y.
Int	Ny_

---

Detailed Description

Specifies iteration parameters for plotms.

Definition at line 37 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

PMS::Axis casa::PlotMSIterParam::iterAxis

(

)

const [inline]

Convenience methods for returning the standard field values.

Definition at line 62 of file PlotMSIterParam.h.

References iterAxis_.

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

String casa::PlotMSIterParam::iterAxisStr

(

)

const [inline]

Definition at line 63 of file PlotMSIterParam.h.

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

Int casa::PlotMSIterParam::Nx

(

)

const [inline]

Definition at line 66 of file PlotMSIterParam.h.

References Nx_.

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

Int casa::PlotMSIterParam::Ny

(

)

const [inline]

Definition at line 67 of file PlotMSIterParam.h.

References Ny_.

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

bool casa::PlotMSIterParam::operator!=

(

const PlotMSIterParam &

other

)

const [inline]

Definition at line 85 of file PlotMSIterParam.h.

References operator==().

bool casa::PlotMSIterParam::operator==

(

const PlotMSIterParam &

other

)

const

Equality operators.

Referenced by operator!=().

void casa::PlotMSIterParam::setDefaults

(

)

Sets the default values.

void casa::PlotMSIterParam::setIterAxis

(

PMS::Axis

iterAxis

)

[inline]

Convenience methods for setting the standard field values.

Definition at line 73 of file PlotMSIterParam.h.

References iterAxis(), and iterAxis_.

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

void casa::PlotMSIterParam::setIterAxis

(

String

iterAxisStr

)

[inline]

Definition at line 74 of file PlotMSIterParam.h.

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

void casa::PlotMSIterParam::setNx

(

Int

nx

)

[inline]

Definition at line 77 of file PlotMSIterParam.h.

References casa::max(), and Nx_.

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

void casa::PlotMSIterParam::setNy

(

Int

ny

)

[inline]

Definition at line 78 of file PlotMSIterParam.h.

References casa::max(), and Ny_.

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

void casa::PlotMSIterParam::setXSelfScale

(

Bool

xSelfScale

)

[inline]

Definition at line 75 of file PlotMSIterParam.h.

References xSelfScale(), and xSelfScale_.

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

void casa::PlotMSIterParam::setYSelfScale

(

Bool

ySelfScale

)

[inline]

Definition at line 76 of file PlotMSIterParam.h.

References ySelfScale(), and ySelfScale_.

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

String casa::PlotMSIterParam::summary

(

)

const

Print out a summary.

Record casa::PlotMSIterParam::toRecord

(

)

const

Bool casa::PlotMSIterParam::xSelfScale

(

)

const [inline]

Definition at line 64 of file PlotMSIterParam.h.

References xSelfScale_.

Referenced by casa::PMS_PP_Iteration::globalXRange(), setXSelfScale(), and casa::PMS_PP_Iteration::xAxisScaleMode().

Bool casa::PlotMSIterParam::ySelfScale

(

)

const [inline]

Definition at line 65 of file PlotMSIterParam.h.

References ySelfScale_.

Referenced by casa::PMS_PP_Iteration::globalYRange(), setYSelfScale(), and casa::PMS_PP_Iteration::yAxisScaleMode().

---

Member Data Documentation

PMS::Axis casa::PlotMSIterParam::iterAxis_ [private]

The Iteration axis.

Definition at line 98 of file PlotMSIterParam.h.

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

Int casa::PlotMSIterParam::Nx_ [private]

The number of plots in X and Y.

Definition at line 104 of file PlotMSIterParam.h.

Referenced by Nx(), and setNx().

Int casa::PlotMSIterParam::Ny_ [private]

Definition at line 104 of file PlotMSIterParam.h.

Referenced by Ny(), and setNy().

Bool casa::PlotMSIterParam::xSelfScale_ [private]

Self-scale the X and Y axes.

Definition at line 101 of file PlotMSIterParam.h.

Referenced by setXSelfScale(), and xSelfScale().

Bool casa::PlotMSIterParam::ySelfScale_ [private]

Definition at line 101 of file PlotMSIterParam.h.

Referenced by setYSelfScale(), and ySelfScale().

---

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

• code/plotms/PlotMS/PlotMSIterParam.h