casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
casa::PMS_PP_Canvas Class Reference

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

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Canvas:
casa::PlotMSPlotParameters::Group

List of all members.

Public Member Functions

 PMS_PP_Canvas (PlotFactoryPtr factory)
 PMS_PP_Canvas (const PMS_PP_Canvas &copy)
 ~PMS_PP_Canvas ()
Groupclone () const
 Abstract Methods //.
const Stringname () 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.
Groupoperator= (const Group &other)
bool operator== (const Group &other) const
unsigned int numCanvases () const
 Gets how many canvases there are.
void setLabelFormats (const PlotMSLabelFormat &xFormat, const PlotMSLabelFormat &yFormat, unsigned int index=0)
 Sets single versions of the parameters for the given index.
void showAxes (const bool &xShow, const bool &yShow, unsigned int index=0)
void showLegend (const bool &show, const PlotCanvas::LegendPosition &pos, unsigned int index=0)
void showGridMajor (const bool &show, const PlotLinePtr &line, unsigned int index=0)
void showGridMinor (const bool &show, const PlotLinePtr &line, unsigned int index=0)
void showGrid (const bool &showMajor, const bool &showMinor, const PlotLinePtr &majorLine, const PlotLinePtr &minorLine, unsigned int index=0)
const vector< PlotMSLabelFormat > & xLabelFormats () const
 
      

void setXLabelFormats (const vector< PlotMSLabelFormat > &value)
const PlotMSLabelFormatxLabelFormat (unsigned int index=0) const
void setXLabelFormat (const PlotMSLabelFormat &value, unsigned int index=0)
const vector< PlotMSLabelFormat > & yLabelFormats () const
void setYLabelFormats (const vector< PlotMSLabelFormat > &value)
const PlotMSLabelFormatyLabelFormat (unsigned int index=0) const
void setYLabelFormat (const PlotMSLabelFormat &value, unsigned int index=0)
const vector< bool > & xAxesShown () const
void showXAxes (const vector< bool > &value)
bool xAxisShown (unsigned int index=0) const
void showXAxis (const bool &value, unsigned int index=0)
const vector< bool > & yAxesShown () const
void showYAxes (const vector< bool > &value)
bool yAxisShown (unsigned int index=0) const
void showYAxis (const bool &value, unsigned int index=0)
const vector< bool > & legendsShown () const
void showLegends (const vector< bool > &value)
bool legendShown (unsigned int index=0) const
void showLegend (const bool &value, unsigned int index=0)
const vector
< PlotCanvas::LegendPosition > & 
legendPositions () const
void showLegends (const vector< PlotCanvas::LegendPosition > &value)
PlotCanvas::LegendPosition legendPosition (unsigned int index=0) const
void showLegend (const PlotCanvas::LegendPosition &value, unsigned int index=0)
const vector< PlotMSLabelFormat > & titleFormats () const
void setTitleFormats (const vector< PlotMSLabelFormat > &value)
const PlotMSLabelFormattitleFormat (unsigned int index=0) const
void setTitleFormat (const PlotMSLabelFormat &value, unsigned int index=0)
const vector< bool > & gridMajorsShown () const
void showGridMajors (const vector< bool > &value)
bool gridMajorShown (unsigned int index=0) const
void showGridMajor (const bool &value, unsigned int index=0)
const vector< bool > & gridMinorsShown () const
void showGridMinors (const vector< bool > &value)
bool gridMinorShown (unsigned int index=0) const
void showGridMinor (const bool &value, unsigned int index=0)
const vector< PlotLinePtr > & gridMajorLines () const
void setGridMajorLines (const vector< PlotLinePtr > &value)
PlotLinePtr gridMajorLine (unsigned int index=0) const
void setGridMajorLine (const PlotLinePtr &value, unsigned int index=0)
const vector< PlotLinePtr > & gridMinorLines () const
void setGridMinorLines (const vector< PlotLinePtr > &value)
PlotLinePtr gridMinorLine (unsigned int index=0) const
void setGridMinorLine (const PlotLinePtr &value, unsigned int index=0)

