casa::PMS_PP_Iteration Class Reference

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

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Iteration:

Public Member Functions
	PMS_PP_Iteration (PlotFactoryPtr factory)
	PMS_PP_Iteration (const PMS_PP_Iteration &copy)
	~PMS_PP_Iteration ()
Group *	clone () const
	Abstract Methods //. More...
const casacore::String &	name () const
	Returns the name of this group of subparameters. More...
casacore::Record	toRecord () const
	Returns a casacore::Record representing this group of subparameters. More...
void	fromRecord (const casacore::Record &record)
	Sets the values for this group of subparameters using the given Record. More...
bool	requiresRedrawOnChange () const
	Returns true if the plot needs to be redrawn when subpamarameters in this group have changed, false otherwise. More...
PMS_PP_Iteration &	operator= (const PMS_PP_Iteration &other)
PMS_PP_Iteration &	operator= (const Group &other)
bool	operator== (const Group &other) const
bool	isIteration () const
	Returns whether or not we are iterating on an axis. More...
const PlotMSIterParam &	iterParam () const
void	setIterParam (PlotMSIterParam iterparam)
PMS::Axis	iterationAxis () const
void	setIterationAxis (const PMS::Axis &value)
int	getGridRow () const
void	setGridRow (const int &value)
int	getGridCol () const
void	setGridCol (const int &value)
casacore::Bool	isCommonAxisX () const
void	setCommonAxisX (bool commonAxis)
casacore::Bool	isCommonAxisY () const
void	setCommonAxisY (bool commonAxis)
casacore::Bool	isGlobalScaleX () const
void	setGlobalScaleX (bool globalAxis)
casacore::Bool	isGlobalScaleY () const
void	setGlobalScaleY (bool globalAxis)
Public Member Functions inherited from casa::PlotMSPlotParameters::Group
	Group (PlotFactoryPtr factory)
	Constructor which takes a plot factory. More...
	Group (const Group &copy)
	Copy constructor. More...
virtual	~Group ()
	Destructor. More...
virtual Group &	operator= (const Group &other)
	Implemented Methods //. More...
virtual bool	operator== (const Group &other) const
	Equality operators. More...
virtual bool	operator!= (const Group &other) const

Private Member Functions
PMS_PP_Iteration &	assign (const PMS_PP_Iteration *o)
	Does the work for the operator=()s. More...
void	setDefaults ()

Private Attributes
PlotMSIterParam	itsIterParam_

Additional Inherited Members
Static Public Member Functions inherited from casa::PlotMSPlotParameters::Group
static void	notifyWatchers (void *obj, bool wasCanceled)
	Post-thread method for notifying watchers that this group has changed. More...
Protected Member Functions inherited from casa::PlotMSPlotParameters::Group
void	updated ()
	Should be called by the child class whenever any of the subparameter values have been updated. More...
void	updated (bool requiresRedraw)
PlotMSPlotParameters *	parent ()
	Returns the parent parameters, or NULL for none. More...
const PlotMSPlotParameters *	parent () const
PlotFactoryPtr	factory ()
	Returns the factory. More...
const PlotFactoryPtr	factory () const

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 1710 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

PMS_PP_Iteration& casa::PMS_PP_Iteration::assign ( const PMS_PP_Iteration *  o )

private

Does the work for the operator=()s.

Group* casa::PMS_PP_Iteration::clone ( ) const

inlinevirtual

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1726 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Iteration().

void casa::PMS_PP_Iteration::fromRecord ( const casacore::Record &  record )

virtual

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

Implements casa::PlotMSPlotParameters::Group.

int casa::PMS_PP_Iteration::getGridCol ( ) const

inline

Definition at line 1791 of file PlotMSPlotParameterGroups.h.

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

Referenced by setGridCol().

int casa::PMS_PP_Iteration::getGridRow ( ) const

inline

Definition at line 1781 of file PlotMSPlotParameterGroups.h.

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

