oaChangeRec.h

Go to the documentation of this file.

// ****************************************************************************
// ****************************************************************************
// oaChangeRec.h
//
// This file contains the definition of the Change Record in the change set.
//
//  oaChangeRec Class Hierarchy
//    oaChangeRec
//      A change record represents a change or an event in the database. It can
//      be leaf-level change, hierarchical change, or an event change.
//
//    oaLeafChangeRec
//      A change record represents a change in the database. It includes 
//      information about the type of the change, the subject of the change
//      and the value of the change. This the base class and there're various
//      derived class to provide specific informations of those.
//
//    oaAttributeChangeRec
//      This is the base class for change records of attribute changes.
//
//    oaSetAttributeChangeRec
//      This is the class for change records of setting an attribute.
//
//    oaUnsetAttributeChangeRec
//      This is the class for change records of un-setting an attribute.
//
//    oaRelationshipChangeRec
//      This is the base class for change records of relationship changes.
//
//    oaCreateRelationshipChangeRec
//      This is the base class for change records of relationship creations.
//
//    oaDestroyRelationshipChangeRec
//      This is the base class for change records of relationship deletion.
// 
//    oaCreate1to1RelationshipChangeRec
//      This is the class for change records of creating an 1-to-1 relationship.
//
//    oaCreate1toNRelationshipChangeRec
//      This is the class for change records of creating an 1-to-N relationship.
//
//    oaCreate2DTableRelationshipChangeRec
//      This is the class for change records of creating a 2DTable relationship.
//      Since this is a templatized type, we also store the relationship base.
//
//    oaDestroy1to1RelationshipChangeRec
//      This is the class for change records of destroying an 1-to-1 
//      relationship.
//
//    oaDestroy1toNRelationshipChangeRec
//      This is the class for change records of destroying an 1-to-N 
//      relationship.
//
//    oaDestroy2DTableRelationshipChangeRec
//      This is the class for change records of destroying an 2DTable 
//      relationship.
//
//    oaHierChangeRec
//     A single, higher level OpenAccess API call can map to a state change 
//     that might include multiple levels of lower level state changes. For 
//     complex APIs, this decomposition may span more than one level of 
//     hierarchy, creating a tree of change records. The oaHierChangeRec class 
//     is used to represent the hierachy of changes.
//
//    oaMarkerChangeRecType
//      A wrapper class for oaMarkerChangeRecTypeEnum, providing a mapping 
//      between enum value and name. 
//
//    oaMarkerChangeRec
//      A marker change record represents an event happened in the session.
//      It does not reflect changes to the data model. 
//
//    oaExportMarkerChangeRec
//      This is class representing a marker type change record that is exported
//      along with the other change records.
//
//    oaTransientMarkerChangeRec
//      This is class representing a marker type change record that is not 
//      exported. 
//
//    oaConvertObjectChangeRec 
//      This is the class of change records created when an object of one
//      type is converted into an object of another type.
//
//    oaChangeRecVisitor
//      oaChangeRec classes supports visitor pattern for various actions on
//      them. This is the interface for the visitor, which is capable of
//      visiting concrete oaChangeRec nodes. It can be derived to define
//      specific actions.
// 
// ****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2009 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: $
// ****************************************************************************
// ****************************************************************************



#if !defined(oaChangeRec_P)
#define oaChangeRec_P



// ****************************************************************************
// Nested includes
// ****************************************************************************
#include <vector>
#include "srBase.h"
#include "srVisitor.h"
#include "oaArray.h"
#include "oaTimeStamp.h"
#include "oaCMObject.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaChangeSet;
class oaChangeSetBase;
class oaCMObjectRef;
class oaCMObjectDef;
class oaHierChangeRec;
class oaChangeRecVisitor;



// ****************************************************************************
// oaMarkerChangeRecTypeEnum
// ****************************************************************************
#define oavNumMarkerChangeRecTypes   8

enum oaMarkerChangeRecTypeEnum {
    oacChangeSetExportMarkerChangeRecType   = 0,
    oacDesignCpMarkerChangeRecType          = 1,
    oacDBLOOpenMarkerChangeRecType          = 2,
    oacDBLOSaveMarkerChangeRecType          = 3,
    oacDBLOSaveAsMarkerChangeRecType        = 4,
    oacDBLOPurgeMarkerChangeRecType         = 5,
    oacDBLOTruncateMarkerChangeRecType      = 6,
    oacTechCpMarkerChangeRecType            = 7
};



// *****************************************************************************
// oaMarkerChangeRecType
// *****************************************************************************
class OA_CM_DLL_API oaMarkerChangeRecType {
public:
                                oaMarkerChangeRecType(oaMarkerChangeRecTypeEnum valueIn);
                                oaMarkerChangeRecType(const oaString &name);
                                ~oaMarkerChangeRecType();

