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:
casa::PlotMSPlotParameters::Group

List of all members.

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.
PMS_PP_Iterationoperator= (const PMS_PP_Iteration &other)
 Implemented Methods //.
PMS_PP_Iterationoperator= (const Group &other)
bool operator== (const Group &other) const
bool isIteration () const
 Returns whether or not we are iterating on an axis.
const PlotMSIterParamiterParam () 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)
Bool isCommonAxisX () const
void setCommonAxisX (bool commonAxis)
Bool isCommonAxisY () const
void setCommonAxisY (bool commonAxis)
Bool isGlobalScaleX () const
void setGlobalScaleX (bool globalAxis)
Bool isGlobalScaleY () const
void setGlobalScaleY (bool globalAxis)

Private Member Functions

PMS_PP_Iterationassign (const PMS_PP_Iteration *o)
 Does the work for the operator=()s.
void setDefaults ()

Private Attributes

PlotMSIterParam itsIterParam_

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 1413 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 [inline, virtual]

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1429 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.

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

Definition at line 1494 of file PlotMSPlotParameterGroups.h.

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

Referenced by setGridCol().

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

Definition at line 1484 of file PlotMSPlotParameterGroups.h.

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

Referenced by setGridRow().

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

Definition at line 1504 of file PlotMSPlotParameterGroups.h.

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

Referenced by setCommonAxisX().

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

Definition at line 1523 of file PlotMSPlotParameterGroups.h.

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

Referenced by setCommonAxisY().

Bool casa::PMS_PP_Iteration::isGlobalScaleX (  )  const [inline]
Bool casa::PMS_PP_Iteration::isGlobalScaleY (  )  const [inline]
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 1472 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 1462 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 1434 of file PlotMSPlotParameterGroups.h.

References String, and casa::PMS_PP::UPDATE_ITERATION_NAME.

PMS_PP_Iteration& casa::PMS_PP_Iteration::operator= ( const Group &  other  ) 
PMS_PP_Iteration& casa::PMS_PP_Iteration::operator= ( const PMS_PP_Iteration other  )  [virtual]

Implemented Methods //.

Copy operator. Should probably be overridden by children to be more efficient. Only copies if the two groups have the same name.

Reimplemented from casa::PlotMSPlotParameters::Group.

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

void casa::PMS_PP_Iteration::setCommonAxisX ( bool  commonAxis  )  [inline]
void casa::PMS_PP_Iteration::setCommonAxisY ( bool  commonAxis  )  [inline]
void casa::PMS_PP_Iteration::setDefaults (  )  [private]
void casa::PMS_PP_Iteration::setGlobalScaleX ( bool  globalAxis  )  [inline]
void casa::PMS_PP_Iteration::setGlobalScaleY ( bool  globalAxis  )  [inline]
void casa::PMS_PP_Iteration::setGridCol ( const int &  value  )  [inline]
void casa::PMS_PP_Iteration::setGridRow ( const int &  value  )  [inline]
void casa::PMS_PP_Iteration::setIterationAxis ( const PMS::Axis &  value  )  [inline]
void casa::PMS_PP_Iteration::setIterParam ( PlotMSIterParam  iterparam  )  [inline]
Record casa::PMS_PP_Iteration::toRecord (  )  const [virtual]

Returns a Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.


Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1