oaCMObjectRef Class Reference

Inheritance diagram for oaCMObjectRef:

oaCMDatabaseRef oaCMObjectIDRef oaCMObjectStateRef


Public Methods

virtual void passivate ()
virtual void activate ()
virtual DatabaseSPtr getDatabase () const=0
oaBoolean isAlive () const
oaBoolean isNew () const
oaTimeStamp getTimeStamp () const
void setIsNew (oaBoolean isNew)

Public Types

typedef oaCMObjectRef * SPtr
typedef oaCMDatabaseRef * DatabaseSPtr

Friends

class oaCMObjectRefTbl

Detailed Description

The oaCMObjectRef class is an abstract class that adds lifecycle management to schema representation (sr) object references, and is used in the OpenAccess Change Management System (CMS).

An oaCMObjectRef is an object reference that is managed by an oaChangeSet.

Member Typedef Documentation

typedef oaCMDatabaseRef* oaCMObjectRef::DatabaseSPtr
 

typedef oaCMObjectRef* oaCMObjectRef::SPtr
 

Reimplemented in oaCMDatabaseRef, oaCMObjectIDRef, and oaCMObjectStateRef.

Member Function Documentation

void oaCMObjectRef::activate (    )  [virtual]
 

This function resets a boolean flag on the oaCMObjectRef to indicate that the corresponding live object for this reference has been recreated (due to an undo operation after the live object was destroyed).

Reimplemented in oaCMDatabaseRef, oaCMObjectIDRef, and oaCMObjectStateRef.

oaCMDatabaseRef::SPtr oaCMObjectRef::getDatabase (    )  const [pure virtual]
 

This function returns a smart pointer to the database for this oaCMObjectRef.

Implemented in oaCMDatabaseRef, oaCMObjectIDRef, and oaCMObjectStateRef.

oaTimeStamp oaCMObjectRef::getTimeStamp (    )  const
 

This function returns the timestamp for the object that was assigned during its construction.

oaBoolean oaCMObjectRef::isAlive (    )  const
 

This function returns true if this oaCMObjectRef refers to a live object.

oaBoolean oaCMObjectRef::isNew (    )  const
 

This function returns true if this oaCMObjectRef refers to an object that was created during the course of this change set.

void oaCMObjectRef::passivate (    )  [virtual]
 

This function sets a boolean flag on the oaCMObjectRef to indicate that the corresponding live object for this reference has been destroyed.

Reimplemented in oaCMDatabaseRef, oaCMObjectIDRef, and oaCMObjectStateRef.

void oaCMObjectRef::setIsNew (  oaBoolean    isNew ) 
 

This function sets the oaBoolean flag that indicates whether or not the object associated with this reference was created during the course of the containing change set.

Parameters:
isNew Set to true or false.

Friends And Related Function Documentation

friend class oaCMObjectRefTbl [friend]
 

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.