    const oaString              &getName() const;
                                operator                    oaMarkerChangeRecTypeEnum() const;

private:
    oaMarkerChangeRecTypeEnum   m_value;
};



// ****************************************************************************
// oaChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaChangeRec {
public:
                            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;

protected:
    oaUInt4                 m_flags;
    oaTimeStamp             m_timeStamp;
    oaChangeSetBase         *m_changeSet;
    oaHierChangeRec         *m_parent;
};



// ****************************************************************************
// oaLeafChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaLeafChangeRec : public oaChangeRec {
public:
                                    oaLeafChangeRec(oaChangeSetBase *changeSetIn);

    oaBoolean                       isPrimary() const;
    void                            setIsPrimary(oaBoolean val);

    virtual oaCMDatabaseRef::SPtr   getDatabaseRef() const = 0;
};



// ****************************************************************************
// oaAttributeChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaAttributeChangeRec : public oaLeafChangeRec {
public:
                                    oaAttributeChangeRec(oaChangeSetBase *changeSetIn);

    virtual oaCMObjectRef::SPtr     getOwner() const = 0;
    virtual const sd::sdAttribute   *getSchemaDefinition() const = 0;

    virtual oaCMDatabaseRef::SPtr   getDatabaseRef() const;
};



// ****************************************************************************
// oaSetAttributeChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaSetAttributeChangeRec : public oaAttributeChangeRec {
public:
                                    oaSetAttributeChangeRec(oaChangeSetBase             *changeSetIn,
                                                            sr::srAttributeBase::SPtr   valueIn);
    virtual                         ~oaSetAttributeChangeRec();

    virtual const sd::sdAttribute   *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr     getOwner() const;
    sr::srAttributeBase::SPtr       getValue() const;

    virtual void                    accept(oaChangeRecVisitor   *visitor,
                                           oaBoolean            forward = true);

private:
    sr::srAttributeBase::SPtr       m_value;
};



// ****************************************************************************
// oaUnsetAttributeChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaUnsetAttributeChangeRec : public oaAttributeChangeRec {
public:
                                    oaUnsetAttributeChangeRec(oaChangeSetBase       *changeSetIn,
                                                              oaCMObjectRef::SPtr   ownerIn,
                                                              sd::sdAttribute       *attrIn);
    virtual                         ~oaUnsetAttributeChangeRec();

    virtual const sd::sdAttribute   *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr     getOwner() const;

    virtual void                    accept(oaChangeRecVisitor   *visitor,
                                           oaBoolean            forward = true);

private:
    const sd::sdAttribute           *m_attr;
    oaCMObjectRef::SPtr             m_owner;
};



// ****************************************************************************
// oaRelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaRelationshipChangeRec : public oaLeafChangeRec {
public:
                                            oaRelationshipChangeRec(oaChangeSetBase *changeSetIn);

    virtual oaCMObjectRef::SPtr             getFrom() const;
    virtual const sd::sdRelationshipBase    *getSchemaDefinition() const;

    virtual oaCMDatabaseRef::SPtr           getDatabaseRef() const;
};



// ****************************************************************************
// oaCreateRelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaCreateRelationshipChangeRec : public oaRelationshipChangeRec {
public:
                            oaCreateRelationshipChangeRec(oaChangeSetBase *changeSetIn);
};



// ****************************************************************************
// oaDestroyRelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaDestroyRelationshipChangeRec : public oaRelationshipChangeRec {
public:
                            oaDestroyRelationshipChangeRec(oaChangeSetBase *changeSetIn);
};



// ****************************************************************************
// oaCreate1to1RelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaCreate1to1RelationshipChangeRec : public oaCreateRelationshipChangeRec {
public:
                                            oaCreate1to1RelationshipChangeRec(oaChangeSetBase               *changeSetIn,
                                                                              sr::sr1to1Relationship::SPtr  valueIn);
    virtual                                 ~oaCreate1to1RelationshipChangeRec();

    virtual const sd::sdRelationshipBase    *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr             getFrom() const;
    sr::sr1to1Relationship::SPtr            getValue() const;

    virtual void                            accept(oaChangeRecVisitor   *visitor,
                                                   oaBoolean            forward = true);

private:
    sr::sr1to1Relationship::SPtr            m_value;
};



// ****************************************************************************
// oaCreate1toNRelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaCreate1toNRelationshipChangeRec : public oaCreateRelationshipChangeRec {
public:
                                            oaCreate1toNRelationshipChangeRec(oaChangeSetBase               *changeSetIn,
                                                                              sr::sr1toNRelationship::SPtr  valueIn);

    virtual                                 ~oaCreate1toNRelationshipChangeRec();

    virtual const sd::sdRelationshipBase    *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr             getFrom() const;
    sr::sr1toNRelationship::SPtr            getValue() const;

    virtual void                            accept(oaChangeRecVisitor   *visitor,
                                                   oaBoolean            forward = true);

