oaDomain Class Reference
Detailed Description
The oaDomain class is an enum wrapper that indicates which hierarchy domain a managed object is in. See oaObject::getDomain for one usage. See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.
Each database object has a domain value, which may be none (oacNoDomain). The domain is an inherent attribute of an object and may not be set by the user.
Objects in the design database may in the block domain (oacBlockDomain), which represents physical hierarchy, the module domain (oacModDomain), which represents logical hierarchy, the occurrence domain (oacOccDomain), which contains the occurrence hierarchy, or no domain (oacNoDomain). Objects belonging to databases other than the design database have no domain.
|
|
- Enumeration values:
-
| oacFutureDomain |
"future" |
| oacNoDomain |
"none" |
| oacBlockDomain |
"block" |
| oacOccDomain |
"occurrence" |
| oacModDomain |
"module" |
|
Constructor & Destructor Documentation
|
|
This function constructs an instance of an oaDomain class using the specified oaDomainEnum value. |
| oaDomain::oaDomain |
( |
const oaString & |
name |
) |
|
|
|
|
This function constructs an instance of an oaDomain class using the oaDomainEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaDomainEnum.
- Exceptions:
-
|
| oaDomain::~oaDomain |
( |
|
) |
[inline] |
|
|
|
This function destroys this oaDomain class. |
Member Function Documentation
| const oaString & oaDomain::getName |
( |
|
) |
const |
|
|
|
This function returns the name string associated with the encapsulated oaDomainEnum object. |
|
|
This operator casts this oaDomain object into the corresponding oaDomainEnum value. |
The documentation for this class was generated from the following files:
Return to top of page
Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.