Private Member Functions

void setDefaults ()

Private Attributes

vector< PlotMSLabelFormatitsXLabels_
vector< PlotMSLabelFormatitsYLabels_
vector< bool > itsXAxesShown_
vector< bool > itsYAxesShown_
vector< bool > itsLegendsShown_
vector
< PlotCanvas::LegendPosition
itsLegendsPos_
vector< PlotMSLabelFormatitsTitles_
vector< bool > itsGridMajsShown_
vector< bool > itsGridMinsShown_
vector< PlotLinePtritsGridMajLines_
vector< PlotLinePtritsGridMinLines_

Static Private Attributes

static const String REC_XLABELS
static const String REC_YLABELS
static const String REC_SHOWXAXES
static const String REC_SHOWYAXES
static const String REC_SHOWLEGENDS
static const String REC_LEGENDSPOS
static const String REC_TITLES
static const String REC_SHOWGRIDMAJS
static const String REC_SHOWGRIDMINS
static const String REC_GRIDMAJLINES
static const String REC_GRIDMINLINES

Detailed Description

Subclass of PlotMSPlotParameters::Group to handle canvas parameters.

Currently includes: axes label formats whether to show the canvas axes or not whether to show the legend or not, and its position canvas title label format whether to show grid lines, and their properties Parameters are vector-based, on a per-canvas basis.

Definition at line 667 of file PlotMSPlotParameterGroups.h.


Constructor & Destructor Documentation

Referenced by clone().


Member Function Documentation

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

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 679 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Canvas().

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

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

Implements casa::PlotMSPlotParameters::Group.

PlotLinePtr casa::PMS_PP_Canvas::gridMajorLine ( unsigned int  index = 0) const [inline]

Definition at line 956 of file PlotMSPlotParameterGroups.h.

References itsGridMajLines_.

Referenced by showGridMinor().

const vector< PlotLinePtr >& casa::PMS_PP_Canvas::gridMajorLines ( ) const [inline]

Definition at line 947 of file PlotMSPlotParameterGroups.h.

References itsGridMajLines_.

bool casa::PMS_PP_Canvas::gridMajorShown ( unsigned int  index = 0) const [inline]

Definition at line 908 of file PlotMSPlotParameterGroups.h.

References itsGridMajsShown_.

Referenced by showGridMinor().

const vector< bool >& casa::PMS_PP_Canvas::gridMajorsShown ( ) const [inline]

Definition at line 899 of file PlotMSPlotParameterGroups.h.

References itsGridMajsShown_.

PlotLinePtr casa::PMS_PP_Canvas::gridMinorLine ( unsigned int  index = 0) const [inline]

Definition at line 981 of file PlotMSPlotParameterGroups.h.

References itsGridMinLines_.

Referenced by showGridMajor().

const vector< PlotLinePtr >& casa::PMS_PP_Canvas::gridMinorLines ( ) const [inline]

Definition at line 972 of file PlotMSPlotParameterGroups.h.

References itsGridMinLines_.

bool casa::PMS_PP_Canvas::gridMinorShown ( unsigned int  index = 0) const [inline]

Definition at line 932 of file PlotMSPlotParameterGroups.h.

References itsGridMinsShown_.

Referenced by showGridMajor().

const vector< bool >& casa::PMS_PP_Canvas::gridMinorsShown ( ) const [inline]

Definition at line 923 of file PlotMSPlotParameterGroups.h.

References itsGridMinsShown_.

PlotCanvas::LegendPosition casa::PMS_PP_Canvas::legendPosition ( unsigned int  index = 0) const [inline]

Definition at line 861 of file PlotMSPlotParameterGroups.h.

References itsLegendsPos_.

Definition at line 852 of file PlotMSPlotParameterGroups.h.

References itsLegendsPos_.

bool casa::PMS_PP_Canvas::legendShown ( unsigned int  index = 0) const [inline]