private:
    sr::sr1toNRelationship::SPtr            m_value;
};



// ****************************************************************************
// oaCreate2DTableRelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaCreate2DTableRelationshipChangeRec : public oaCreateRelationshipChangeRec {
public:
                                            oaCreate2DTableRelationshipChangeRec(oaChangeSetBase                *changeSetIn,
                                                                                 sr::srRelationshipBase::SPtr   valueIn);

    virtual                                 ~oaCreate2DTableRelationshipChangeRec();

    virtual const sd::sdRelationshipBase    *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr             getFrom() const;
    sr::srRelationshipBase::SPtr            getValue() const;

    virtual void                            accept(oaChangeRecVisitor   *visitor,
                                                   oaBoolean            forward = true);

private:
    sr::srRelationshipBase::SPtr            m_value;
};



// ****************************************************************************
// oaDestroy1to1RelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaDestroy1to1RelationshipChangeRec : public oaDestroyRelationshipChangeRec {
public:
                                            oaDestroy1to1RelationshipChangeRec(oaChangeSetBase              *changeSetIn,
                                                                               sr::sr1to1Relationship::SPtr valueIn);
    virtual                                 ~oaDestroy1to1RelationshipChangeRec();

    virtual const sd::sdRelationshipBase    *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr             getFrom() const;
    sr::sr1to1Relationship::SPtr            getValue() const;

    virtual void                            accept(oaChangeRecVisitor   *visitor,
                                                   oaBoolean            forward = true);

private:
    sr::sr1to1Relationship::SPtr            m_origValue;
};



// ****************************************************************************
// oaDestroy1toNRelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaDestroy1toNRelationshipChangeRec : public oaDestroyRelationshipChangeRec {
public:
                                            oaDestroy1toNRelationshipChangeRec(oaChangeSetBase              *changeSetIn,
                                                                               sr::sr1toNRelationship::SPtr valueIn);
    virtual                                 ~oaDestroy1toNRelationshipChangeRec();

    virtual const sd::sdRelationshipBase    *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr             getFrom() const;
    sr::sr1toNRelationship::SPtr            getValue() const;

    virtual void                            accept(oaChangeRecVisitor   *visitor,
                                                   oaBoolean            forward = true);

private:
    sr::sr1toNRelationship::SPtr            m_origValue;
};



// ****************************************************************************
// oaDestroy2DTableRelationshipChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaDestroy2DTableRelationshipChangeRec : public oaDestroyRelationshipChangeRec {
public:
                                            oaDestroy2DTableRelationshipChangeRec(oaChangeSetBase               *changeSetIn,
                                                                                  sr::srRelationshipBase::SPtr  valueIn);
    virtual                                 ~oaDestroy2DTableRelationshipChangeRec();

    virtual const sd::sdRelationshipBase    *getSchemaDefinition() const;
    virtual oaCMObjectRef::SPtr             getFrom() const;
    sr::srRelationshipBase::SPtr            getValue() const;

    virtual void                            accept(oaChangeRecVisitor   *visitor,
                                                   oaBoolean            forward = true);

private:
    sr::srRelationshipBase::SPtr            m_origValue;
};




// ****************************************************************************
// oaObjectChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaObjectChangeRec : public oaLeafChangeRec {
public:
                                    oaObjectChangeRec(oaChangeSetBase       *changeSetIn,
                                                      oaCMObjectRef::SPtr   objectRefIn);
    virtual                         ~oaObjectChangeRec();

    oaCMObjectRef::SPtr             getObject() const;
    const sd::sdObject              *getSchemaDefinition() const;

    virtual oaCMDatabaseRef::SPtr   getDatabaseRef() const;

private:
    oaCMObjectRef::SPtr             m_objectRef;
};



// ****************************************************************************
// oaCreateObjectChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaCreateObjectChangeRec : public oaObjectChangeRec {
public:
                                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);

private:
    oaCMObjectStateEntry::SPtr  m_objectState;
};



// ****************************************************************************
// oaDestroyObjectChangeRec
// ****************************************************************************
class oaDestroyObjectChangeRec : public oaObjectChangeRec {
public:
                            oaDestroyObjectChangeRec(oaChangeSetBase        *changeSetIn,
                                                     oaCMObjectRef::SPtr    objectRefIn);

    virtual oaBoolean       isDestroyObjectChangeRec() const;

    virtual void            accept(oaChangeRecVisitor   *visitor,
                                   oaBoolean            forward = true);
};



