oaCreateObjectChangeRec Class Reference

Inheritance diagram for oaCreateObjectChangeRec:

oaObjectChangeRec oaLeafChangeRec oaChangeRec


Public Methods

 oaCreateObjectChangeRec (oaChangeSetBase *changeSet, oaCMObjectRef::SPtr objectRef, oaCMObjectStateEntry::SPtr objectState)
virtual ~oaCreateObjectChangeRec ()
oaCMObjectStateEntry::SPtr getObjectStateEntry () const
oaCMObjectStateEntry::SPtr setObjectStateEntry (oaCMObjectStateEntry::SPtr objectState)
virtual oaBoolean isCreateObjectChangeRec () const
virtual void accept (oaChangeRecVisitor *visitor, oaBoolean forward=true)

Detailed Description

The oaCreateObjectChangeRec class represents a change record related to the creation of a new object.

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

Constructor & Destructor Documentation

oaCreateObjectChangeRec::oaCreateObjectChangeRec (  oaChangeSetBase *    changeSet,
oaCMObjectRef::SPtr    objectRef,
oaCMObjectStateEntry::SPtr    objectState
) 
 

This is the oaCreateObjectChangeRec constructor.

Parameters:
changeSet A pointer to the change set to contain the change record.
objectRef A smart pointer to an oaCMObjectRef for the object that is the subject of this change record.
objectState A smart pointer to an oaCMObjectStateEntry object to store the state of the object. The state of an object is a a unique combination of attributes and relationships that define the object.

oaCreateObjectChangeRec::~oaCreateObjectChangeRec (    )  [virtual]
 

This is the oaCreateObjectChangeRec destructor.

Member Function Documentation

void oaCreateObjectChangeRec::accept (  oaChangeRecVisitor *    visitor,
oaBoolean    forward = true
)  [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.

oaCMObjectStateEntry::SPtr oaCreateObjectChangeRec::getObjectStateEntry (    )  const
 

This function returns a smart pointer to an oaCMObjectStateEntry object that stores the state of the object. The state of an object is a a unique combination of attributes and relationships that define the object.

oaBoolean oaCreateObjectChangeRec::isCreateObjectChangeRec (    )  const [virtual]
 

This function always returns true to indicate that this change record represents the creation of an object.

Reimplemented from oaChangeRec.

oaCMObjectStateEntry::SPtr oaCreateObjectChangeRec::setObjectStateEntry (  oaCMObjectStateEntry::SPtr    objectState ) 
 

This function sets this object's state to the specified objectState and returns the previous state.

Parameters:
objectState The object state to set on this object state.

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.