oaChangeRec Class Reference

Inheritance diagram for oaChangeRec:

Public Methods
	oaChangeRec (oaChangeSetBase *changeSetIn)
virtual	~oaChangeRec ()
virtual void	accept (oaChangeRecVisitor *visitor, oaBoolean forward=true)=0
oaTimeStamp	getTimeStamp () const
oaChangeSetBase *	getChangeSet () const
oaHierChangeRec *	getParent () const
void	setParent (oaHierChangeRec *parent)
virtual oaBoolean	isMarkerChangeRec () const
virtual oaBoolean	isConvertObjectChangeRec () const
virtual oaBoolean	isCreateObjectChangeRec () const
virtual oaBoolean	isDestroyObjectChangeRec () const

---

Detailed Description

A change record represents a change or an event in the database. A change record includes information about the type of the change, the subject of the change, and the value of the change.

The oaChangeRec class is the base class. Derived classes provide the ability to create change records for:

• Simple leaf-level changes such as a changed attribute value.
• More complex changes with side effects, such as the destruction of a block net. These changes are referred to as hierarchical changes.
• Marker type change records:
  • Design checkpoints used for undo and redo operations.
  • Markers used to indicate the point at which a set of changes in a change set was last exported.

Change records are used by the OpenAccess change management system (CMS).

---

Constructor & Destructor Documentation

oaChangeRec::oaChangeRec (  oaChangeSetBase *    changeSetIn )

This is the oaChangeRec constructor. Parameters: changeSetIn  A pointer to the change set to contain the change record.

oaChangeRec::~oaChangeRec (    )  [virtual]

This is the oaChangeRec destructor.

---

Member Function Documentation

void oaChangeRec::accept (  oaChangeRecVisitor *    visitor, oaBoolean    forward = true )  [pure virtual]

This function accepts a change record visitor to allow access to the change record. It calls the visit function of the specified visitor on this object. The forward parameter indicates the direction in which the change records are being visited. The forward parameter might be set to false if the goal of the visit is to roll back changes due to an undo command. Parameters: visitor  A pointer to the change record visitor to call on this object. forward  Specifies the direction in which change records are being visited. Implemented in oaSetAttributeChangeRec, oaUnsetAttributeChangeRec, oaCreate1to1RelationshipChangeRec, oaCreate1toNRelationshipChangeRec, oaCreate2DTableRelationshipChangeRec, oaDestroy1to1RelationshipChangeRec, oaDestroy1toNRelationshipChangeRec, oaDestroy2DTableRelationshipChangeRec, oaCreateObjectChangeRec, oaDestroyObjectChangeRec, oaConvertObjectChangeRec, oaHierChangeRec, oaMarkerChangeRec, oaExportMarkerChangeRec, and oaTransientMarkerChangeRec.

oaChangeSetBase * oaChangeRec::getChangeSet (    )  const

This function returns the change set that contains this change record.

oaHierChangeRec * oaChangeRec::getParent (    )  const

This function returns the parent change record of this change record.

oaTimeStamp oaChangeRec::getTimeStamp (    )  const

This function returns the time stamp of this change record.

oaBoolean oaChangeRec::isConvertObjectChangeRec (    )  const [virtual]

This function returns true if this is an object type-conversion change record. Reimplemented in oaConvertObjectChangeRec.

oaBoolean oaChangeRec::isCreateObjectChangeRec (    )  const [virtual]

This function returns true if this change record represents the creation of an object; false otherwise. Reimplemented in oaCreateObjectChangeRec.

oaBoolean oaChangeRec::isDestroyObjectChangeRec (    )  const [virtual]

This function returns true if this change record represents the destruction of an object; false otherwise. Reimplemented in oaDestroyObjectChangeRec.

oaBoolean oaChangeRec::isMarkerChangeRec (    )  const [virtual]

This function returns a boolean indicating whether or not this change record represents a marker change record. Marker change records can represent: Design checkpoints used for undo and redo operations. Markers used to indicate the point at which a set of changes in a change set was last exported. Reimplemented in oaMarkerChangeRec.

void oaChangeRec::setParent (  oaHierChangeRec *    parent )

This function sets the parent change record for this change record. Parameters: parent  The parent change record for this set of hierarchical changes.

---

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

• oaChangeRec.h
• oaChangeRec.dox

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.