casa::PlotMSPages Class Reference

Represents (potentially) multiple pages for PlotMS, with one being current (visible) at a time. More...

#include <PlotMSPages.h>

List of all members.

Public Types
typedef vector< PlotMSPage > ::iterator	iterator
	Iterators.
typedef vector< PlotMSPage > ::const_iterator	const_iterator
Public Member Functions
	PlotMSPages (PlotMSPlotManager &manager)
	Constructor, which the plot manager.
	PlotMSPages (const PlotMSPages &copy)
	Copy constructor.
	~PlotMSPages ()
	Destructor.
unsigned int	currentPageNumber () const
	Returns the current page number.
PlotMSPage	currentPage () const
	Returns a COPY of the current page.
PlotMSPage	getFirstPage () const
void	setCurrentPageNum (uInt num)
PlotMSPage &	operator[] (uInt index)
	Accessor.
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
unsigned int	totalPages () const
	Returns the total pages.
void	clear ()
	Clear all pages.
void	resize (size_t pages)
void	clearCanvas (int row, int col)
	Erase all traces of a plot at the specific location including removing axes and title.
void	clearCanvases ()
	Erase axes & titles from all the canvases.
bool	gridChanged (int rows, int cols)
	Resize the page to the current number of rows and columns.
PlotMSPages &	operator= (const PlotMSPages &copy)
	Copy operator.
void	firstPage ()
	Iterators.
void	nextPage ()
void	previousPage ()
void	lastPage ()
PlotMSPage	insertPage (int index=-1)
	Inserts a new page at the given index, and returns it.
void	clearPages ()
	Clears all pages.
void	setupCurrentPage ()
	Sets up the current page (see PlotMSPage::setupPage()).
void	disown (PlotMSPlot *plot)
	Remove the plot from the canvas.
void	disown (int row, int col, PlotMSPlot *plot)
bool	canvasIsOwnedBy (int row, int col, PlotMSPlot *plot) const
PlotMSParameters	getPageParameters ()
bool	isSpot (int rowIndex, int colIndex, PlotMSPlot *plot) const
	Returns whether the spot at the given location is available for the plot (either empty or the plot is already occupying it).
std::pair< int, int >	findEmptySpot () const
	Returns the row and column index of the first canvas on the page, or <-1,-1> if the page is full.
Private Member Functions
bool	isGridChanged (int rows, int cols) const
	Returns whether or not (rows,cols) would represent a change in the current page size.
Private Attributes
PlotMSPlotManager *	itsManager_
	Plot manager.
vector< PlotMSPage >	itsPages_
	Pages.
unsigned int	itsCurrentPageNum_
	Current page number.
Friends
class	PlotMSPage
class	PlotMSPlot
class	PlotMSPlotManager

---

Detailed Description

Represents (potentially) multiple pages for PlotMS, with one being current (visible) at a time.

Definition at line 39 of file PlotMSPages.h.

---

Member Typedef Documentation

typedef vector<PlotMSPage>::const_iterator casa::PlotMSPages::const_iterator

Definition at line 74 of file PlotMSPages.h.

typedef vector<PlotMSPage>::iterator casa::PlotMSPages::iterator

Iterators.

Definition at line 70 of file PlotMSPages.h.

---

Constructor & Destructor Documentation

casa::PlotMSPages::PlotMSPages

(

PlotMSPlotManager &

manager

)

Constructor, which the plot manager.

casa::PlotMSPages::PlotMSPages

(

const PlotMSPages &

copy

)

Copy constructor.

casa::PlotMSPages::~PlotMSPages

(

)

Destructor.

---

Member Function Documentation

const_iterator casa::PlotMSPages::begin

(

)

const [inline]

Definition at line 75 of file PlotMSPages.h.

References itsPages_.

iterator casa::PlotMSPages::begin

(

)

[inline]

Definition at line 71 of file PlotMSPages.h.

References itsPages_.

bool casa::PlotMSPages::canvasIsOwnedBy	(	int	row,
		int	col,
		PlotMSPlot *	plot
	)			const

