oaCategory Class Reference


Public Methods

 oaCategory ()
 oaCategory (oaCategoryEnum typeIn)
 oaCategory (const oaString &name)
 ~oaCategory ()
const oaStringgetName () const
 operator oaCategoryEnum () const

Detailed Description

The oaCategory class is an enum wrapper class for oaCategoryEnum values. It represents a portion of the OpenAccess data model.

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

enum oaCategoryEnum
 

Enumeration values:
oacFutureCategory  "Future"
oacConstraintCategory  "Constraint"
oacValueCategory  "Value"
oacAnnotationCategory  "Annotation"
oacApplicationDefinedCategory  "ApplicationDefined"
oacNameCategory  "Name"
oacObserverCategory  "Observer"
oacDesignManagementCategory  "DesignManagement"
oacTechCategory  "Technology"
oacWaferCategory  "Wafer"
oacDesignHierarchyCategory  "DesignHierarchy"
oacGeometryCategory  "Geometry"
oacPlaceAndRouteCategory  "PlaceAndRoute"
oacConnectivityCategory  "Connectivity"
oacParasiticsCategory  "Parasitics"
oacPlugInCategory  "PlugIn"
oacGroupManagementCategory  "GroupManagement"
oacViaVariantCategory  "ViaVariant"


Constructor & Destructor Documentation

oaCategory::oaCategory   [inline]
 

This is the default constructor for the oaCategory class enum wrapper.

oaCategory::oaCategory oaCategoryEnum    typeIn [inline]
 

This constructor for the oaCategory class enum wrapper takes an oaCategoryEnum as input.

Parameters:
typeIn an oaCategoryEnum

oaCategory::oaCategory const oaString &    name
 

This constructor creates an oaCategory object based on the constant string value that represents the category type.

Parameters:
name A reference to a constant oaString object that holds the category type name
Exceptions:
oacInvalidCategoryName 

oaCategory::~oaCategory   [inline]
 

This is the oaCategory destructor.


Member Function Documentation

const oaString & oaCategory::getName   const
 

This function returns the string name that corresponds to the enum value of this oaCategory class object.

oaCategory::operator oaCategoryEnum   const [inline]
 

This operator returns the enumerated value that corresponds to the category type that this object represents.


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

Return to top of page