casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
casa::PlotRegion Class Reference

A PlotRegion is basically just a wrapper for two PlotCoordinates: an upper left coordinate and a lower right coordinate. More...

#include <PlotOptions.h>

List of all members.

Public Member Functions

 PlotRegion ()
 Default constructor.
 PlotRegion (const PlotCoordinate &upperLeft, const PlotCoordinate &lowerRight)
 Parameterized constructor.
 PlotRegion (const PlotRegion &copy)
 Copy constructor.
 ~PlotRegion ()
 Destructor.
const PlotCoordinate & upperLeft () const
 Returns the upper left coordinate.
const PlotCoordinate & lowerRight () const
 Returns the lower right coordinate.
double top () const
 Returns the top y value.
double bottom () const
 Returns the bottom y value.
double left () const
 Returns the left x value.
double right () const
 Returns the right x value.
bool isValid () const
 Returns true if the region is valid, false otherwise.

Private Attributes

PlotCoordinate m_upperLeft
 Upper-left coordinate.
PlotCoordinate m_lowerRight
 Lower-right coordinate.

Detailed Description

A PlotRegion is basically just a wrapper for two PlotCoordinates: an upper left coordinate and a lower right coordinate.

Definition at line 664 of file PlotOptions.h.


Constructor & Destructor Documentation

Default constructor.

casa::PlotRegion::PlotRegion ( const PlotCoordinate &  upperLeft,
const PlotCoordinate &  lowerRight 
)

Parameterized constructor.

Copy constructor.

Destructor.


Member Function Documentation

double casa::PlotRegion::bottom ( ) const

Returns the bottom y value.

bool casa::PlotRegion::isValid ( ) const

Returns true if the region is valid, false otherwise.

double casa::PlotRegion::left ( ) const

Returns the left x value.

const PlotCoordinate& casa::PlotRegion::lowerRight ( ) const

Returns the lower right coordinate.

double casa::PlotRegion::right ( ) const

Returns the right x value.

double casa::PlotRegion::top ( ) const

Returns the top y value.

const PlotCoordinate& casa::PlotRegion::upperLeft ( ) const

Returns the upper left coordinate.


Member Data Documentation

PlotCoordinate casa::PlotRegion::m_lowerRight [private]

Lower-right coordinate.

Definition at line 706 of file PlotOptions.h.

PlotCoordinate casa::PlotRegion::m_upperLeft [private]

Upper-left coordinate.

Definition at line 703 of file PlotOptions.h.


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