casa::PlotMSPages Class Reference

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

#include <PlotMSPage.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.
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)
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()).
Private Attributes
PlotMSPlotManager *	itsManager_
	Plot manager.
vector< PlotMSPage >	itsPages_
	Pages.
unsigned int	itsCurrentPageNum_
	Current page number.
Friends
class	PlotMSMultiPlot
class	PlotMSPage
class	PlotMSPlot
class	PlotMSPlotManager
class	PlotMSSinglePlot
class	PlotMSIterPlot

---

Detailed Description

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

Definition at line 123 of file PlotMSPage.h.

---

Member Typedef Documentation

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

Definition at line 161 of file PlotMSPage.h.

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

Iterators.

Definition at line 157 of file PlotMSPage.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

iterator casa::PlotMSPages::begin

(

)

[inline]

Definition at line 158 of file PlotMSPage.h.

References itsPages_.

const_iterator casa::PlotMSPages::begin

(

)

const [inline]

Definition at line 162 of file PlotMSPage.h.

References itsPages_.

void casa::PlotMSPages::clear

(

)

[inline]

Clear all pages.

Definition at line 169 of file PlotMSPage.h.

References itsPages_.

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.

iterator casa::PlotMSPages::end

(

)

[inline]

Definition at line 159 of file PlotMSPage.h.

References itsPages_.

const_iterator casa::PlotMSPages::end

(

)

const [inline]

Definition at line 163 of file PlotMSPage.h.

References itsPages_.

void casa::PlotMSPages::firstPage

(

)

Iterators.

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.

Referenced by resize().

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 154 of file PlotMSPage.h.

References itsPages_.

void casa::PlotMSPages::previousPage

(

)

void casa::PlotMSPages::resize

(

size_t

pages

)

[inline]

Shrink if needed

If we are adding new pages, initialize them

Definition at line 171 of file PlotMSPage.h.

References insertPage(), itsPages_, and PlotMSPage.

void casa::PlotMSPages::setCurrentPageNum

(

uInt

num

)

[inline]

Definition at line 149 of file PlotMSPage.h.

References itsCurrentPageNum_, and totalPages().

void casa::PlotMSPages::setupCurrentPage

(

)

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

unsigned int casa::PlotMSPages::totalPages

(

)

const

Returns the total pages.

Referenced by setCurrentPageNum().

---

Friends And Related Function Documentation

friend class PlotMSIterPlot [friend]

Definition at line 131 of file PlotMSPage.h.

friend class PlotMSMultiPlot [friend]

Definition at line 126 of file PlotMSPage.h.

friend class PlotMSPage [friend]

Definition at line 127 of file PlotMSPage.h.

Referenced by resize().

friend class PlotMSPlot [friend]

Definition at line 128 of file PlotMSPage.h.

friend class PlotMSPlotManager [friend]

Definition at line 129 of file PlotMSPage.h.

friend class PlotMSSinglePlot [friend]

Definition at line 130 of file PlotMSPage.h.

---

Member Data Documentation

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

Current page number.

Definition at line 213 of file PlotMSPage.h.

Referenced by setCurrentPageNum().

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

Plot manager.

Definition at line 207 of file PlotMSPage.h.

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

Pages.

Definition at line 210 of file PlotMSPage.h.

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

---

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

• code/plotms/Plots/PlotMSPage.h