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_Display Class Reference

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

#include <PlotMSPlotParameterGroups.h>

Inheritance diagram for casa::PMS_PP_Display:
casa::PlotMSPlotParameters::Group

List of all members.

Public Member Functions

 PMS_PP_Display (PlotFactoryPtr factory)
 PMS_PP_Display (const PMS_PP_Display &copy)
 ~PMS_PP_Display ()
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
void setColorize (const bool &colorize, const PMS::Axis &axis, unsigned int index=0)
void resizeVectors (unsigned int newSize)
const vector< PlotSymbolPtr > & unflaggedSymbols () const
void setUnflaggedSymbols (const vector< PlotSymbolPtr > &value)
PlotSymbolPtr unflaggedSymbol (unsigned int index=0) const
void setUnflaggedSymbol (const PlotSymbolPtr &value, unsigned int index=0)
const vector< PlotSymbolPtr > & flaggedSymbols () const
void setFlaggedSymbols (const vector< PlotSymbolPtr > &value)
PlotSymbolPtr flaggedSymbol (unsigned int index=0) const
void setFlaggedSymbol (const PlotSymbolPtr &value, unsigned int index=0)
const vector< PlotMSLabelFormat > & titleFormats () const
void setTitleFormats (const vector< PlotMSLabelFormat > &value)
const PlotMSLabelFormat & titleFormat (unsigned int index=0) const
void setTitleFormat (const PlotMSLabelFormat &value, unsigned int index=0)
const vector< bool > & colorizeFlags () const
void setColorize (const vector< bool > &value)
bool colorizeFlag (unsigned int index=0) const
void setColorize (const bool &value, unsigned int index=0)
const vector< PMS::Axis > & colorizeAxes () const
void setColorize (const vector< PMS::Axis > &value)
PMS::Axis colorizeAxis (unsigned int index=0) const
void setColorize (const PMS::Axis &value, unsigned int index=0)

Private Member Functions

void setDefaults ()

Private Attributes

vector< PlotSymbolPtr > itsUnflaggedSymbols_
vector< PlotSymbolPtr > itsFlaggedSymbols_
vector< PlotMSLabelFormat > itsTitleFormats_
vector< bool > itsColorizeFlags_
vector< PMS::Axis > itsColorizeAxes_

Static Private Attributes

static const String REC_UNFLAGGEDS
static const String REC_FLAGGEDS
static const String REC_TITLES
static const String REC_COLFLAGS
static const String REC_COLAXES

Detailed Description

Subclass of PlotMSPlotParameters::Group to handle display parameters.

Currently includes: flagged and unflagged symbols plot title format colorize flag and axis Parameters are vector-based, on a per-plot basis.

Definition at line 1039 of file PlotMSPlotParameterGroups.h.

Constructor & Destructor Documentation

casa::PMS_PP_Display::PMS_PP_Display ( PlotFactoryPtr  factory)

Referenced by clone().

casa::PMS_PP_Display::PMS_PP_Display ( const PMS_PP_Display &  copy)
casa::PMS_PP_Display::~PMS_PP_Display ( )

Member Function Documentation

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

Abstract Methods //.

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

Implements casa::PlotMSPlotParameters::Group.

Definition at line 1052 of file PlotMSPlotParameterGroups.h.

References PMS_PP_Display().

const vector< PMS::Axis >& casa::PMS_PP_Display::colorizeAxes ( ) const [inline]

Definition at line 1184 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_.

PMS::Axis casa::PMS_PP_Display::colorizeAxis ( unsigned int  index = 0) const [inline]

Definition at line 1193 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_.

bool casa::PMS_PP_Display::colorizeFlag ( unsigned int  index = 0) const [inline]

Definition at line 1169 of file PlotMSPlotParameterGroups.h.

References itsColorizeFlags_.

const vector< bool >& casa::PMS_PP_Display::colorizeFlags ( ) const [inline]

Definition at line 1160 of file PlotMSPlotParameterGroups.h.

References itsColorizeFlags_.

PlotSymbolPtr casa::PMS_PP_Display::flaggedSymbol ( unsigned int  index = 0) const [inline]

Definition at line 1122 of file PlotMSPlotParameterGroups.h.

References itsFlaggedSymbols_.

const vector< PlotSymbolPtr >& casa::PMS_PP_Display::flaggedSymbols ( ) const [inline]

Definition at line 1113 of file PlotMSPlotParameterGroups.h.

References itsFlaggedSymbols_.

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

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

Implements casa::PlotMSPlotParameters::Group.

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

References casa::PMS_PP::UPDATE_DISPLAY_NAME.

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

void casa::PMS_PP_Display::resizeVectors ( unsigned int  newSize)
void casa::PMS_PP_Display::setColorize ( const bool &  colorize,
const PMS::Axis &  axis,
unsigned int  index = 0 
)
void casa::PMS_PP_Display::setColorize ( const vector< bool > &  value) [inline]

