casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Protected Attributes | List of all members
casa::PlotLine Class Referenceabstract

Abstract class for a line. More...

#include <PlotOptions.h>

Public Types

enum  Style {
  SOLID,
  DASHED,
  DOTTED,
  NOLINE
}
 Static //. More...
 

Public Member Functions

 PlotLine ()
 Non-Static //. More...
 
virtual ~PlotLine ()
 Destructor. More...
 
virtual double width () const =0
 ABSTRACT METHODS //. More...
 
virtual void setWidth (double width)=0
 Sets the width to the given. More...
 
virtual Style style () const =0
 Returns this line's style. More...
 
virtual void setStyle (Style style)=0
 Sets the style to the given. More...
 
virtual PlotColorPtr color () const =0
 Returns a copy of the color used for this line. More...
 
virtual void setColor (const PlotColor &color)=0
 Sets this line's color to the given. More...
 
virtual void setColor (const PlotColorPtr c)
 CONVENIENCE METHODS //. More...
 
virtual void setColor (const casacore::String &col)
 
virtual casacore::Record toRecord () const
 RECORD METHODS //. More...
 
virtual void fromRecord (const casacore::Record &record)
 
virtual PlotLineoperator= (const PlotLine &rh)
 OPERATORS //. More...
 
virtual bool operator== (const PlotLine &rh) const
 Returns true if this PlotLine is equal to the given; false otherwise. More...
 
virtual bool operator!= (const PlotLine &rh) const
 Returns true if this PlotLine is NOT equal to the given; false otherwise. More...
 

Static Protected Attributes

static const casacore::String REC_WIDTH
 casacore::Record key names. More...
 
static const casacore::String REC_STYLE
 
static const casacore::String REC_COLOR
 

Detailed Description

Abstract class for a line.

A line has a color, style, and width.

Definition at line 368 of file PlotOptions.h.

Member Enumeration Documentation

Static //.

Line styles.

Enumerator
SOLID 
DASHED 
DOTTED 
NOLINE 

Definition at line 373 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 casacore::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.

virtual void casa::PlotLine::setColor ( const PlotColorPtr  c)
virtual

CONVENIENCE METHODS //.

Convenience methods for setting color.

virtual void casa::PlotLine::setColor ( const casacore::String col)
virtual
virtual void casa::PlotLine::setStyle ( Style  style)
pure virtual

Sets the style to the given.

virtual void casa::PlotLine::setWidth ( double  width)
pure virtual

Sets the width to the given.

virtual Style casa::PlotLine::style ( ) const
pure virtual

Returns this line's style.

virtual casacore::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 casacore::String casa::PlotLine::REC_COLOR
staticprotected

Definition at line 443 of file PlotOptions.h.

const casacore::String casa::PlotLine::REC_STYLE
staticprotected

Definition at line 442 of file PlotOptions.h.

const casacore::String casa::PlotLine::REC_WIDTH
staticprotected

casacore::Record key names.

Definition at line 441 of file PlotOptions.h.


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