Definition at line 837 of file PlotMSPlotParameterGroups.h.

References itsLegendsShown_.

const vector< bool >& casa::PMS_PP_Canvas::legendsShown ( ) const [inline]

Definition at line 828 of file PlotMSPlotParameterGroups.h.

References itsLegendsShown_.

const String& casa::PMS_PP_Canvas::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 684 of file PlotMSPlotParameterGroups.h.

References casa::PMS_PP::UPDATE_CANVAS_NAME.

unsigned int casa::PMS_PP_Canvas::numCanvases ( ) const

Gets how many canvases there are.

Group& casa::PMS_PP_Canvas::operator= ( const Group other)
bool casa::PMS_PP_Canvas::operator== ( const Group other) const
bool casa::PMS_PP_Canvas::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 696 of file PlotMSPlotParameterGroups.h.

void casa::PMS_PP_Canvas::setGridMajorLine ( const PlotLinePtr value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::setGridMajorLines ( const vector< PlotLinePtr > &  value) [inline]
void casa::PMS_PP_Canvas::setGridMinorLine ( const PlotLinePtr value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::setGridMinorLines ( const vector< PlotLinePtr > &  value) [inline]
void casa::PMS_PP_Canvas::setLabelFormats ( const PlotMSLabelFormat xFormat,
const PlotMSLabelFormat yFormat,
unsigned int  index = 0 
)

Sets single versions of the parameters for the given index.

void casa::PMS_PP_Canvas::setTitleFormat ( const PlotMSLabelFormat value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::setTitleFormats ( const vector< PlotMSLabelFormat > &  value) [inline]
void casa::PMS_PP_Canvas::setXLabelFormat ( const PlotMSLabelFormat value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::setXLabelFormats ( const vector< PlotMSLabelFormat > &  value) [inline]
void casa::PMS_PP_Canvas::setYLabelFormat ( const PlotMSLabelFormat value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::setYLabelFormats ( const vector< PlotMSLabelFormat > &  value) [inline]
void casa::PMS_PP_Canvas::showAxes ( const bool &  xShow,
const bool &  yShow,
unsigned int  index = 0 
)
void casa::PMS_PP_Canvas::showGrid ( const bool &  showMajor,
const bool &  showMinor,
const PlotLinePtr majorLine,
const PlotLinePtr minorLine,
unsigned int  index = 0 
)

Referenced by showGridMajor(), and showGridMinor().

void casa::PMS_PP_Canvas::showGridMajor ( const bool &  show,
const PlotLinePtr line,
unsigned int  index = 0 
) [inline]

Definition at line 721 of file PlotMSPlotParameterGroups.h.

References gridMinorLine(), gridMinorShown(), and showGrid().

void casa::PMS_PP_Canvas::showGridMajor ( const bool &  value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::showGridMajors ( const vector< bool > &  value) [inline]
void casa::PMS_PP_Canvas::showGridMinor ( const bool &  show,
const PlotLinePtr line,
unsigned int  index = 0 
) [inline]

Definition at line 726 of file PlotMSPlotParameterGroups.h.

References gridMajorLine(), gridMajorShown(), and showGrid().

void casa::PMS_PP_Canvas::showGridMinor ( const bool &  value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::showGridMinors ( const vector< bool > &  value) [inline]
void casa::PMS_PP_Canvas::showLegend ( const bool &  show,
const PlotCanvas::LegendPosition pos,
unsigned int  index = 0 
)
void casa::PMS_PP_Canvas::showLegend ( const bool &  value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::showLegend ( const PlotCanvas::LegendPosition value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::showLegends ( const vector< bool > &  value) [inline]
void casa::PMS_PP_Canvas::showLegends ( const vector< PlotCanvas::LegendPosition > &  value) [inline]
void casa::PMS_PP_Canvas::showXAxes ( const vector< bool > &  value) [inline]
void casa::PMS_PP_Canvas::showXAxis ( const bool &  value,
unsigned int  index = 0 
) [inline]
void casa::PMS_PP_Canvas::showYAxes ( const vector< bool > &  value) [inline]
void casa::PMS_PP_Canvas::showYAxis ( const bool &  value,
unsigned int  index = 0 
) [inline]
const PlotMSLabelFormat& casa::PMS_PP_Canvas::titleFormat ( unsigned int  index = 0) const [inline]

Definition at line 887 of file PlotMSPlotParameterGroups.h.

References itsTitles_.

const vector< PlotMSLabelFormat >& casa::PMS_PP_Canvas::titleFormats ( ) const [inline]

Definition at line 878 of file PlotMSPlotParameterGroups.h.

References itsTitles_.

Returns a Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

const vector< bool >& casa::PMS_PP_Canvas::xAxesShown ( ) const [inline]

Definition at line 780 of file PlotMSPlotParameterGroups.h.

References itsXAxesShown_.

bool casa::PMS_PP_Canvas::xAxisShown ( unsigned int  index = 0) const [inline]

Definition at line 789 of file PlotMSPlotParameterGroups.h.

References itsXAxesShown_.

const PlotMSLabelFormat& casa::PMS_PP_Canvas::xLabelFormat ( unsigned int  index = 0) const [inline]

Definition at line 747 of file PlotMSPlotParameterGroups.h.

References itsXLabels_.

const vector< PlotMSLabelFormat >& casa::PMS_PP_Canvas::xLabelFormats ( ) const [inline]

      

Definition at line 738 of file PlotMSPlotParameterGroups.h.

References itsXLabels_.

const vector< bool >& casa::PMS_PP_Canvas::yAxesShown ( ) const [inline]

Definition at line 804 of file PlotMSPlotParameterGroups.h.

References itsYAxesShown_.

bool casa::PMS_PP_Canvas::yAxisShown ( unsigned int  index = 0) const [inline]

Definition at line 813 of file PlotMSPlotParameterGroups.h.

References itsYAxesShown_.

const PlotMSLabelFormat& casa::PMS_PP_Canvas::yLabelFormat ( unsigned int  index = 0) const [inline]

Definition at line 768 of file PlotMSPlotParameterGroups.h.

References itsYLabels_.

const vector< PlotMSLabelFormat >& casa::PMS_PP_Canvas::yLabelFormats ( ) const [inline]

Definition at line 759 of file PlotMSPlotParameterGroups.h.

References itsYLabels_.


Member Data Documentation

vector<bool> casa::PMS_PP_Canvas::itsLegendsShown_ [private]

Definition at line 1003 of file PlotMSPlotParameterGroups.h.

Referenced by legendShown(), legendsShown(), showLegend(), and showLegends().

vector<bool> casa::PMS_PP_Canvas::itsXAxesShown_ [private]

Definition at line 1001 of file PlotMSPlotParameterGroups.h.

Referenced by showXAxes(), showXAxis(), xAxesShown(), and xAxisShown().

vector<bool> casa::PMS_PP_Canvas::itsYAxesShown_ [private]

Definition at line 1002 of file PlotMSPlotParameterGroups.h.

Referenced by showYAxes(), showYAxis(), yAxesShown(), and yAxisShown().

Definition at line 1021 of file PlotMSPlotParameterGroups.h.

Definition at line 1022 of file PlotMSPlotParameterGroups.h.

Definition at line 1017 of file PlotMSPlotParameterGroups.h.

Definition at line 1019 of file PlotMSPlotParameterGroups.h.

Definition at line 1020 of file PlotMSPlotParameterGroups.h.

Definition at line 1016 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Canvas::REC_SHOWXAXES [static, private]

Definition at line 1014 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Canvas::REC_SHOWYAXES [static, private]

Definition at line 1015 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Canvas::REC_TITLES [static, private]

Definition at line 1018 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Canvas::REC_XLABELS [static, private]

Definition at line 1012 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Canvas::REC_YLABELS [static, private]

Definition at line 1013 of file PlotMSPlotParameterGroups.h.


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