casa  $Rev:20696$
Public Member Functions | Public Attributes
casa::PanelParams Class Reference

Classes to hold Plot Options plus other parameters for a panel. More...

#include <PanelParams.h>

List of all members.

Public Member Functions

 PanelParams ()
 Constructor.
 ~PanelParams ()
 Destructor.
Int changeNlayers (Int nlayers)
 Change the number of layers Usually called only to increase the layer count, when overplots are done one-by-one.
Int updateLayerParams ()
 Fill in parameters from the most current PlotOptions.
Bool reset ()
 Reset all parameters.

Public Attributes

PlotOptions Plop
 A PlotOptions instance to read inputs and to hold layer-independant parameters.
Vector< DoublePanelZrange
 Layer INDEPENDANT parameters The current plot-range for this panel.
Vector< Vector< Double > > FlagList
 A list of marked regions for this panel.
Int MaxLayer
 The layer number for the topmost layer.
Int TimePlot
 Integer form of the TimePlot parameter.
Int PlotColour
 Ingeter form of the plot colour.
String PyPlotSymbol
 Python plot symbol.
Int nBP
 LAYER DEPENDANT parameters Number of BasePlot-layers.
Vector< IntLayerNumbers
 The "layerNumber" for each BasePlot-Plot.
Vector< IntLayerColours
 Other parameters.
Vector< StringLayerSymbols
Vector< Vector< String > > LayerPointLabels
Vector< Vector< String > > LayerLocateColumns
Vector< DoubleLayerMarkerSizes
Vector< DoubleLayerLineWidths
Vector< BoolLayerShowFlags
Vector< StringLayerMultiColours
Vector< StringLayerFlagVersions
Vector< IntLayerSkipNRows
Vector< IntLayerAverageNRows
Vector< StringLayerFlagExt
Vector< StringLayerConnects
Vector< Vector< String > > LayerXYTaqls

Detailed Description

Classes to hold Plot Options plus other parameters for a panel.

Prerequisite

Etymology

Panel Parameters.

Synopsis

Holds PlotOptions for each BasePlot on one panel. Layers are created via overplots, as well as by making one plot using multiple Tables. There are layer independant and layer dependant parameters. Replots after flag editing, need to remember plot options for all layers, so this class does it. TablePlot holds a PanelParams object for each panel.

Motivation

The need to remember plot options for multiple plot layers, per panel.

Thrown Exceptions

To Do

Definition at line 419 of file PanelParams.h.


Constructor & Destructor Documentation

casa::PanelParams::PanelParams ( )

Constructor.

casa::PanelParams::~PanelParams ( )

Destructor.


Member Function Documentation

Int casa::PanelParams::changeNlayers ( Int  nlayers)

Change the number of layers Usually called only to increase the layer count, when overplots are done one-by-one.

Bool casa::PanelParams::reset ( )

Reset all parameters.

Int casa::PanelParams::updateLayerParams ( )

Fill in parameters from the most current PlotOptions.


Member Data Documentation

A list of marked regions for this panel.

FlagList(panelId, regionCount);

Definition at line 449 of file PanelParams.h.

Definition at line 487 of file PanelParams.h.

Other parameters.

Definition at line 477 of file PanelParams.h.

Definition at line 489 of file PanelParams.h.

Definition at line 488 of file PanelParams.h.

Definition at line 485 of file PanelParams.h.

Definition at line 482 of file PanelParams.h.

Definition at line 480 of file PanelParams.h.

Definition at line 481 of file PanelParams.h.

Definition at line 484 of file PanelParams.h.

The "layerNumber" for each BasePlot-Plot.

Definition at line 474 of file PanelParams.h.

Definition at line 479 of file PanelParams.h.

Definition at line 483 of file PanelParams.h.

Definition at line 486 of file PanelParams.h.

Definition at line 478 of file PanelParams.h.

Definition at line 490 of file PanelParams.h.

The layer number for the topmost layer.

NOTE : A layer is a plot from one BasePlot object. Sometimes, a single TablePlot::plotData call, generates plots from multiple BasePlots. All layers from one single TablePlot::plotData call, get the same "layerNumber".

Definition at line 457 of file PanelParams.h.

LAYER DEPENDANT parameters Number of BasePlot-layers.

Definition at line 471 of file PanelParams.h.

Layer INDEPENDANT parameters The current plot-range for this panel.

Definition at line 445 of file PanelParams.h.

A PlotOptions instance to read inputs and to hold layer-independant parameters.

Definition at line 441 of file PanelParams.h.

Ingeter form of the plot colour.

Needed to allow automatic colour incrementing !

Definition at line 464 of file PanelParams.h.

Python plot symbol.

Definition at line 467 of file PanelParams.h.

Integer form of the TimePlot parameter.

Definition at line 460 of file PanelParams.h.


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