 |
 |
 |
 |
 |
 |
 |
 |
 |
|
|
|
|
|
|
|
|
|
Inheritance diagram for oaChangeSet:
 |
Change tracking is global across all open designs in the session. The change set preserves the order of creation of change records, which is reflected at the time of traversal. Change sets provide sequencing of change records, which is needed when an export plug-in emits change records to an external representation. Database-level changes such as open, purge, and undo/redo are reflected in the change set.
Users of a change set can add change records to the change set with the addChangeRec function. References to public objects are stored in change records. These references cannot be stored directly in the form of database-specific handles (like public object pointers) because they might become invalid if the object is destroyed during the span of the change set. OpenAccess CMS provides an additional layer of abstraction that preserves references to live objects as well as objects that have been destroyed. This functionality is provided by the oaCMObjectRef class and its derived classes.
A change set manages all the oaCMObjectRefs used in change records. The change set also manages the following objects used by those oaCMObjectRefs:
A tracking plug-in creates an oaChangeSet instantiation when a change set is opened by the application (through the oaChangeMgr::beginTracking call). The oaChangeMgr owns the change set through its lifetime after it has been created and passed to oaChangeMgr by the plug-in or the application.
Building a change set includes setting the header information, such as name and attributes, and aggregating change records into the change set.
The client can destroy a change set by finding the change set by name and explicitly deleting the returned pointer. The process of deleting a change set removes it from the oaChangeMgr. The client can also delete a change set directly, which also removes it from the oaChangeMgr.
The oaChangeSet class supports a visitor pattern interface to traverse the contents. Several oaChangeSet::accept functions provide access for change set visitors. These accept functions call the visit function of the specified visitor on the object. This interface provides access to the oaChangeSet object itself and some of its components. A plug-in implementation can extend oaChangeSet by creating a class derived from it. A derived oaChangeSet class must implement a derived interface for the visitor pattern, which visits the derived class and accesses any component specific to the derived class.
|
|
This is the oaChangeSet constructor.
|
|
|
This is the oaChangeSet destructor. |
|
||||||||||||
|
This function accepts a change record visitor and enables the visitor to access all the change records managed by this change set.
Implements oaChangeSetBase. |
|
|
This function accepts a change set visitor. It calls the visit function of the specified visitor on this object. The visitor decides on the actions to take on the change set and its components. The visitor can retrieve the simple components directly and act on those data. It can also originate the traversal on the complex components in the change set by calling oaChangeSet::accept(oaChangeRecVisitor *visitor).
Implements oaChangeSetBase. |
|
|
This function adds a leaf change record to the change set if there is no top-level hierarchical change record.
Implements oaChangeSetBase. |
|
||||||||||||||||
|
Implements oaChangeSetBase. |
|
||||||||||||
|
This function returns a pointer to an allocation record of the oaConvertObjectChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
|
This function returns a pointer to an allocation record of the Create1to1RelationshipChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
|
This function returns a pointer to an allocation record of the Create1toNRelationshipChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function returns a pointer to an allocation record of the oaCreateObjectChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
||||||||||||||||
|
This function returns a smart pointer to an allocation record of the oaCMDatabaseRef type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
|
This function returns a pointer to an allocation record of the oaDestroy1to1RelationshipChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
|
This function returns a pointer to an allocation record of the oaDestroy1toNRelationshipChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
|
This function returns a pointer to an allocation record of the oaDestroyObjectChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function returns a pointer to an allocation record of the oaMarkerChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
|
This function returns a pointer to an allocation record of the oaHierChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class. Implements oaChangeSetBase. |
|
||||||||||||||||||||||||
|
This function returns a smart pointer to an allocation record of the oaCMObjectIDRef type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
||||||||||||||||||||
|
This function returns a smart pointer to an allocation record of the oaCMObjectStateEntry type.
Implements oaChangeSetBase. |
|
||||||||||||||||||||||||
|
This function returns a smart pointer to an allocation record of the oaCMObjectStateRef type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
||||||||||||||||
|
Implements oaChangeSetBase. |
|
|
This function returns a pointer to an allocation record of the SetAttributeChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function returns a smart pointer to an allocation record of the oaCMStringEntry type.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function returns a pointer to an allocation record of the oaMarkerChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function returns a pointer to an allocation record of the UnsetAttributeChangeRec type. Applications that define derived change records supply the analogous virtual function to allocate memory for their derived class.
Implements oaChangeSetBase. |
|
|
This function begins a new hierarchical change record on the specified database. It inserts an empty hierarchical change record as a child to the current change record. If there’s no current change record, then it adds an empty hierarchical change record to the top level. In either case, the empty hierarchical change record is set as the current change record.
Implements oaChangeSetBase. |
|
|
This function returns the constant iterator that points to the first database reference in this change set. |
|
|
This function returns the constant iterator that points to the first object reference in the specified database in the change set.
|
|
|
This function returns the constant iterator that points to the first object state in the specified database in this change set.
|
|
|
This function returns the constant iterator that points to the first string in the specified database in this change set.
|
|
|
This function creates an exact copy of the specified oaTransientMarkerChangeRec, including an identical timestamp.
Implements oaChangeSetBase. |
|
|
This function creates an exact copy of the specified oaExportMarkerChangeRec, including an identical timestamp.
Implements oaChangeSetBase. |
|
|
This function ends the current hierarchical change record on the specified database. This function concludes the current change record. It collapses the current change record to a leaf-level change record if it has only one child, then it resets the current change record pointer to the parent of the current one, or sets it to NULL if it has no parent.
Implements oaChangeSetBase. |
|
|
This function returns the constant iterator that points to the last database reference in this change set. |
|
|
This function returns the constant iterator that points to the last object reference in the specified database in this change set.
|
|
|
This function returns the constant iterator that points to the last object state in the specified database in this change set.
|
|
|
This function returns the constant iterator that points to the last string in the specified database in this change set.
|
|
|
This function attempts to find the database reference object managed by this change set.
Implements oaChangeSetBase. |
|
|
This function finds the last oaConvertObjectChangeRec in the list of change records associated with the hcr hierarchical change record. NULL is returned if one is not found.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function returns the last oaMarkerChangeRec of type typeIn on the list of change records associated with the specified database reference.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function attempts to find the ID reference object managed by this change set.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function attempts to find the state reference object managed by this change set.
Implements oaChangeSetBase. |
|
||||||||||||
|
This function finds the string entry in the database managed by this change set.
Implements oaChangeSetBase. |
|
|
This function gets the current hierarchical change record for the specified database. It returns null if there is no current change record, which means the next change record to be added will be a top-level change record.
Implements oaChangeSetBase. |
|
|
This function retrieves the name of this change set in name.
Implements oaChangeSetBase. |
|
|
A change set has a counter that it increments each time a change record is added. This function returns the oaTimeStamp object that represents the current value of the counter. Implements oaChangeSetBase. |
|
|
This function returns a boolean indicating whether tracking is active on this change set. An active change set cannot be exported.
Implements oaChangeSetBase. |
|
|
This function returns a boolean indicating whether or not this change set has been exported. Applications cannot call oaChangeMgr::beginTracking on a change set that has been exported.
Implements oaChangeSetBase. |
|
|
This function passivates the references that describe the change records in the change set.
Implements oaChangeSetBase. |
|
||||||||||||
|
Implements oaChangeSetBase. |
|
||||||||||||||||
|
This function removes changes records from the change set associated with the specified database reference. All changes that occurred after the target marker change record are removed. If inclusive is set to true, the change marker itself is also removed.
Implements oaChangeSetBase. |
|
|
This function sets a boolean to indicate whether or not tracking is active on this change set. The initial state is false (non-active). It is set to true by oaChangeMgr::beginTracking(); set to false by oaChangeMgr::endTracking();
Implements oaChangeSetBase. |
|
|
This function sets the status of this change set to exported. The initial status of a change set is not exported. You cannot begin tracking on a change set if its status is set to exported. oaChangeMgr::exportFull() calls this function, whereas oaChangeMgr::exportIncr() does not.
Implements oaChangeSetBase. |
Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.