casa::PlotLine Class Reference

Abstract class for a line. More...

#include <PlotOptions.h>

List of all members.

Public Types
enum	Style {   SOLID,   DASHED,   DOTTED,   NOLINE }
	Static //. More...
Public Member Functions
	PlotLine ()
	Non-Static //.
virtual	~PlotLine ()
	Destructor.
virtual double	width () const =0
	ABSTRACT METHODS //.
virtual void	setWidth (double width)=0
	Sets the width to the given.
virtual Style	style () const =0
	Returns this line's style.
virtual void	setStyle (Style style)=0
	Sets the style to the given.
virtual PlotColorPtr	color () const =0
	Returns a copy of the color used for this line.
virtual void	setColor (const PlotColor &color)=0
	Sets this line's color to the given.
virtual void	setColor (const PlotColorPtr c)
	CONVENIENCE METHODS //.
virtual void	setColor (const String &col)
virtual Record	toRecord () const
	RECORD METHODS //.
virtual void	fromRecord (const Record &record)
virtual PlotLine &	operator= (const PlotLine &rh)
	OPERATORS //.
virtual bool	operator== (const PlotLine &rh) const
	Returns true if this PlotLine is equal to the given; false otherwise.
virtual bool	operator!= (const PlotLine &rh) const
	Returns true if this PlotLine is NOT equal to the given; false otherwise.
Static Protected Attributes
static const String	REC_WIDTH
	Record key names.
static const String	REC_STYLE
static const String	REC_COLOR

---

Detailed Description

Abstract class for a line.

A line has a color, style, and width.

Definition at line 358 of file PlotOptions.h.

---

Member Enumeration Documentation

enum casa::PlotLine::Style

Static //.

Line styles.

Enumerator:

SOLID
DASHED
DOTTED
NOLINE

Definition at line 363 of file PlotOptions.h.

---

Constructor & Destructor Documentation

casa::PlotLine::PlotLine

(

)

Non-Static //.

Constructor.

virtual casa::PlotLine::~PlotLine

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual PlotColorPtr casa::PlotLine::color

(

)

const [pure virtual]

Returns a copy of the color used for this line.

virtual void casa::PlotLine::fromRecord

(

const Record &

record

)

[virtual]

virtual bool casa::PlotLine::operator!=

(

const PlotLine &

rh

)

const [virtual]

Returns true if this PlotLine is NOT equal to the given; false otherwise.

virtual PlotLine& casa::PlotLine::operator=

(

const PlotLine &

rh

)

[virtual]

OPERATORS //.

Assigns the value of the given PlotLine to this one.

virtual bool casa::PlotLine::operator==

(

const PlotLine &

rh

)

const [virtual]

Returns true if this PlotLine is equal to the given; false otherwise.

virtual void casa::PlotLine::setColor

(

const PlotColor &

color

)

[pure virtual]

Sets this line's color to the given.

Referenced by casa::ErrorPlot::setErrorLine(), casa::ErrorPlot::setErrorLineColor(), casa::Plot::setLine(), casa::PlotShape::setLine(), casa::Plot::setLineColor(), casa::MaskedScatterPlot::setMaskedLine(), casa::MaskedScatterPlot::setMaskedLineColor(), and casa::PlotAnnotation::setOutline().

virtual void casa::PlotLine::setColor

(

const PlotColorPtr

c

)

[virtual]

CONVENIENCE METHODS //.

Convenience methods for setting color.

virtual void casa::PlotLine::setColor

(

const String &

col

)

[virtual]

virtual void casa::PlotLine::setStyle

(

Style

style

)

[pure virtual]

Sets the style to the given.

Referenced by casa::ErrorPlot::setErrorLine(), casa::ErrorPlot::setErrorLineStyle(), casa::Plot::setLine(), casa::PlotShape::setLine(), casa::Plot::setLineStyle(), casa::MaskedScatterPlot::setMaskedLine(), casa::MaskedScatterPlot::setMaskedLineStyle(), and casa::PlotAnnotation::setOutline().

virtual void casa::PlotLine::setWidth

(

double

width

)

[pure virtual]

Sets the width to the given.

Referenced by casa::ErrorPlot::setErrorLine(), casa::ErrorPlot::setErrorLineWidth(), casa::Plot::setLine(), casa::PlotShape::setLine(), casa::Plot::setLineWidth(), casa::MaskedScatterPlot::setMaskedLine(), casa::MaskedScatterPlot::setMaskedLineWidth(), and casa::PlotAnnotation::setOutline().

virtual Style casa::PlotLine::style

(

)

const [pure virtual]

Returns this line's style.

virtual Record casa::PlotLine::toRecord

(

)

const [virtual]

RECORD METHODS //.

Gets/Sets the color as a Record.

virtual double casa::PlotLine::width

(

)

const [pure virtual]

ABSTRACT METHODS //.

Returns this line's width.

---

Member Data Documentation

const String casa::PlotLine::REC_COLOR [static, protected]

Definition at line 433 of file PlotOptions.h.

const String casa::PlotLine::REC_STYLE [static, protected]

Definition at line 432 of file PlotOptions.h.

const String casa::PlotLine::REC_WIDTH [static, protected]

Record key names.

Definition at line 431 of file PlotOptions.h.

---

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

• code/graphics/GenericPlotter/PlotOptions.h