casa::ScatterPlot Class Reference

Scatter plot abstract class. More...

#include <Plot.h>

Inheritance diagram for casa::ScatterPlot:

List of all members.

Public Member Functions
	ScatterPlot ()
virtual	~ScatterPlot ()
virtual PlotDataPtr	data () const
	Overrides Plot::data().
virtual ppoint_t	pointAt (unsigned int i) const
	Returns the data value at the given index.
virtual unsigned int	drawCount () const
	Implements PlotItem::drawCount().
virtual PlotPointDataPtr	pointData () const =0
	ABSTRACT METHODS //.
virtual bool	symbolsShown () const =0
	Returns true if symbols are shown, false otherwise.
virtual void	setSymbolsShown (bool symbolsShown=true)=0
	Sets whether symbols are shown or not.
virtual PlotSymbolPtr	symbol () const =0
	Returns a copy of the symbol for this plot.
virtual void	setSymbol (const PlotSymbol &symbol)=0
	Sets the plot symbols to the given symbol.
virtual void	setSymbol (const PlotSymbolPtr symbol)
	IMPLEMENTED METHODS //.
virtual void	setSymbol (PlotSymbol::Symbol s)
virtual void	setSymbol (char s)
virtual void	setSymbolSize (double width, double height)
virtual void	setSymbolLine (const PlotLine &line)
virtual void	setSymbolLine (const PlotLinePtr line)
virtual void	setSymbolLine (const String &color, PlotLine::Style style=PlotLine::SOLID, double width=1.0)
virtual void	setSymbolAreaFill (const PlotAreaFill &fill)
virtual void	setSymbolAreaFill (const PlotAreaFillPtr fill)
virtual void	setSymbolAreaFill (const String &color, PlotAreaFill::Pattern pattern=PlotAreaFill::FILL)

---

Detailed Description

Scatter plot abstract class.

In addition to the abstract methods in Plot, a scatter plot subclass should also have symbol customization for the points. A scatter plot is expected to consist of PlotPointData.

Definition at line 118 of file Plot.h.

---

Constructor & Destructor Documentation

casa::ScatterPlot::ScatterPlot

(

)

[inline]

Definition at line 120 of file Plot.h.

virtual casa::ScatterPlot::~ScatterPlot

(

)

[inline, virtual]

Definition at line 122 of file Plot.h.

---

Member Function Documentation

virtual PlotDataPtr casa::ScatterPlot::data

(

)

const [inline, virtual]

Overrides Plot::data().

Implements casa::Plot.

Definition at line 126 of file Plot.h.

References pointData().

Referenced by casa::MaskedScatterPlot::maskedAt(), and pointAt().

virtual unsigned int casa::ScatterPlot::drawCount

(

)

const [inline, virtual]

Implements PlotItem::drawCount().

Provides default implementation that returns the number of plotted points.

Implements casa::PlotItem.

Definition at line 138 of file Plot.h.

References pointData().

virtual ppoint_t casa::ScatterPlot::pointAt

(

unsigned int

i

)

const [inline, virtual]

Returns the data value at the given index.

Just a thin layer over the PlotPointData functionality.

Definition at line 130 of file Plot.h.

References data(), and pointData().

virtual PlotPointDataPtr casa::ScatterPlot::pointData

(

)

const [pure virtual]

ABSTRACT METHODS //.

Returns the point data used for this plot.

Implemented in casa::ColoredPlot, casa::ErrorPlot, and casa::MaskedScatterPlot.

Referenced by data(), drawCount(), and pointAt().

virtual void casa::ScatterPlot::setSymbol

(

const PlotSymbol &

symbol

)

[pure virtual]

Sets the plot symbols to the given symbol.

Implies setSymbolsShown(true) unless the symbol's style is set to NOSYMBOL.

Referenced by setSymbol(), setSymbolAreaFill(), setSymbolLine(), and setSymbolSize().

virtual void casa::ScatterPlot::setSymbol

(

const PlotSymbolPtr

symbol

)

[inline, virtual]

IMPLEMENTED METHODS //.

Convenience methods for setting symbol.

Definition at line 168 of file Plot.h.

References casa::SimpleCountedConstPtr< t >::null(), setSymbol(), and setSymbolsShown().

virtual void casa::ScatterPlot::setSymbol

(

PlotSymbol::Symbol

s

)

[inline, virtual]

Definition at line 172 of file Plot.h.

References setSymbol(), casa::PlotSymbol::setSymbol(), and symbol().

virtual void casa::ScatterPlot::setSymbol

(

char

s

)

[inline, virtual]

Definition at line 177 of file Plot.h.

References setSymbol(), casa::PlotSymbol::setSymbol(), and symbol().

virtual void casa::ScatterPlot::setSymbolAreaFill

(

const PlotAreaFill &

fill

)

[inline, virtual]

Definition at line 200 of file Plot.h.

References casa::PlotSymbol::setAreaFill(), setSymbol(), and symbol().

Referenced by setSymbolAreaFill().

virtual void casa::ScatterPlot::setSymbolAreaFill

(

const PlotAreaFillPtr

fill

)

[inline, virtual]

Definition at line 205 of file Plot.h.

References casa::SimpleCountedConstPtr< t >::null(), and setSymbolAreaFill().

virtual void casa::ScatterPlot::setSymbolAreaFill	(	const String &	color,
		PlotAreaFill::Pattern	pattern = PlotAreaFill::FILL
	)		[inline, virtual]

Definition at line 207 of file Plot.h.

References casa::pattern(), casa::PlotSymbol::setAreaFill(), setSymbol(), and symbol().

virtual void casa::ScatterPlot::setSymbolLine

(

const PlotLine &

line

)

[inline, virtual]

Definition at line 187 of file Plot.h.

References casa::PlotSymbol::setLine(), setSymbol(), and symbol().

Referenced by setSymbolLine().

virtual void casa::ScatterPlot::setSymbolLine

(

const PlotLinePtr

line

)

[inline, virtual]

Definition at line 192 of file Plot.h.

References casa::SimpleCountedConstPtr< t >::null(), and setSymbolLine().

virtual void casa::ScatterPlot::setSymbolLine	(	const String &	color,
		PlotLine::Style	style = PlotLine::SOLID,
		double	width = 1.0
	)		[inline, virtual]

Definition at line 194 of file Plot.h.

References casa::PlotSymbol::setLine(), setSymbol(), and symbol().

virtual void casa::ScatterPlot::setSymbolSize	(	double	width,
		double	height
	)		[inline, virtual]

Definition at line 182 of file Plot.h.

References casa::PlotSymbol::setSize(), setSymbol(), and symbol().

virtual void casa::ScatterPlot::setSymbolsShown

(

bool

symbolsShown = true

)

[pure virtual]

Sets whether symbols are shown or not.

If symbolsShown is true, the implementation can decide whether to choose the symbol shown, or just use the last set PlotSymbol.

Referenced by setSymbol().

virtual PlotSymbolPtr casa::ScatterPlot::symbol

(

)

const [pure virtual]

Returns a copy of the symbol for this plot.

Note: if symbols are not shown, then this behavior is undefined. The last shown symbol can be returned, or a symbol with style NOSYMBOL, or a null pointer, or....

Referenced by setSymbol(), setSymbolAreaFill(), setSymbolLine(), and setSymbolSize().

virtual bool casa::ScatterPlot::symbolsShown

(

)

const [pure virtual]

Returns true if symbols are shown, false otherwise.

---

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

• code/graphics/GenericPlotter/Plot.h