oaClearanceMeasure Class Reference


Public Methods

 oaClearanceMeasure (oaClearanceMeasureEnum valueIn)
 oaClearanceMeasure (const oaString &name)
 ~oaClearanceMeasure ()
const oaStringgetName () const
 operator oaClearanceMeasureEnum () const

Detailed Description

The oaClearanceMeasure class encapsulates the enumerated values that describe the different types of clearance measurements.

enum oaClearanceMeasureEnum
 

Enumeration values:
oacEuclidianClearanceMeasure  "euclidian"
oacMaxXYClearanceMeasure  "maxXY"


Constructor & Destructor Documentation

oaClearanceMeasure::oaClearanceMeasure oaClearanceMeasureEnum    valueIn [inline]
 

This function constructs an instance of an oaClearanceMeasure class using the specified oaClearanceMeasureEnum value.

oaClearanceMeasure::oaClearanceMeasure const oaString &    name
 

This function constructs an instance of an oaClearanceMeasure class using the oaClearanceMeasureEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaClearanceMeasureEnum.

Exceptions:
oacInvalidClearanceMeasureTypeName 

oaClearanceMeasure::~oaClearanceMeasure   [inline]
 

This function destroys this oaClearanceMeasure class.


Member Function Documentation

const oaString & oaClearanceMeasure::getName   const
 

This function returns the name string associated with the encapsulated oaClearanceMeasureEnum object.

oaClearanceMeasure::operator oaClearanceMeasureEnum   const [inline]
 

This operator casts this oaClearanceMeasure object into the corresponding oaClearanceMeasureEnum value.


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

Return to top of page