RVC::RASTERTHEMEPARM Class Reference

#include <rvc/rasterthemeparm.h>

Inheritance diagram for RVC::RASTERTHEMEPARM:
Inheritance graph
[legend]

List of all members.

Classes

struct  SPREAD

Public Types

enum  COLORPATH {
  COLORPATH_Auto = 0, COLORPATH_RGB, COLORPATH_HISCW, COLORPATH_HISCCW,
  COLORPATH_HBSCW, COLORPATH_HBSCCW, COLORPATH_MaxAuto = COLORPATH_HBSCCW
}
enum  DISTRIB { DISTRIB_UserDefined = 0, DISTRIB_EqualCount, DISTRIB_EqualInterval }
enum  ROUNDMODE { ROUNDMODE_None = 0, ROUNDMODE_Closest, ROUNDMODE_Down, ROUNDMODE_Up }

Public Member Functions

 RASTERTHEMEPARM (const RVC::RASTERTHEMEPARM &rhs)
 RASTERTHEMEPARM ()
virtual ~RASTERTHEMEPARM ()
const SIMPLE_ARRAY< double > & GetClassBoundaries () const
DISTRIB GetDistribMode () const
INT16 GetNumClasses () const
ROUNDMODE GetRoundMode () const
double GetRoundTo () const
const SPREADGetSpread () const
bool IsFirstClassExcluded () const
bool IsLastClassExcluded () const
bool IsLimitedToDataRange () const
bool IsUpperInclusive () const
RVC::RASTERTHEMEPARMoperator= (const RVC::RASTERTHEMEPARM &rhs)
void SetClassBoundaries (const SIMPLE_ARRAY< double > &boundaries)
void SetDistribMode (DISTRIB distribmode)
void SetExcludeFirstClass (bool excludefirstclass)
void SetExcludeLastClass (bool excludelastclass)
void SetLimitToDataRange (bool limittorange)
void SetNumClasses (INT16 numclasses)
void SetRoundMode (ROUNDMODE roundmode)
void SetRoundTo (double roundto)
void SetSpread (const SPREAD &spread)
void SetUpperIsInclusive (bool isupperinclusive)

Member Enumeration Documentation

Enumerator:
COLORPATH_Auto 
COLORPATH_RGB 
COLORPATH_HISCW 
COLORPATH_HISCCW 
COLORPATH_HBSCW 
COLORPATH_HBSCCW 
COLORPATH_MaxAuto 
Enumerator:
DISTRIB_UserDefined 
DISTRIB_EqualCount 
DISTRIB_EqualInterval 
Enumerator:
ROUNDMODE_None 
ROUNDMODE_Closest 
ROUNDMODE_Down 
ROUNDMODE_Up 

Constructor & Destructor Documentation

RVC::RASTERTHEMEPARM::RASTERTHEMEPARM (  ) 

Default constructor.

RVC::RASTERTHEMEPARM::RASTERTHEMEPARM ( const RVC::RASTERTHEMEPARM rhs  ) 

Copy constructor.

virtual RVC::RASTERTHEMEPARM::~RASTERTHEMEPARM (  )  [virtual]

Destructor.


Member Function Documentation

const SIMPLE_ARRAY<double>& RVC::RASTERTHEMEPARM::GetClassBoundaries (  )  const [inline]

Boundaries of the ranges for the classes.

DISTRIB RVC::RASTERTHEMEPARM::GetDistribMode (  )  const [inline]

Distribution mode, DISTRIB_...

INT16 RVC::RASTERTHEMEPARM::GetNumClasses (  )  const [inline]

Get Number of classes in the distribution. Note it will be one less than the number of class boundaries.

ROUNDMODE RVC::RASTERTHEMEPARM::GetRoundMode (  )  const [inline]

Rounding mode, ROUNDMODE_...

double RVC::RASTERTHEMEPARM::GetRoundTo (  )  const [inline]

Interval to round to.

const SPREAD& RVC::RASTERTHEMEPARM::GetSpread (  )  const [inline]
bool RVC::RASTERTHEMEPARM::IsFirstClassExcluded (  )  const [inline]

Exclude first class from distribution.

bool RVC::RASTERTHEMEPARM::IsLastClassExcluded (  )  const [inline]

Exclude last class from distribution.

bool RVC::RASTERTHEMEPARM::IsLimitedToDataRange (  )  const [inline]

Limit class value ranges to existing data range.

bool RVC::RASTERTHEMEPARM::IsUpperInclusive (  )  const [inline]

For floating point rasters set true if the cell on the boundary is included in the upper range.

RVC::RASTERTHEMEPARM& RVC::RASTERTHEMEPARM::operator= ( const RVC::RASTERTHEMEPARM rhs  ) 

Assignment.

Reimplemented from RVC::SIMPLE.

void RVC::RASTERTHEMEPARM::SetClassBoundaries ( const SIMPLE_ARRAY< double > &  boundaries  ) 

Set Boundaries of the ranges for the classes.

void RVC::RASTERTHEMEPARM::SetDistribMode ( DISTRIB  distribmode  )  [inline]

Set the distribution mode.

void RVC::RASTERTHEMEPARM::SetExcludeFirstClass ( bool  excludefirstclass  )  [inline]

Set whether to Exclude first class from distribution.

void RVC::RASTERTHEMEPARM::SetExcludeLastClass ( bool  excludelastclass  )  [inline]

Set whether to Exclude last class from distribution.

void RVC::RASTERTHEMEPARM::SetLimitToDataRange ( bool  limittorange  )  [inline]

Set Limit class value ranges to existing data range.

void RVC::RASTERTHEMEPARM::SetNumClasses ( INT16  numclasses  )  [inline]

Set the number of classes.

void RVC::RASTERTHEMEPARM::SetRoundMode ( ROUNDMODE  roundmode  )  [inline]

Set the Rounding mode, ROUNDMODE_...

void RVC::RASTERTHEMEPARM::SetRoundTo ( double  roundto  )  [inline]

Set Interval to round to.

void RVC::RASTERTHEMEPARM::SetSpread ( const SPREAD spread  ) 

Set the color spread.

void RVC::RASTERTHEMEPARM::SetUpperIsInclusive ( bool  isupperinclusive  )  [inline]

Set Whether the range is upper inclusive.


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

Generated on Sun Oct 7 21:37:56 2012 for TNTsdk 2012 by  doxygen 1.6.1