oaConvertObjectChangeRec Class Reference

Inheritance diagram for oaConvertObjectChangeRec:

oaObjectChangeRec oaLeafChangeRec oaChangeRec


Public Methods

 oaConvertObjectChangeRec (oaChangeSetBase *changeSetIn, oaCMObjectRef::SPtr objRef, oaCMObjectRef::SPtr convObjRef)
oaCMObjectRef::SPtr getConvertedToObject () const
void setConvertedToObject (const oaCMObjectRef::SPtr convObjRef, const oaCMObjectStateEntry::SPtr convObjState)
oaCMObjectStateEntry::SPtr getObjectStateEntry () const
virtual void accept (oaChangeRecVisitor *visitor, oaBoolean forward=true)
virtual oaBoolean isConvertObjectChangeRec () const

Detailed Description

The oaConvertObjectChangeRec class represents change records created when an object of one type is converted into another type.

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

Constructor & Destructor Documentation

oaConvertObjectChangeRec::oaConvertObjectChangeRec (  oaChangeSetBase *    changeSetIn,
oaCMObjectRef::SPtr    objRef,
oaCMObjectRef::SPtr    convObjRef
) 
 

This is the oaConvertObjectChangeRec constructor.

Parameters:
changeSetIn A pointer to the change set to contain the change record.
objRef A smart pointer to an oaCMObjectRef for the object that is the subject of this change record.
convObjRef A smart pointer to the oaCMObjectRef for the type-converted object.

Member Function Documentation

void oaConvertObjectChangeRec::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.

oaCMObjectRef::SPtr oaConvertObjectChangeRec::getConvertedToObject (    )  const
 

This function returns a smart pointer to the oaCMObjectRef object of the type-converted object.

oaCMObjectStateEntry::SPtr oaConvertObjectChangeRec::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 oaConvertObjectChangeRec::isConvertObjectChangeRec (    )  const [virtual]
 

This function always returns true indicating that this is an object type-conversion change record.

Reimplemented from oaChangeRec.

void oaConvertObjectChangeRec::setConvertedToObject (  const oaCMObjectRef::SPtr    convObjRef,
const oaCMObjectStateEntry::SPtr    convObjState
) 
 

This function sets the oaCMObjectRef of the type-converted object and specifies the full state of the converted object.

Parameters:
convObjRef A smart pointer to the oaCMObjectRef for the type-converted object.
convObjState The full state for the converted object.

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.