casa::PlotLayoutGrid Class Reference

An n x m grid of canvases. More...

#include <PlotCanvasLayout.h>

Inheritance diagram for casa::PlotLayoutGrid:

List of all members.

Public Member Functions
	PlotLayoutGrid (unsigned int rows, unsigned int cols)
	Constructor which takes the number of rows and columns.
	~PlotLayoutGrid ()
	Destructor.
unsigned int	rows () const
	Returns the number of rows.
unsigned int	cols () const
	Returns the number of columns.
bool	coordIsValid (const PlotLayoutCoordinate &coord) const
	Implements PlotCanvasLayout::coordIsValid().
int	coordToIndex (const PlotLayoutCoordinate &coord) const
	Implements PlotCanvasLayout::coordToIndex().
void	setCanvasAt (const PlotLayoutCoordinate &coord, PlotCanvasPtr canvas)
	Implements PlotCanvasLayout::setCanvasAt().
PlotCanvasPtr	canvasAt (const PlotLayoutCoordinate &coord) const
	Implements PlotCanvasLayout::canvasAt().
PlotCanvasPtr	canvas () const
	Implements PlotCanvasLayout::canvas().
vector< PlotCanvasPtr >	allCanvases () const
	Implements PlotCanvasLayout::allCanvases().
bool	isValid () const
	Implements PlotCanvasLayout::isValid().
unsigned int	spacing () const
	Implements PlotCanvasLayout::spacing().
void	setSpacing (unsigned int spacing)
	Implements PlotCanvasLayout::setSpacing().
Protected Attributes
unsigned int	m_rows
unsigned int	m_cols
vector< vector< PlotCanvasPtr > >	m_panels
unsigned int	m_spacing

---

Detailed Description

An n x m grid of canvases.

Definition at line 174 of file PlotCanvasLayout.h.

---

Constructor & Destructor Documentation

casa::PlotLayoutGrid::PlotLayoutGrid	(	unsigned int	rows,
		unsigned int	cols
	)

Constructor which takes the number of rows and columns.

casa::PlotLayoutGrid::~PlotLayoutGrid

(

)

Destructor.

---

Member Function Documentation

vector<PlotCanvasPtr> casa::PlotLayoutGrid::allCanvases

(

)

const [virtual]

Implements PlotCanvasLayout::allCanvases().

Implements casa::PlotCanvasLayout.

PlotCanvasPtr casa::PlotLayoutGrid::canvas

(

)

const [virtual]

Implements PlotCanvasLayout::canvas().

Implements casa::PlotCanvasLayout.

PlotCanvasPtr casa::PlotLayoutGrid::canvasAt

(

const PlotLayoutCoordinate &

coord

)

const [virtual]

Implements PlotCanvasLayout::canvasAt().

Implements casa::PlotCanvasLayout.

unsigned int casa::PlotLayoutGrid::cols

(

)

const

Returns the number of columns.

bool casa::PlotLayoutGrid::coordIsValid

(

const PlotLayoutCoordinate &

coord

)

const [virtual]

Implements PlotCanvasLayout::coordIsValid().

Implements casa::PlotCanvasLayout.

int casa::PlotLayoutGrid::coordToIndex

(

const PlotLayoutCoordinate &

coord

)

const [virtual]

Implements PlotCanvasLayout::coordToIndex().

Implements casa::PlotCanvasLayout.

bool casa::PlotLayoutGrid::isValid

(

)

const [virtual]

Implements PlotCanvasLayout::isValid().

Implements casa::PlotCanvasLayout.

unsigned int casa::PlotLayoutGrid::rows

(

)

const

Returns the number of rows.

void casa::PlotLayoutGrid::setCanvasAt	(	const PlotLayoutCoordinate &	coord,
		PlotCanvasPtr	canvas
	)		[virtual]

Implements PlotCanvasLayout::setCanvasAt().

Implements casa::PlotCanvasLayout.

void casa::PlotLayoutGrid::setSpacing

(

unsigned int

spacing

)

[virtual]

Implements PlotCanvasLayout::setSpacing().

Implements casa::PlotCanvasLayout.

unsigned int casa::PlotLayoutGrid::spacing

(

)

const [virtual]

Implements PlotCanvasLayout::spacing().

Implements casa::PlotCanvasLayout.

---

Member Data Documentation

unsigned int casa::PlotLayoutGrid::m_cols [protected]

Definition at line 217 of file PlotCanvasLayout.h.

vector<vector<PlotCanvasPtr> > casa::PlotLayoutGrid::m_panels [protected]

Definition at line 218 of file PlotCanvasLayout.h.

unsigned int casa::PlotLayoutGrid::m_rows [protected]

Definition at line 216 of file PlotCanvasLayout.h.

unsigned int casa::PlotLayoutGrid::m_spacing [protected]

Definition at line 219 of file PlotCanvasLayout.h.

---

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

• code/graphics/GenericPlotter/PlotCanvasLayout.h