oaDistanceMeasureType Class Reference


Public Methods

 oaDistanceMeasureType (oaDistanceMeasureTypeEnum valueIn)
 oaDistanceMeasureType (const oaString &name)
 ~oaDistanceMeasureType ()
const oaStringgetName () const
 operator oaDistanceMeasureTypeEnum () const

Detailed Description

The oaDistanceMeasureType class is an enum wrapper class for oaDistanceMeasureTypeEnum values.

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

enum oaDistanceMeasureTypeEnum
 

Enumeration values:
oacEuclidianDistanceMeasureType  "euclidian"
oacManhattanDistanceMeasureType  "manhattan"


Constructor & Destructor Documentation

oaDistanceMeasureType::oaDistanceMeasureType oaDistanceMeasureTypeEnum    valueIn [inline]
 

This constructor for the oaDistanceMeasureType wrapper class takes an oaDistanceMeasureTypeEnum value.

Parameters:
valueIn An oaDistanceMeasureTypeEnum value.

oaDistanceMeasureType::oaDistanceMeasureType const oaString &    name
 

This constructor for oaDistanceMeasureType wrapper class takes the oaString name of an oaDistanceMeasureTypeEnum value as input.

Parameters:
name The oaString name of an oaDistanceMeasureTypeEnum value.
Exceptions:
oacInvalidDistanceMeasureTypeName 

oaDistanceMeasureType::~oaDistanceMeasureType   [inline]
 

This is the oaDistanceMeasureType destructor.


Member Function Documentation

const oaString & oaDistanceMeasureType::getName   const
 

This function returns the string name that corresponds to the oaDistanceMeasureTypeEnum value represented by this oaDistanceMeasureType.

oaDistanceMeasureType::operator oaDistanceMeasureTypeEnum   const [inline]
 

This operator recasts this oaDistanceMeasureType to the oaDistanceMeasureTypeEnum value it represents.


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

Return to top of page