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

Class which manages PlotMSPlots for plotms. More...

#include <PlotMSPlotManager.h>

List of all members.

Public Member Functions

 PlotMSPlotManager ()
 Constructor.
 ~PlotMSPlotManager ()
 Destructor.
PlotMSAppparent ()
 Gets/Sets the parent PlotMS.
void setParent (PlotMSApp *parent)
PlotterPtr plotter ()
 Returns the plotter used by the parent.
void addWatcher (PlotMSPlotManagerWatcher *watcher)
 Adds the given watcher to this manager.
void removeWatcher (PlotMSPlotManagerWatcher *watcher)
 Removes the given watcher from this manager.
unsigned int numPlots () const
 Returns the number of plots.
const vector< PlotMSPlot * > & plots () const
 Returns all or one of the plots.
PlotMSPlotplot (unsigned int index)
const PlotMSPlotplot (unsigned int index) const
const vector
< PlotMSPlotParameters * > & 
plotParameters () const
 Returns all or one of the plot parameters.
PlotMSPlotParametersplotParameters (unsigned int index)
PlotMSOverPlotaddOverPlot (const PlotMSPlotParameters *p=NULL)
 Creates a new PlotMSOverPlot, initializes it properly, adds it to the plotter, and returns a pointer to it.
PlotMSPlotaddSinglePlot (const PlotMSPlotParameters *p=NULL)
 These are now deprecated and will throw an exception...
PlotMSPlotaddMultiPlot (const PlotMSPlotParameters *p=NULL)
PlotMSPlotaddIterPlot (const PlotMSPlotParameters *p=NULL)
void clearPlotsAndCanvases ()
 Clears out all plots and canvases.

Private Member Functions

void addPlot (PlotMSPlot *plot, const PlotMSPlotParameters *p)
 Helper method for add*Plot methods.
void notifyWatchers () const
 Notifies any watchers that the managed plots have changed.

Private Attributes

PlotMSAppitsParent_
 Parent.
PlotterPtr itsPlotter_
 Plotter.
PlotFactoryPtr itsFactory_
 Plot factory.
vector< PlotMSPlot * > itsPlots_
 Plots.
vector< PlotMSPlotParameters * > itsPlotParameters_
 Plot parameters.
vector
< PlotMSPlotManagerWatcher * > 
itsWatchers_
 Watchers.
PlotMSPages itsPages_
 Plot pages.

Friends

class PlotMSMultiPlot
class PlotMSOverPlot

Detailed Description

Class which manages PlotMSPlots for plotms.

Mainly handles adding new plots and managing their PlotCanvases and the arrangement of PlotCanvases in the Plotter. Any PlotMSPlots should be owned by the manager, which will handle deletion as necessary.

Definition at line 52 of file PlotMSPlotManager.h.


Constructor & Destructor Documentation

Constructor.

Parent must be set using setParent() before manager can be used.

Destructor.


Member Function Documentation

Creates a new PlotMSOverPlot, initializes it properly, adds it to the plotter, and returns a pointer to it.

If parameters are given, they are used; otherwise the defaults are used.

void casa::PlotMSPlotManager::addPlot ( PlotMSPlot plot,
const PlotMSPlotParameters p 
) [private]

Helper method for add*Plot methods.

These are now deprecated and will throw an exception...

Adds the given watcher to this manager.

Clears out all plots and canvases.

void casa::PlotMSPlotManager::notifyWatchers ( ) const [private]

Notifies any watchers that the managed plots have changed.

unsigned int casa::PlotMSPlotManager::numPlots ( ) const

Returns the number of plots.

Gets/Sets the parent PlotMS.

PlotMSPlot* casa::PlotMSPlotManager::plot ( unsigned int  index)
const PlotMSPlot* casa::PlotMSPlotManager::plot ( unsigned int  index) const

Returns all or one of the plot parameters.

const vector<PlotMSPlot*>& casa::PlotMSPlotManager::plots ( ) const

Returns all or one of the plots.

Returns the plotter used by the parent.

Removes the given watcher from this manager.


Friends And Related Function Documentation

friend class PlotMSMultiPlot [friend]

Definition at line 55 of file PlotMSPlotManager.h.

friend class PlotMSOverPlot [friend]

Definition at line 56 of file PlotMSPlotManager.h.


Member Data Documentation

Plot factory.

Definition at line 120 of file PlotMSPlotManager.h.

Plot pages.

Definition at line 132 of file PlotMSPlotManager.h.

Parent.

Definition at line 114 of file PlotMSPlotManager.h.

Plot parameters.

Will not be deleted on destruction.

Definition at line 126 of file PlotMSPlotManager.h.

Plots.

Will be deleted on destruction.

Definition at line 123 of file PlotMSPlotManager.h.

Plotter.

Definition at line 117 of file PlotMSPlotManager.h.

Watchers.

Definition at line 129 of file PlotMSPlotManager.h.


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