Referenced by setGridRow().

casacore::Bool casa::PMS_PP_Iteration::isCommonAxisX ( ) const

inline

Definition at line 1801 of file PlotMSPlotParameterGroups.h.

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

Referenced by setCommonAxisX().

casacore::Bool casa::PMS_PP_Iteration::isCommonAxisY ( ) const

inline

Definition at line 1820 of file PlotMSPlotParameterGroups.h.

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

Referenced by setCommonAxisY().

casacore::Bool casa::PMS_PP_Iteration::isGlobalScaleX ( ) const

inline

Definition at line 1838 of file PlotMSPlotParameterGroups.h.

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

Referenced by setCommonAxisX(), and setGlobalScaleX().

casacore::Bool casa::PMS_PP_Iteration::isGlobalScaleY ( ) const

inline

Definition at line 1847 of file PlotMSPlotParameterGroups.h.

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

Referenced by setCommonAxisY(), and setGlobalScaleY().

bool casa::PMS_PP_Iteration::isIteration

(

)

const

Returns whether or not we are iterating on an axis.

PMS::Axis casa::PMS_PP_Iteration::iterationAxis ( ) const

inline

Definition at line 1769 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 1759 of file PlotMSPlotParameterGroups.h.

References itsIterParam_.

const casacore::String& casa::PMS_PP_Iteration::name ( ) const

inlinevirtual

Returns the name of this group of subparameters.

Will be used as an update flag.

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1731 of file PlotMSPlotParameterGroups.h.

References casa::PMS_PP::UPDATE_ITERATION_NAME.

PMS_PP_Iteration& casa::PMS_PP_Iteration::operator=

(

const PMS_PP_Iteration &

other

)

PMS_PP_Iteration& 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

inlinevirtual

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 1743 of file PlotMSPlotParameterGroups.h.

void casa::PMS_PP_Iteration::setCommonAxisX ( bool  commonAxis )

inline

Definition at line 1804 of file PlotMSPlotParameterGroups.h.

References isCommonAxisX(), isGlobalScaleX(), itsIterParam_, casa::PlotMSIterParam::setCommonAxisX(), and casa::PlotMSPlotParameters::Group::updated().

void casa::PMS_PP_Iteration::setCommonAxisY ( bool  commonAxis )

inline

Definition at line 1823 of file PlotMSPlotParameterGroups.h.

References isCommonAxisY(), isGlobalScaleY(), itsIterParam_, casa::PlotMSIterParam::setCommonAxisY(), and casa::PlotMSPlotParameters::Group::updated().

void casa::PMS_PP_Iteration::setDefaults ( )

private

void casa::PMS_PP_Iteration::setGlobalScaleX ( bool  globalAxis )

inline

Definition at line 1841 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Iteration::setGlobalScaleY ( bool  globalAxis )

inline

Definition at line 1850 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Iteration::setGridCol ( const int &  value )

inline

Definition at line 1794 of file PlotMSPlotParameterGroups.h.

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

void casa::PMS_PP_Iteration::setGridRow ( const int &  value )

inline

Definition at line 1784 of file PlotMSPlotParameterGroups.h.

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

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

inline

Definition at line 1773 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 1762 of file PlotMSPlotParameterGroups.h.

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

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

virtual

Returns a casacore::Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

Member Data Documentation

PlotMSIterParam casa::PMS_PP_Iteration::itsIterParam_

private

Definition at line 1862 of file PlotMSPlotParameterGroups.h.

Referenced by getGridCol(), getGridRow(), isCommonAxisX(), isCommonAxisY(), isGlobalScaleX(), isGlobalScaleY(), iterationAxis(), iterParam(), setCommonAxisX(), setCommonAxisY(), setGlobalScaleX(), setGlobalScaleY(), setGridCol(), setGridRow(), setIterationAxis(), and setIterParam().

---

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

• casa/code/plotms/Plots/PlotMSPlotParameterGroups.h