oaBlockDomainVisibility Class Reference


Public Methods

 oaBlockDomainVisibility (oaBlockDomainVisibilityEnum valueIn)
 oaBlockDomainVisibility (const oaString &name)
 ~oaBlockDomainVisibility ()
const oaString & getName () const
 operator oaBlockDomainVisibilityEnum () const

Detailed Description

The oaBlockDomainVisibility class is an enum wrapper class that can indicate how an object in the block domain relates to objects in the module domain.

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

enum oaBlockDomainVisibilityEnum
 

Enumeration values:
oacInheritFromTopBlock  "inheritFromTopBlock" The visibility of this object is the same as the top block in this design
oacExcludeFromModuleDomain  "excludeFromModuleDomain" This is a physical only object that does not have a corresponding object in the module domain

Constructor & Destructor Documentation

oaBlockDomainVisibility::oaBlockDomainVisibility (  oaBlockDomainVisibilityEnum    typeIn )  [inline]
 

This function constructs an instance of an oaBlockDomainVisibility class using the specified oaBlockDomainVisibilityEnum value.

oaBlockDomainVisibility::oaBlockDomainVisibility (  const oaString &    name ) 
 

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

Exceptions:
oacInvalidBlockDomainVisibilityName 

oaBlockDomainVisibility::~oaBlockDomainVisibility (    )  [inline]
 

This function destroys this oaBlockDomainVisibility instance.

Member Function Documentation

const oaString & oaBlockDomainVisibility::getName (    )  const
 

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

oaBlockDomainVisibility::operator oaBlockDomainVisibilityEnum (    )  const [inline]
 

This operator casts this oaBlockDomainVisibility object into the corresponding oaBlockDomainVisibilityEnum 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.