casa::PlotLayoutGrid Class Reference

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

#include <PlotCanvasLayout.h>

Inheritance diagram for casa::PlotLayoutGrid:

Public Member Functions
	PlotLayoutGrid (unsigned int rows, unsigned int cols)
	Constructor which takes the number of rows and columns. More...
	~PlotLayoutGrid ()
	Destructor. More...
unsigned int	rows () const
	Returns the number of rows. More...
unsigned int	cols () const
	Returns the number of columns. More...
bool	coordIsValid (const PlotLayoutCoordinate &coord) const
	Implements PlotCanvasLayout::coordIsValid(). More...
int	coordToIndex (const PlotLayoutCoordinate &coord) const
	Implements PlotCanvasLayout::coordToIndex(). More...
void	setCanvasAt (const PlotLayoutCoordinate &coord, PlotCanvasPtr canvas)
	Implements PlotCanvasLayout::setCanvasAt(). More...
PlotCanvasPtr	canvasAt (const PlotLayoutCoordinate &coord) const
	Implements PlotCanvasLayout::canvasAt(). More...
PlotCanvasPtr	canvas () const
	Implements PlotCanvasLayout::canvas(). More...
std::vector< PlotCanvasPtr >	allCanvases () const
	Implements PlotCanvasLayout::allCanvases(). More...
bool	isValid () const
	Implements PlotCanvasLayout::isValid(). More...
unsigned int	spacing () const
	Implements PlotCanvasLayout::spacing(). More...
void	setSpacing (unsigned int spacing)
	Implements PlotCanvasLayout::setSpacing(). More...
Public Member Functions inherited from casa::PlotCanvasLayout
	PlotCanvasLayout ()
	Constructor. More...
virtual	~PlotCanvasLayout ()
	Destructor. More...
virtual Plotter *	plotter () const
	Returns the plotter this layout is used in, or NULL for none. More...
virtual void	attach (Plotter *p)
	Attaches this layout to the given plotter. More...

Protected Attributes
unsigned int	m_rows
unsigned int	m_cols
std::vector< std::vector < PlotCanvasPtr > >	m_panels
unsigned int	m_spacing
Protected Attributes inherited from casa::PlotCanvasLayout
Plotter *	m_plotter

Detailed Description

An n x m grid of canvases.

Definition at line 172 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

std::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 215 of file PlotCanvasLayout.h.

std::vector<std::vector<PlotCanvasPtr> > casa::PlotLayoutGrid::m_panels

protected

Definition at line 216 of file PlotCanvasLayout.h.

unsigned int casa::PlotLayoutGrid::m_rows

protected

Definition at line 214 of file PlotCanvasLayout.h.

unsigned int casa::PlotLayoutGrid::m_spacing

protected

Definition at line 217 of file PlotCanvasLayout.h.

---

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

• casa/code/graphics/GenericPlotter/PlotCanvasLayout.h