oaSiteDefType Class Reference


Public Methods

 oaSiteDefType (oaSiteDefTypeEnum valueIn)
 oaSiteDefType (const oaString &name)
 ~oaSiteDefType ()
const oaStringgetName () const
 operator oaSiteDefTypeEnum () const

Detailed Description

The oaSiteDefType class encapsulates the enumerated values that describe the different uses of an oaSiteDef object.

enum oaSiteDefTypeEnum
 

Enumeration values:
oacPadSiteDefType  "pad"
oacCoreSiteDefType  "core"


Constructor & Destructor Documentation

oaSiteDefType::oaSiteDefType oaSiteDefTypeEnum    valueIn [inline]
 

This function constructs an instance of an oaSiteDefType class using the specified oaSiteDefTypeEnum value.

oaSiteDefType::oaSiteDefType const oaString &    name
 

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

Exceptions:
oacInvalidSiteDefTypeName 

oaSiteDefType::~oaSiteDefType   [inline]
 

This function destroys this oaSiteDefType class.


Member Function Documentation

const oaString & oaSiteDefType::getName   const
 

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

oaSiteDefType::operator oaSiteDefTypeEnum   const [inline]
 

This operator casts this oaSiteDefType object into the corresponding oaSiteDefTypeEnum value.


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

Return to top of page