Subclass of PlotMSPlotParameters::Group to handle iteration parameters. More...

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Iteration:

Public Types
enum	AxisScaleMode { GLOBAL, SELF }
Public Member Functions
	PMS_PP_Iteration (PlotFactoryPtr factory)
	PMS_PP_Iteration (const PMS_PP_Iteration &copy)
	~PMS_PP_Iteration ()
Group *	clone () const
	Abstract Methods //.
const String &	name () const
	Returns the name of this group of subparameters.
Record	toRecord () const
	Returns a Record representing this group of subparameters.
void	fromRecord (const Record &record)
	Sets the values for this group of subparameters using the given Record.
bool	requiresRedrawOnChange () const
	Returns true if the plot needs to be redrawn when subpamarameters in this group have changed, false otherwise.
Group &	operator= (const Group &other)
bool	operator== (const Group &other) const
const PlotMSIterParam &	iterParam () const
void	setIterParam (PlotMSIterParam iterparam)
PMS::Axis	iterationAxis () const
void	setIterationAxis (const PMS::Axis &value)
int	numRows () const
void	setNumRows (const int &value)
int	numColumns () const
void	setNumColumns (const int &value)
Bool	globalXRange () const
Bool	globalYRange () const
	return itsXAxisScaleMode_==PMS_PP_Iteration::GLOBAL; };
AxisScaleMode	xAxisScaleMode () const
	return itsYAxisScaleMode_==PMS_PP_Iteration::GLOBAL; };
void	setXAxisScaleMode (AxisScaleMode value)
AxisScaleMode	yAxisScaleMode () const
void	setYAxisScaleMode (AxisScaleMode value)
Private Member Functions
void	setDefaults ()
Private Attributes
PlotMSIterParam	itsIterParam_
int	itsNumRows_
int	itsNumColumns_
Static Private Attributes
static const String	REC_ITERPARAM
static const String	REC_ITERATIONAXIS
static const String	REC_NUMROWS
static const String	REC_NUMCOLUMNS
static const String	REC_XAXISSCALEMODE
static const String	REC_YAXISSCALEMODE

Detailed Description

Subclass of PlotMSPlotParameters::Group to handle iteration parameters.

Currently includes: which axis to use rows, columns to fit onto each page Parameters apply to whole set of plots

Definition at line 1236 of file PlotMSPlotParameterGroups.h.

Member Enumeration Documentation

enum casa::PMS_PP_Iteration::AxisScaleMode

Enumerator:

GLOBAL
SELF

Definition at line 1241 of file PlotMSPlotParameterGroups.h.

Constructor & Destructor Documentation

casa::PMS_PP_Iteration::PMS_PP_Iteration ( PlotFactoryPtr factory )

Referenced by clone().

casa::PMS_PP_Iteration::PMS_PP_Iteration ( const PMS_PP_Iteration & copy )

casa::PMS_PP_Iteration::~PMS_PP_Iteration ( )

Member Function Documentation

Group* casa::PMS_PP_Iteration::clone ( ) const [inline, virtual]

Abstract Methods //.

Returns a clone (deep copy) of this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1257 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Iteration().

void casa::PMS_PP_Iteration::fromRecord ( const Record & record ) [virtual]

Sets the values for this group of subparameters using the given Record.

Implements casa::PlotMSPlotParameters::Group.

Bool casa::PMS_PP_Iteration::globalXRange ( ) const [inline]

Definition at line 1342 of file PlotMSPlotParameterGroups.h.

References itsIterParam_, and casa::PlotMSIterParam::xSelfScale().

Bool casa::PMS_PP_Iteration::globalYRange ( ) const [inline]

return itsXAxisScaleMode_==PMS_PP_Iteration::GLOBAL; };

Definition at line 1347 of file PlotMSPlotParameterGroups.h.

References itsIterParam_, and casa::PlotMSIterParam::ySelfScale().

PMS::Axis casa::PMS_PP_Iteration::iterationAxis ( ) const [inline]

return itsIterationAxis_;

Definition at line 1307 of file PlotMSPlotParameterGroups.h.

References casa::PlotMSIterParam::iterAxis(), and itsIterParam_.

Referenced by setIterationAxis().

const PlotMSIterParam& casa::PMS_PP_Iteration::iterParam ( ) const [inline]

Definition at line 1297 of file PlotMSPlotParameterGroups.h.

References itsIterParam_.

const String& casa::PMS_PP_Iteration::name ( ) const [inline, virtual]

Returns the name of this group of subparameters.

Will be used as an update flag.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1262 of file PlotMSPlotParameterGroups.h.

References casa::PMS_PP::UPDATE_ITERATION_NAME.

int casa::PMS_PP_Iteration::numColumns ( ) const [inline]

Definition at line 1332 of file PlotMSPlotParameterGroups.h.

References itsIterParam_, and casa::PlotMSIterParam::Nx().

Referenced by setNumColumns().

int casa::PMS_PP_Iteration::numRows ( ) const [inline]

Definition at line 1322 of file PlotMSPlotParameterGroups.h.

References itsIterParam_, and casa::PlotMSIterParam::Ny().

Referenced by setNumRows().

Group& casa::PMS_PP_Iteration::operator= ( const Group & other )

bool casa::PMS_PP_Iteration::operator== ( const Group & other ) const

bool casa::PMS_PP_Iteration::requiresRedrawOnChange ( ) const [inline, virtual]

Returns true if the plot needs to be redrawn when subpamarameters in this group have changed, false otherwise.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1274 of file PlotMSPlotParameterGroups.h.

void casa::PMS_PP_Iteration::setDefaults ( ) [private]

void casa::PMS_PP_Iteration::setIterationAxis ( const PMS::Axis & value ) [inline]

if (itsIterationAxis_ != value) { itsIterationAxis_ = value;

Definition at line 1312 of file PlotMSPlotParameterGroups.h.

References iterationAxis(), itsIterParam_, casa::PlotMSIterParam::setIterAxis(), and casa::PlotMSPlotParameters::Group::updated().

void casa::PMS_PP_Iteration::setIterParam ( PlotMSIterParam iterparam ) [inline]

Definition at line 1300 of file PlotMSPlotParameterGroups.h.

References itsIterParam_, and casa::PlotMSPlotParameters::Group::updated().

void casa::PMS_PP_Iteration::setNumColumns ( const int & value ) [inline]

Definition at line 1335 of file PlotMSPlotParameterGroups.h.

References itsIterParam_, numColumns(), casa::PlotMSIterParam::setNx(), and casa::PlotMSPlotParameters::Group::updated().

void casa::PMS_PP_Iteration::setNumRows ( const int & value ) [inline]

Definition at line 1325 of file PlotMSPlotParameterGroups.h.

References itsIterParam_, numRows(), casa::PlotMSIterParam::setNy(), and casa::PlotMSPlotParameters::Group::updated().

void casa::PMS_PP_Iteration::setXAxisScaleMode ( AxisScaleMode value ) [inline]

if (itsXAxisScaleMode_ != value) { itsXAxisScaleMode_ = value;

Definition at line 1358 of file PlotMSPlotParameterGroups.h.

References casa::False, GLOBAL, itsIterParam_, SELF, casa::PlotMSIterParam::setXSelfScale(), casa::True, casa::PlotMSPlotParameters::Group::updated(), and xAxisScaleMode().

void casa::PMS_PP_Iteration::setYAxisScaleMode ( AxisScaleMode value ) [inline]

if (itsYAxisScaleMode_ != value) { itsYAxisScaleMode_ = value;

Definition at line 1382 of file PlotMSPlotParameterGroups.h.

References casa::False, GLOBAL, itsIterParam_, SELF, casa::PlotMSIterParam::setYSelfScale(), casa::True, casa::PlotMSPlotParameters::Group::updated(), and yAxisScaleMode().

Record casa::PMS_PP_Iteration::toRecord ( ) const [virtual]

Returns a Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

AxisScaleMode casa::PMS_PP_Iteration::xAxisScaleMode ( ) const [inline]

return itsYAxisScaleMode_==PMS_PP_Iteration::GLOBAL; };

return itsXAxisScaleMode_;

Definition at line 1351 of file PlotMSPlotParameterGroups.h.

References GLOBAL, itsIterParam_, SELF, and casa::PlotMSIterParam::xSelfScale().

Referenced by setXAxisScaleMode().

AxisScaleMode casa::PMS_PP_Iteration::yAxisScaleMode ( ) const [inline]

return itsYAxisScaleMode_;

Definition at line 1375 of file PlotMSPlotParameterGroups.h.

References GLOBAL, itsIterParam_, SELF, and casa::PlotMSIterParam::ySelfScale().

Referenced by setYAxisScaleMode().

Member Data Documentation

PlotMSIterParam casa::PMS_PP_Iteration::itsIterParam_ [private]

Definition at line 1400 of file PlotMSPlotParameterGroups.h.

Referenced by globalXRange(), globalYRange(), iterationAxis(), iterParam(), numColumns(), numRows(), setIterationAxis(), setIterParam(), setNumColumns(), setNumRows(), setXAxisScaleMode(), setYAxisScaleMode(), xAxisScaleMode(), and yAxisScaleMode().

int casa::PMS_PP_Iteration::itsNumColumns_ [private]

Definition at line 1408 of file PlotMSPlotParameterGroups.h.

int casa::PMS_PP_Iteration::itsNumRows_ [private]

Definition at line 1407 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Iteration::REC_ITERATIONAXIS [static, private]

Definition at line 1412 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Iteration::REC_ITERPARAM [static, private]

Definition at line 1411 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Iteration::REC_NUMCOLUMNS [static, private]

Definition at line 1414 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Iteration::REC_NUMROWS [static, private]

Definition at line 1413 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Iteration::REC_XAXISSCALEMODE [static, private]

Definition at line 1415 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Iteration::REC_YAXISSCALEMODE [static, private]

Definition at line 1416 of file PlotMSPlotParameterGroups.h.

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

code/plotms/Plots/PlotMSPlotParameterGroups.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation