oaObject Class Reference

Inheritance diagram for oaObject:

oaAppObject oaConstraint oaConstraintGroup oaConstraintGroupHeader oaConstraintGroupMem oaConstraintParam oaDesignObject oaDMData oaDMObject oaGroup oaGroupMember oaProp oaSessionObject oaTechObject oaValue oaViaVariant oaViaVariantHeader oaWaferObject


Public Methods

oaBoolean isValid () const
oaType getType () const
oaDomain getDomain () const
oaBoolean isTech () const
oaBoolean isDesign () const
oaBoolean isDM () const
oaBoolean isDMData () const
oaBoolean isWafer () const
oaBoolean isSession () const
oaBoolean isProp () const
oaBoolean isGroup () const
oaBoolean isGroupMember () const
oaBoolean isAppObject () const
oaBoolean isConstraint () const
oaBoolean isConstraintGroup () const
oaBoolean isConstraintGroupMem () const
oaBoolean isConstraintGroupHeader () const
oaBoolean isConstraintParam () const
oaBoolean isValue () const
oaBoolean isViaVariant () const
oaBoolean isViaVariantHeader () const
oaBoolean hasProp () const
oaBoolean inGroup () const
oaBoolean hasAppDef () const
oaBoolean hasConstraintGroup () const
oaBoolean hasAssociate () const
oaConstraintGroupgetConstraintGroup () const
oaObject * getDatabase () const
oaCollection< oaProp, oaObject > getProps () const
oaCollection< oaAppDef, oaObject > getAppDefs () const
oaCollection< oaGroupMember, oaObject > getGroupMems () const
oaCollection< oaGroupMember, oaObject > getGroupLeaders () const
oaCollection< oaGroup, oaObject > getGroupsOwnedBy () const

Public Types

enum  { dbType = oacBaseDBType }
enum  { domain = oacNoDomain }

Protected Methods

 ~oaObject ()

Friends

class oaObjectPage

Detailed Description

The oaObject class is an abstract class that is the base class for all persistent objects managed by the OpenAccess code. All managed objects in design databases, technology databases, and library databases are derived from oaObject. The oaObject class implements utility functions that apply generically to managed objects. See the Managed Classes section in the Programmers Guide for more discussion.


Constructor & Destructor Documentation

oaObject::~oaObject   [protected]
 

Because oaObjects are managed by OpenAccess, they are never constructed or destroyed directly by applications. To prevent this from occurring, the destructors are marked as protected. Applications that call this function will generate a compiler error.


Member Function Documentation

oaCollection< oaAppDef, oaObject > oaObject::getAppDefs   const
 

This function returns the collection of oaAppDef extensions defined on this object.

oaConstraintGroup * oaObject::getConstraintGroup   const
 

This function returns the built-in constraint group for this object. If no constraint group previously existed, one will be created by this call. If the application is only reading existing constraints, it is more efficient to call hasConstraintGroup() first to determine whether a group exists before making this call.

This constraint group is used to hold constraints that are applied directly to the given object. Constraints are applied by putting them in this group with oaConstraintGroupMem::create(). Both individual constraints and constraint groups may be placed in this constraint group.

Objects in design, tech, and wafer databases have built-in constraint groups except that parasitic objects do not support them. DM and Session objects cannot have them.

Reimplemented in oaConstraintGroupMem, and oaConstraintGroupHeader.

oaObject * oaObject::getDatabase   const
 

This function returns a pointer to the database containing this object. The returned object will belong to one of the following classes: oaDesign, oaTech, oaWafer, oaLib or oaSession. When called on one of these database classes, getDatabase() will return a pointer to the object it is called on.

Exceptions:
oacNoObjectDB 

oaDomain oaObject::getDomain   const
 

This function returns the domain of the object. For objects in Designs the domain specifies if it is part of the block, module, or occurrence hierarchies. Other design objects and all objects in other databases return oacNoDomain. See oaDomain for more information.

Reimplemented in oaFeature, oaParasiticNetwork, and oaReducedModel.

oaCollection oaObject::getGroupLeaders   const
 

This function returns a collection of oaGroupMember objects that represent the relationship between this object and each of the groups of which this object is a leader.

oaCollection oaObject::getGroupMems   const
 

This function returns a collection of the oaGroupMember objects that represent the relationship between this object and each of the groups to which this object belongs.

Exceptions:
oacInvalidGroupObject If called for an oaObject that is a database class because a database cannot belong to a group.

oaCollection oaObject::getGroupsOwnedBy   const
 

This function returns a collection of the oaGroups to which this object belongs. In other words, it may be helpful to think of the name of this function as "get the Groups this object is Owned By."

Since the database classes cannot belong to groups, it is illegal to call this on an oaDesign, oaTech, oaWafer or oaLib.

Exceptions:
oacInvalidGroupObject If called for an oaObject that is a database class because a database cannot belong to a group.

oaCollection oaObject::getProps   const
 

This function returns a collection of properties on this object.

oaType oaObject::getType   const
 

This function returns the detailed type of the object as an oaTypeEnum value.

oaBoolean oaObject::hasAppDef   const
 

This function returns a Boolean indicating whether or not this object has any appDef values associated with it.

oaBoolean oaObject::hasAssociate   const
 

This function returns a boolean value that indicates if this object is associated with a textDisplay object.

oaBoolean oaObject::hasConstraintGroup   const
 

This function returns a boolean indicating whether or not there are constraints associated with this object.

oaBoolean oaObject::hasProp   const
 

This function returns a Boolean indicating whether or not this object has any properties attached to it.

oaBoolean oaObject::inGroup   const
 

This function returns a boolean value that indicates if this object is in any group.

oaBoolean oaObject::isAppObject   const
 

This function returns a boolean value that indicates if this object is an extension object.

oaBoolean oaObject::isConstraint   const
 

This function returns a boolean indicating whether or not this object is a constraint.

oaBoolean oaObject::isConstraintGroup   const
 

This function returns a boolean indicating whether or not this object is a constraint group.

oaBoolean oaObject::isConstraintGroupHeader   const
 

This function returns a boolean indicating whether or not this object is a constraint group header.

oaBoolean oaObject::isConstraintGroupMem   const
 

This function returns a boolean indicating whether or not this object is a constraint group member.

oaBoolean oaObject::isConstraintParam   const
 

This function returns a boolean indicating whether or not this object is a constraint parameter.

oaBoolean oaObject::isDesign   const
 

This function returns a boolean value that indicates if this object is contained in a design database (design).

oaBoolean oaObject::isDM   const
 

This function returns true if this object represents a design management object; False otherwise.

oaBoolean oaObject::isDMData   const
 

This function returns a boolean indicating whether or not this object is a dmData object.

oaBoolean oaObject::isGroup   const
 

This function returns a boolean value that indicates if this object is a group object.

oaBoolean oaObject::isGroupMember   const
 

This function returns a boolean value that indicates if this object is a group member object.

oaBoolean oaObject::isProp   const
 

This function returns a boolean value that indicates if this object is a property object.

oaBoolean oaObject::isSession   const
 

This function returns true if this object represents an object that belongs to the session database; False otherwise.

oaBoolean oaObject::isTech   const
 

This function returns true if this object represents a technology database object; False otherwise.

oaBoolean oaObject::isValid   const
 

This function verifies that a pointer is a valid database object and that it is safe to use this pointer with other database object member functions. NULL values and pointers that are outside of the memory used by OpenAccess return false. Misaligned pointers return false. A pointer to an object that is deleted might or might not return false. If the location is re-used for another OpenAccess object, the function returns true. If the space is still unused, this function returns false.

The isValid() function performs a hash table lookup as part of the validation process. Although the performance is as fast as possible, applications should not call this function more than necessary.

oaBoolean oaObject::isValue   const
 

This function returns true if this object is a value; False otherwise.

oaBoolean oaObject::isViaVariant   const
 

This function returns true if the object is of type oaStdViaVariant or oaCustomViaVariant; Otherwise false is returned.

oaBoolean oaObject::isViaVariantHeader   const
 

This function returns true if this object is an oaViaVariantHeader; False otherwise.

oaBoolean oaObject::isWafer   const
 

This function returns true if this object represents an object that belongs to the wafer database; False otherwise.


Friends And Related Function Documentation

friend class oaObjectPage [friend]
 


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
dbType 

anonymous enum
 

Enumeration values:
domain 


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

Return to top of page