Definition at line 1163 of file PlotMSPlotParameterGroups.h.

References itsColorizeFlags_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setColorize ( const bool &  value,
unsigned int  index = 0 
) [inline]

Definition at line 1174 of file PlotMSPlotParameterGroups.h.

References itsColorizeFlags_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setColorize ( const vector< PMS::Axis > &  value) [inline]

Definition at line 1187 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setColorize ( const PMS::Axis &  value,
unsigned int  index = 0 
) [inline]

Definition at line 1199 of file PlotMSPlotParameterGroups.h.

References itsColorizeAxes_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setDefaults ( ) [private]
void casa::PMS_PP_Display::setFlaggedSymbol ( const PlotSymbolPtr &  value,
unsigned int  index = 0 
) [inline]

Definition at line 1128 of file PlotMSPlotParameterGroups.h.

References itsFlaggedSymbols_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setFlaggedSymbols ( const vector< PlotSymbolPtr > &  value) [inline]

Definition at line 1116 of file PlotMSPlotParameterGroups.h.

References itsFlaggedSymbols_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setTitleFormat ( const PlotMSLabelFormat &  value,
unsigned int  index = 0 
) [inline]

Definition at line 1151 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setTitleFormats ( const vector< PlotMSLabelFormat > &  value) [inline]

Definition at line 1142 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setUnflaggedSymbol ( const PlotSymbolPtr &  value,
unsigned int  index = 0 
) [inline]

Definition at line 1102 of file PlotMSPlotParameterGroups.h.

References itsUnflaggedSymbols_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

void casa::PMS_PP_Display::setUnflaggedSymbols ( const vector< PlotSymbolPtr > &  value) [inline]

Definition at line 1090 of file PlotMSPlotParameterGroups.h.

References itsUnflaggedSymbols_, casa::PlotMSPlotParameters::Group::updated(), and casa::value().

const PlotMSLabelFormat& casa::PMS_PP_Display::titleFormat ( unsigned int  index = 0) const [inline]

Definition at line 1148 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_.

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

Definition at line 1139 of file PlotMSPlotParameterGroups.h.

References itsTitleFormats_.

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

Returns a Record representing this group of subparameters.

Implements casa::PlotMSPlotParameters::Group.

PlotSymbolPtr casa::PMS_PP_Display::unflaggedSymbol ( unsigned int  index = 0) const [inline]

Definition at line 1096 of file PlotMSPlotParameterGroups.h.

References itsUnflaggedSymbols_.

const vector< PlotSymbolPtr >& casa::PMS_PP_Display::unflaggedSymbols ( ) const [inline]

Definition at line 1087 of file PlotMSPlotParameterGroups.h.

References itsUnflaggedSymbols_.

Member Data Documentation

vector<PMS::Axis> casa::PMS_PP_Display::itsColorizeAxes_ [private]

Definition at line 1215 of file PlotMSPlotParameterGroups.h.

Referenced by colorizeAxes(), colorizeAxis(), and setColorize().

vector<bool> casa::PMS_PP_Display::itsColorizeFlags_ [private]

Definition at line 1214 of file PlotMSPlotParameterGroups.h.

Referenced by colorizeFlag(), colorizeFlags(), and setColorize().

vector<PlotSymbolPtr> casa::PMS_PP_Display::itsFlaggedSymbols_ [private]

Definition at line 1212 of file PlotMSPlotParameterGroups.h.

Referenced by flaggedSymbol(), flaggedSymbols(), setFlaggedSymbol(), and setFlaggedSymbols().

vector<PlotMSLabelFormat> casa::PMS_PP_Display::itsTitleFormats_ [private]

Definition at line 1213 of file PlotMSPlotParameterGroups.h.

Referenced by setTitleFormat(), setTitleFormats(), titleFormat(), and titleFormats().

vector<PlotSymbolPtr> casa::PMS_PP_Display::itsUnflaggedSymbols_ [private]

Definition at line 1211 of file PlotMSPlotParameterGroups.h.

Referenced by setUnflaggedSymbol(), setUnflaggedSymbols(), unflaggedSymbol(), and unflaggedSymbols().

const String casa::PMS_PP_Display::REC_COLAXES [static, private]

Definition at line 1222 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Display::REC_COLFLAGS [static, private]

Definition at line 1221 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Display::REC_FLAGGEDS [static, private]

Definition at line 1219 of file PlotMSPlotParameterGroups.h.

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

Definition at line 1220 of file PlotMSPlotParameterGroups.h.

const String casa::PMS_PP_Display::REC_UNFLAGGEDS [static, private]

Definition at line 1218 of file PlotMSPlotParameterGroups.h.

The documentation for this class was generated from the following file:
Generated on Sat May 4 2013 15:48:48 for casa by   doxygen 1.8.0