oaRangeType Class Reference


Public Methods

 oaRangeType (oaRangeTypeEnum valueIn)
 oaRangeType (const oaString &name)
 ~oaRangeType ()
const oaStringgetName () const
 operator oaRangeTypeEnum () const

Detailed Description

The oaRangeType class is an enumeration wrapper class for oaRangeTypeEnum values.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaRangeTypeEnum
 

Enumeration values:
oacLessThanRangeType  "lessThan" where upperBound > variableValue
oacLessThanEqualRangeType  "lessThanEqual" where upperBound >= variableValue
oacGreaterThanRangeType  "greaterThan" where lowerBound < variableValue
oacGreaterThanEqualRangeType  "greaterThanEqual" where lowerBound <= variableValue
oacClosedRangeType  "closed" where lowerBound <= variableValue <= upperBound
oacOpenRangeType  "open" where lowerBound < variableValue < upperBound
oacOpenLeftRangeType  "openLeft" where lowerBound < variableValue <= upperBound
oacOpenRightRangeType  "openRight" where lowerBound <= variableValue < upperBound


Constructor & Destructor Documentation

oaRangeType::oaRangeType oaRangeTypeEnum    valueIn [inline]
 

This constructor for an oaRangeType wrapper object takes an oaRangeTypeEnum value as input.

Parameters:
valueIn An oaRangeTypeEnum value.

oaRangeType::oaRangeType const oaString &    name
 

This constructor for an oaRangeType wrapper object takes the string name of an oaRangeTypeEnum value as input.

Parameters:
name The string name associated with an oaRangeTypeEnum value.
Exceptions:
oacInvalidRangeTypeName 

oaRangeType::~oaRangeType   [inline]
 

This is the oaRangeType destructor.


Member Function Documentation

const oaString & oaRangeType::getName   const
 

This function returns the string name of the oaRangeTypeEnum value represented by this oaRangeType object.

oaRangeType::operator oaRangeTypeEnum   const [inline]
 

This operation recasts this oaRangeType object to the oaRangeTypeEnum value it represents.


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

Return to top of page