// **************************************************************************** 
// oaConvertObjectChangeRec 
//*****************************************************************************
class OA_CM_DLL_API oaConvertObjectChangeRec : public oaObjectChangeRec {
public:
                                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;

private:
    oaCMObjectRef::SPtr         m_convObjRef;
    oaCMObjectStateEntry::SPtr  m_objectState;
};



// ****************************************************************************
// oaHierChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaHierChangeRec : public oaChangeRec {
public:
    typedef std::vector<oaChangeRec*>               ChangeRecVector;
    typedef ChangeRecVector::const_iterator         ChangeRecsConstIter;
    typedef ChangeRecVector::iterator               ChangeRecsIter;
    typedef ChangeRecVector::const_reverse_iterator ConstReverseIter;
    typedef ChangeRecVector::reverse_iterator       ReverseIter;

                                                    oaHierChangeRec(oaChangeSetBase *changeSetIn);
    virtual                                         ~oaHierChangeRec();

    virtual void                                    accept(oaChangeRecVisitor   *visitor,
                                                           oaBoolean            forward = true);

    oaLeafChangeRec                                 *getPrimary() const;
    void                                            setPrimary(oaLeafChangeRec *primary);

    ChangeRecsConstIter                             beginChild() const;
    ChangeRecsConstIter                             endChild() const;

    ChangeRecsIter                                  beginChild();
    ChangeRecsIter                                  endChild();

    ConstReverseIter                                rbeginChild() const;
    ConstReverseIter                                rendChild() const;

    ReverseIter                                     rbeginChild();
    ReverseIter                                     rendChild();

    void                                            addChild(oaChangeRec *child);
    void                                            removeChild(oaChangeRec *child);

    oaBoolean                                       isCollapsible() const;

private:
    oaLeafChangeRec                                 *m_primary;
    ChangeRecVector                                 m_children;
};



// ****************************************************************************
// oaMarkerChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaMarkerChangeRec : public oaLeafChangeRec {
public:
                                    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);

private:
    oaMarkerChangeRecType           m_type;
    oaCMDatabaseRef::SPtr           m_db;
};



// ****************************************************************************
// oaExportMarkerChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaExportMarkerChangeRec : public oaMarkerChangeRec {
public:
                                oaExportMarkerChangeRec(oaChangeSetBase             *changeSetIn,
                                                        oaMarkerChangeRecTypeEnum   typeIn,
                                                        oaCMDatabaseRef::SPtr       dbRef);

    virtual oaMarkerChangeRec   *clone();

    virtual void                accept(oaChangeRecVisitor   *visitor,
                                       oaBoolean            forward = true);

    oaString                    getMessage() const;
    void                        setMessage(const oaString &msg);

private:
    oaString                    m_message;
};



// ****************************************************************************
// oaTransientMarkerChangeRec
// ****************************************************************************
class OA_CM_DLL_API oaTransientMarkerChangeRec : public oaMarkerChangeRec {
public:
                                oaTransientMarkerChangeRec(oaChangeSetBase              *changeSetIn,
                                                           oaMarkerChangeRecTypeEnum    typeIn,
                                                           oaCMDatabaseRef::SPtr        dbRef);

    virtual oaMarkerChangeRec   *clone();
    virtual void                accept(oaChangeRecVisitor   *visitor,
                                       oaBoolean            forward = true);
};



// ****************************************************************************
// oaChangeRecVisitor Interface
// ****************************************************************************
class OA_CM_DLL_API oaChangeRecVisitor {
public:
    virtual void            visit(oaHierChangeRec *node) = 0;
    virtual void            visit(oaExportMarkerChangeRec *node) = 0;
    virtual void            visit(oaTransientMarkerChangeRec *node) = 0;

    virtual void            visit(oaSetAttributeChangeRec *node) = 0;
    virtual void            visit(oaUnsetAttributeChangeRec *node) = 0;
    virtual void            visit(oaCreate1to1RelationshipChangeRec *node) = 0;
    virtual void            visit(oaCreate1toNRelationshipChangeRec *node) = 0;
    virtual void            visit(oaCreate2DTableRelationshipChangeRec *node) = 0;

    virtual void            visit(oaDestroy1to1RelationshipChangeRec *node) = 0;
    virtual void            visit(oaDestroy1toNRelationshipChangeRec *node) = 0;
    virtual void            visit(oaDestroy2DTableRelationshipChangeRec *node) = 0;

    virtual void            visit(oaCreateObjectChangeRec *node) = 0;
    virtual void            visit(oaDestroyObjectChangeRec *node) = 0;
    virtual void            visit(oaConvertObjectChangeRec *node) = 0;

    virtual oaBoolean       startHier(oaHierChangeRec *node) = 0;
    virtual void            endHier(oaHierChangeRec *node) = 0;
};



END_OA_NAMESPACE

#endif

Return to top of page

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