oaPlugInDMTypes.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPlugInDMTypes.h
//
// This file contains type definitions and declarations which are used
// in both the DM package and the plugIn package.
//
//  oaVCMessageTypeEnum
//      This enumeration represents the types of messages that are passed to the
//      client via the IVCMessageObserver interface. Their meanings are as
//      follows:
//
//          oacVCMsgTypeInfo    The message is informational only
//          oacVCMsgTypeWarning The message represents a warning condition
//          oacVCMsgTypeError   The message represents an error condition
//          oacVCMsgTypeStatus  The message is conveying status information
//          oacVCMsgTypeQueryOk The message is a request for an Ok/Cancel
//                              decision from the client
//
//  oaVCOperationEnum
//      This enumeration is a list of the operations that a message passed
//      through the IVCMessageObserver could be related to. The operation that
//      was in effect at the time the message was issued is passed in the form
//      of a value from this enum to the IVCMessageObserver::onMessageOut()
//      function. The values should be self explanetory.
//
//  oaVCObserverResultEnum
//      This enumeration contains the legal responses to a oacVCMsgTypeQueryOk
//      message type. The appropriate value is passed by the client as the
//      return value from the IVCMessageObserver::onMessageOut() call.
//
//          oacVCObserverResultOk           Proceed with the current operation
//          oacVCObserverResultAbort        Abort the current operation
//
//  oaVCCapEnum
//      This enumeration represents all the version control capabilities that
//      the OA DM implementation is interested in. This list can grow, but
//      existing values will never change. Implementors must be able to respond
//      to values of this enum that aren't in existence at the time their code
//      is compiled. The safest approach is to return "false" in this case
//      (usually in the "default" section of a switch statement).
//
//  oaVCQueryDepthEnum
//      This enumeration represents the depth to which the getControlledObjects
//      function should go in responding to the call. If the object that this
//      depth is being applied to is an IDMLib then all values of "depth" are
//      valid. If, in this case, the value oacCellVCQueryDepth is passed in,
//      then the resulting collection of IDMObjects will contain only the cells
//      in the current library that are controlled by this VC system. The value
//      oacFileVCQueryDepth represents the files that are found at the container
//      level (e.g. Lib files) while the value oacCellViewFileVCQueryDepth
//      indicates to go to the bottom-most file depth.
//
//  oaVersionCompEnum
//      This enumeration represents the possible return values of the
//      IVersion::compare() method. If the versions represent the same version
//      then IVersion::cEqual is returned (not just if it's the same version
//      *object*). IVersion::cEarlier means that the version being passed in is
//      earlier in that branch, while IVersion::cLater means that it's later in
//      the branch. The IVersion::cDifferentBranch value means that the incoming
//      version is not on the same branch, while IVersion::cIncompatable means
//      it's from an incompatable VC system.
//
// *****************************************************************************
// 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 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaPlugInDMTypes_P)
#define oaPlugInDMTypes_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPlugInTypes.h"



// *****************************************************************************
// Predefined DM System Capabilities
// *****************************************************************************
#define oacDMSystemPreservesFollowersCap    "PreservesFollowers"
#define oacDMSystemSupportsViewFilesCap     "SupportsViewFiles"



// *****************************************************************************
// Predefined DM System Metrics
// *****************************************************************************
#define oacDMSystemMaxNameLengthMetric      "MaxNameLength"
#define oacDMSystemMaxCellViewsMetric       "MaxCellViews"



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



// *************************************************************************
// oaLibAccessLevelEnum
// *************************************************************************
#define oavNumLibAccessLevels   3

enum oaLibAccessLevelEnum {
    oacNoLibAccessLevel     = 0,
    oacReadLibAccessLevel   = 1,
    oacWriteLibAccessLevel  = 2
};



// *************************************************************************
// oaDMLockStatusEnum
// *************************************************************************
#define oavNumDMLockStatus 3

enum oaDMLockStatusEnum {
    oacNotLocked                = 0,
    oacLockedByCurrentProcess   = 1,
    oacLockedByForeignProcess   = 2
};



// *************************************************************************
// oaLibModeEnum
// *************************************************************************
#define oavNumLibModes  3

