casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
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>

Public Member Functions

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

Private Attributes

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

Detailed Description

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

Definition at line 682 of file PlotOptions.h.

Constructor & Destructor Documentation

casa::PlotRegion::PlotRegion ( )

Default constructor.

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

Parameterized constructor.

casa::PlotRegion::PlotRegion ( const PlotRegion copy)

Copy constructor.

casa::PlotRegion::~PlotRegion ( )

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 724 of file PlotOptions.h.

PlotCoordinate casa::PlotRegion::m_upperLeft
private

Upper-left coordinate.

Definition at line 721 of file PlotOptions.h.


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