void casa::PlotMSPages::clear

(

)

[inline]

Clear all pages.

Definition at line 82 of file PlotMSPages.h.

References itsPages_.

void casa::PlotMSPages::clearCanvas	(	int	row,
		int	col
	)

Erase all traces of a plot at the specific location including removing axes and title.

void casa::PlotMSPages::clearCanvases

(

)

Erase axes & titles from all the canvases.

void casa::PlotMSPages::clearPages

(

)

Clears all pages.

PlotMSPage casa::PlotMSPages::currentPage

(

)

const

Returns a COPY of the current page.

unsigned int casa::PlotMSPages::currentPageNumber

(

)

const

Returns the current page number.

void casa::PlotMSPages::disown	(	int	row,
		int	col,
		PlotMSPlot *	plot
	)

void casa::PlotMSPages::disown

(

PlotMSPlot *

plot

)

Remove the plot from the canvas.

const_iterator casa::PlotMSPages::end

(

)

const [inline]

Definition at line 76 of file PlotMSPages.h.

References itsPages_.

iterator casa::PlotMSPages::end

(

)

[inline]

Definition at line 72 of file PlotMSPages.h.

References itsPages_.

std::pair<int,int> casa::PlotMSPages::findEmptySpot

(

)

const

Returns the row and column index of the first canvas on the page, or <-1,-1> if the page is full.

void casa::PlotMSPages::firstPage

(

)

Iterators.

PlotMSPage casa::PlotMSPages::getFirstPage

(

)

const

PlotMSParameters casa::PlotMSPages::getPageParameters

(

)

bool casa::PlotMSPages::gridChanged	(	int	rows,
		int	cols
	)

Resize the page to the current number of rows and columns.

PlotMSPage casa::PlotMSPages::insertPage

(

int

index = -1

)

Inserts a new page at the given index, and returns it.

If the given index is invalid, the page is inserted at the end.

bool casa::PlotMSPages::isGridChanged	(	int	rows,
		int	cols
	)			const [private]

Returns whether or not (rows,cols) would represent a change in the current page size.

bool casa::PlotMSPages::isSpot	(	int	rowIndex,
		int	colIndex,
		PlotMSPlot *	plot
	)			const

Returns whether the spot at the given location is available for the plot (either empty or the plot is already occupying it).

void casa::PlotMSPages::lastPage

(

)

void casa::PlotMSPages::nextPage

(

)

PlotMSPages& casa::PlotMSPages::operator=

(

const PlotMSPages &

copy

)

Copy operator.

PlotMSPage& casa::PlotMSPages::operator[]

(

uInt

index

)

[inline]

Accessor.

Definition at line 67 of file PlotMSPages.h.

References itsPages_.

void casa::PlotMSPages::previousPage

(

)

void casa::PlotMSPages::resize

(

size_t

pages

)

void casa::PlotMSPages::setCurrentPageNum

(

uInt

num

)

void casa::PlotMSPages::setupCurrentPage

(

)

Sets up the current page (see PlotMSPage::setupPage()).

unsigned int casa::PlotMSPages::totalPages

(

)

const

Returns the total pages.

---

Friends And Related Function Documentation

friend class PlotMSPage [friend]

Definition at line 42 of file PlotMSPages.h.

friend class PlotMSPlot [friend]

Definition at line 43 of file PlotMSPages.h.

friend class PlotMSPlotManager [friend]

Definition at line 44 of file PlotMSPages.h.

---

Member Data Documentation

unsigned int casa::PlotMSPages::itsCurrentPageNum_ [private]

Current page number.

Definition at line 144 of file PlotMSPages.h.

PlotMSPlotManager* casa::PlotMSPages::itsManager_ [private]

Plot manager.

Definition at line 138 of file PlotMSPages.h.

vector<PlotMSPage> casa::PlotMSPages::itsPages_ [private]

Pages.

Definition at line 141 of file PlotMSPages.h.

Referenced by begin(), clear(), end(), and operator[]().

---

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

• code/plotms/Plots/PlotMSPages.h