enum oaLibModeEnum {
    oacSharedLibMode    = 0,
    oacNonSharedLibMode = 1,
    oacReadOnlyLibMode  = 2
};



// *************************************************************************
// oaLibAccessEnum
// *************************************************************************
#define oavNumLibAccessEnums    2

enum oaLibAccessEnum {
    oacReadLibAccess    = 0,
    oacWriteLibAccess   = 1
};



// *************************************************************************
// oaVCMessageTypeEnum
// *************************************************************************
#define oavNumVCMessageTypes    5

enum oaVCMessageTypeEnum {
    oacVCMsgTypeInfo    = 0,
    oacVCMsgTypeWarning = 1,
    oacVCMsgTypeError   = 2,
    oacVCMsgTypeStatus  = 3,
    oacVCMsgTypeQueryOk = 4
};



// *************************************************************************
// oaVCOperationEnum
// *************************************************************************
#define oavNumVCOperations  12

enum oaVCOperationEnum {
    oacVCOperationGetStatus             = 0,
    oacVCOperationGetControlledObjects  = 1,
    oacVCOperationGetControlledLibs     = 2,
    oacVCOperationGetVersions           = 3,
    oacVCOperationGetWorkingVersion     = 4,
    oacVCOperationGetWorkingVersions    = 5,
    oacVCOperationUpdate                = 6,
    oacVCOperationMakeEditable          = 7,
    oacVCOperationCancelEdit            = 8,
    oacVCOperationCommitEdits           = 9,
    oacVCOperationSetControlled         = 10,
    oacVCOperationUnsetControlled       = 11
};



// *************************************************************************
// oaVCCapEnum
// *************************************************************************
#define oavNumVCCaps    15

enum oaVCCapEnum {
    oacCommitMayChangeFilesVCCap            = 0,
    oacHasVersionsVCCap                     = 1,
    oacSupportsGetStatusVCCap               = 2,
    oacSupportsGetControlledObjectsVCCap    = 3,
    oacSupportsGetControlledLibsVCCap       = 4,
    oacSupportsGetVersionsVCCap             = 5,
    oacSupportsGetWorkingVersionVCCap       = 6,
    oacSupportsGetWorkingVersionsVCCap      = 7,
    oacSupportsUpdateVCCap                  = 8,
    oacSupportsMakeEditableVCCap            = 9,
    oacSupportsLockVCCap                    = 10,
    oacSupportsCancelEditVCCap              = 11,
    oacSupportsCommitEditsVCCap             = 12,
    oacSupportsSetControlledVCCap           = 13,
    oacSupportsUnSetControlledVCCap         = 14
};



// *************************************************************************
// oaVCObserverResultEnum
// *************************************************************************
#define oavNumVCObserverResults 2

enum oaVCObserverResultEnum {
    oacVCObserverResultOk       = 0,
    oacVCObserverResultAbort    = 1
};



// *************************************************************************
// oaVCQueryDepthEnum
// *************************************************************************
#define oavNumVCQueryDepths         5

enum oaVCQueryDepthEnum {
    oacFileVCQueryDepth         = 0,
    oacCellVCQueryDepth         = 1,
    oacViewVCQueryDepth         = 2,
    oacCellViewVCQueryDepth     = 3,
    oacCellViewFileVCQueryDepth = 4,
    oacMaxQueryDepth            = 4
};



// *************************************************************************
// oaVersionCompEnum
// *************************************************************************
#define oavNumVersionComps          5

enum oaVersionCompEnum {
    oacVersionCompEqual             = 0,
    oacVersionCompEarlier           = 1,
    oacVersionCompLater             = 2,
    oacVersionCompDifferentBranch   = 3,
    oacVersionCompIncompatable      = 4
};



// *****************************************************************************
// oaSaveRecoverTypeEnum
// *****************************************************************************
#define oavNumSaveRecoverTypes  2

enum oaSaveRecoverTypeEnum {
    oacAutoSaveType     = 0,
    oacCriticalSaveType = 1
};



END_OA_PLUGIN_NAMESPACE

#endif

Return to top of page

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