oaMarkerChangeRec Class Reference

Inheritance diagram for oaMarkerChangeRec:

oaLeafChangeRec oaChangeRec oaExportMarkerChangeRec oaTransientMarkerChangeRec


Public Methods

 oaMarkerChangeRec (oaChangeSetBase *changeSetIn, oaMarkerChangeRecTypeEnum typeIn, oaCMDatabaseRef::SPtr dbRef)
virtual ~oaMarkerChangeRec ()
virtual oaMarkerChangeRec * clone ()=0
virtual void accept (oaChangeRecVisitor *visitor, oaBoolean forward=true)=0
virtual oaBoolean isMarkerChangeRec () const
oaMarkerChangeRecType getType () const
virtual oaCMDatabaseRef::SPtr getDatabaseRef () const
void setDatabaseRef (oaCMDatabaseRef::SPtr dbRef)

Detailed Description

The oaMarkerChangeRec class represents a change record that captures information about an event that occurred in the session, such as a checkpoint being placed on a design. An oaMarkerChangeRec can also be used to indicate the point at which a change set was last exported.

An oaMarkerChangeRec object does not reflect changes to the data model.

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

Constructor & Destructor Documentation

oaMarkerChangeRec::oaMarkerChangeRec (  oaChangeSetBase *    changeSetIn,
oaMarkerChangeRecTypeEnum    typeIn,
oaCMDatabaseRef::SPtr    dbRef
) 
 

This is the oaMarkerChangeRec constructor.

Parameters:
changeSetIn A pointer to the change set to contain the change record.
typeIn An enum value that specifies the type of marker change record, such as for a design checkpoint or a marker indicating the the last point at which a change set was exported.
dbRef A smart pointer to the database reference with which this marker change record is associated. A database is associated with a marker change record for a design checkpoint.

virtual oaMarkerChangeRec::~oaMarkerChangeRec (    )  [virtual]
 

Member Function Documentation

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

This function accepts a change record visitor. 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.

Implements oaChangeRec.

Implemented in oaExportMarkerChangeRec, and oaTransientMarkerChangeRec.

oaMarkerChangeRec * oaMarkerChangeRec::clone (    )  [pure virtual]
 

This function creates an exact copy of the specified oaMarkerChangeRec, including an identical timestamp.

Implemented in oaExportMarkerChangeRec, and oaTransientMarkerChangeRec.

oaCMDatabaseRef::SPtr oaMarkerChangeRec::getDatabaseRef (    )  const [virtual]
 

This function returns the database reference with which this marker change record is associated. A NULL return value indicates a change record that is global to all databases in the session.

Implements oaLeafChangeRec.

oaMarkerChangeRecTypeEnum oaMarkerChangeRec::getType (    )  const
 

This function returns the type of this marker change record.

oaBoolean oaMarkerChangeRec::isMarkerChangeRec (    )  const [virtual]
 

This function returns the flag value of this marker change record (it returns true).

Reimplemented from oaChangeRec.

void oaMarkerChangeRec::setDatabaseRef (  oaCMDatabaseRef::SPtr    dbRef ) 
 

This function sets the database reference for this marker change record.

Parameters:
dbRef A smart pointer to the database reference with which this marker change record is associated.

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.