oaUserUnitsType Class Reference


Public Methods
	oaUserUnitsType (oaUserUnitsTypeEnum valueIn)
	oaUserUnitsType (const oaString &name)
	~oaUserUnitsType ()
const oaString &	getName () const
	operator oaUserUnitsTypeEnum () const

Detailed Description

The oaUserUnitsType class encapsulates the enumerated values that describe the different types of user units.

enum oaUserUnitsTypeEnum

Enumeration values:

oacMicron "micron"

oacMillimeter "millimeter"

oacCentimeter "centimeter"

oacMeter "meter"

oacMil "mil"

oacInch "inch"

oacNanometer "nanometer"

Constructor & Destructor Documentation

oaUserUnitsType::oaUserUnitsType ( oaUserUnitsTypeEnum valueIn ) [inline]

This function constructs an instance of an oaUserUnitsType class using the specified oaUserUnitsTypeEnum value.

oaUserUnitsType::oaUserUnitsType ( const oaString & name )

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

Exceptions:

oacInvalidUserUnitsTypeName

oaUserUnitsType::~oaUserUnitsType ( ) [inline]

This function destroys this oaUserUnitsType class.

Member Function Documentation

const oaString & oaUserUnitsType::getName ( ) const

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

oaUserUnitsType::operator oaUserUnitsTypeEnum ( ) const [inline]

This operator casts this oaUserUnitsType object into the corresponding oaUserUnitsTypeEnum value.

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

Return to top of page

oaUserUnitsType Class Reference

Public Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation