oaBaseTypes.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaBaseTypes.h
//
// This file contains definitions for basic types used throughout OpenAccess.
//
// *****************************************************************************
// 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-2010 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #6 $
//  $Date: 2010/10/18 $
//  $State: $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaBaseTypes_P)
#define oaBaseTypes_P



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



// *****************************************************************************
// Platform macros
// *****************************************************************************
#if defined(_MSC_VER)
#define OA_WINDOWS
#endif



// *****************************************************************************
// Required System Header Files
// *****************************************************************************
#include <math.h>
#include <limits.h>



// *****************************************************************************
// API Revision Numbers for Product and this Development Stream
// 
// Note! These numbers need to be updated accordingly whenever there's an API 
// change in product or in this development stream. When it happens, be sure to 
// update the static map of Stream-BuildNames defined in oaSoftwareInfo class.
// *****************************************************************************
#define oacProdStreamAPIRevNumber       201



// *****************************************************************************
// Other const definitions related with API Major and Minor revisions. 
// Note: branch stream number represents the x550 stream
// *****************************************************************************
#define oacProdStreamRevNumber      oacProdStreamAPIRevNumber

#define oacStreamRevNumberOffset    1000
#define oacBranchStreamNumberOffset 100

#define oacAPIMajorRevNumber        4
#define oacAPIMinorRevNumber        oacProdStreamRevNumber



// *****************************************************************************
// DataModel Version Numbers
// *****************************************************************************
#define oacDataModelRevNumber           4



// *****************************************************************************
// Constants
// *****************************************************************************
#define oacNullIndex            0xffffffffu
#define oacDeletedIndex         0xfffffffeu
#define oacNegativeOne          oaUInt4(-1)

#if defined(OA_WINDOWS)
#define oacNullLongIndex        0xffffffffffffffffui64
#define oacDeletedLongIndex     0xfffffffffffffffeui64
#else
#define oacNullLongIndex        0xffffffffffffffffULL
#define oacDeletedLongIndex     0xfffffffffffffffeULL
#endif

#if defined(OA_WINDOWS)
#define oacMaxPathLen           _MAX_PATH
#define oacPathSeparator        "\\"
#define oacPathSeparatorChar    '\\'
#else
#define oacMaxPathLen           PATH_MAX
#define oacPathSeparator        "/"
#define oacPathSeparatorChar    '/'
#endif

#if !defined(M_PI)
#define M_PI        3.14159265358979323846264338
#endif
#if !defined(M_PI_2)
#define M_PI_2      1.57079632679489661923132169
#endif
#if !defined(M_PI_4)
#define M_PI_4      0.78539816339744830961566085
#endif
#if !defined(M_PI_8)
#define M_PI_8      0.39269908169872415480783042
#endif

#if !defined(OA_DEPRECATED)
#define oacObserverRevision         1
#endif



// *****************************************************************************
// Windows DLL export macros
// *****************************************************************************
#if defined(OA_WINDOWS) && defined(OA_BASE_DLL_EXPORTS)
#define OA_BASE_DLL_API __declspec(dllexport)
#define OA_BASE_DLL_PVT __declspec(dllexport)
#define OA_BASE_DLL_EXTERN
#elif defined(OA_WINDOWS) && !defined(OA_STATIC)
#define OA_BASE_DLL_API __declspec(dllimport)
#define OA_BASE_DLL_PVT __declspec(dllimport)
#define OA_BASE_DLL_EXTERN extern
#else
#define OA_BASE_DLL_API
#define OA_BASE_DLL_PVT
#endif

#if defined(OA_WINDOWS) && !defined(OA_STATIC)
#define OA_DLL_EXPORT __declspec(dllexport)
#else
#define OA_DLL_EXPORT
#endif



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



// *****************************************************************************
// oaCoord
//
// A geometric coordinate expressed in the fundamental database units.
// *****************************************************************************
typedef oaInt4 oaCoord;



// *****************************************************************************
// oaDist
//
// The non-negative distance, along one axis, between two oaCoord values.  This
// cannot safely be used for full Cartesian distances due to overflow problems
// on the most extreme diagonals.
// *****************************************************************************
typedef oaUInt4 oaDist;



// *****************************************************************************
// oaOffset
//
// The signed difference between two oaCoord values.  This cannot safely be used
// to hold the difference of any two oaCoord values due to overflow issues.  It
// is mainly intended, as the name implies, for offset values that are to be
// added to existing oaCoord values.
// *****************************************************************************
typedef oaInt4 oaOffset;



// *****************************************************************************
// oaSocketD
//
// The unsigned value represent a socket descriptor.  The socket descriptor is
// usually obtained by calling system socket functions.
// *****************************************************************************
typedef oaUInt4 oaSocketD;



// *****************************************************************************
// oaBaseDataTypeEnum
//
// The first two entries are special dataTypes that are used for the database
// itself and for all oaAppObjects in the database. The next five entries are
// reserved and are common to all databases.
//
// Note: The number of dataTypes should not include the special dataTypes.
// *****************************************************************************
#define oavBaseNumDataTypes             22
#define oavBaseAppObjectDataTypeName    "appObject"

enum oaBaseDataTypeEnum {
    oacBaseDatabaseDataType                 = UINT_MAX,
    oacBaseAppObjectDataType                = UINT_MAX - 1,
    oacBasePropDataType                     = 0,
    oacBaseGroupDataType                    = 1,
    oacBaseGroupMemDataType                 = 2,
    oacBaseAvatarDataType                   = 3,
    oacBaseValueDataType                    = 4,
    oacBaseConstraintParamDefDataType       = 5,
    oacBaseConstraintParamDataType          = 6,
    oacBaseConstraintDefDataType            = 7,
    oacBaseConstraintDataType               = 8,
    oacBaseConstraintGroupDataType          = 9,
    oacBaseConstraintGroupMemDataType       = 10,
    oacBaseConstraintGroupHeaderDataType    = 11,

    oacBaseFeatureDataType                  = 12,
    oacBaseFeaturePolicyDataType            = 13,

    oacBaseDerivedLayerParamDefDataType     = 14,
    oacBaseDerivedLayerDefDataType          = 15,

    oacBaseGroupDefDataType                 = 16,
    oacBaseConstraintGroupDefDataType       = 17,

    oacBaseViaVariantDataType               = 18,
    oacBaseParamDataType                    = 19,
    oacBaseViaVariantHeaderDataType         = 20,
    oacBaseViaParamDataType                 = 21
};



// *****************************************************************************
// oaUndoModelEnum
//
// This is the enum used to specify which one of the undo model this user is
// following: 
// 1. checkpoint is placed after operations -- post-checkpoint model
// 2. checkpoint is placed before operations -- pre-checkpoint model 
// *****************************************************************************
enum oaUndoModelEnum {
    oacUndoModelNotSpecified    = UINT_MAX,
    oacUndoModelPostCheckpoint  = 0,
    oacUndoModelPreCheckpoint   = 1
};



// *****************************************************************************
// oaThreadUseModelEnum
//
// This is the enum used to specify if the OpenAccess session is in single 
// thread or multiple thread use model.
// *****************************************************************************
enum oaThreadUseModelEnum {
    oacSingleThreadUseModel             = 0,
    oacMultipleReadersThreadUseModel    = 1,
    oacMultipleWritersThreadUseModel    = 2
};

#define oavNumThreadUseModelTypes    3



// *****************************************************************************
// Forward Public Class Declarations for Classes from Other Packages
// *****************************************************************************
class oaDerivedLayerDef;
class oaDerivedLayerParamDef;



// *****************************************************************************
// Global Function Declarations and definitions
// *****************************************************************************
OA_BASE_DLL_API extern
void oaBaseInit(oaUInt4 apiMajorRev = oacAPIMajorRevNumber,
                oaUInt4 apiMinorRev = oacAPIMinorRevNumber);

OA_BASE_DLL_API extern
void oaBaseInit(oaUInt4 apiMajorRev,
                oaUInt4 apiMinorRev,
                oaUInt4 dataModelRev);



// *****************************************************************************
// oaSleep()
//
// This utility function puts the process to sleep for the specified number of
// seconds.
// *****************************************************************************
extern OA_BASE_DLL_API
    void
    oaSleep(oaUInt4 sec);



// *****************************************************************************
// oaIsProcessActive()
//
// This utility function checks to see if the process with the process id is
// active on the current machine.
// *****************************************************************************
extern OA_BASE_DLL_API
    oaBoolean
    oaIsProcessActive(oaUInt4 pid);



// *****************************************************************************
// oaStartDaemon()
//
// This utility function starts the daemon process by the given name.
// *****************************************************************************
extern OA_BASE_DLL_API
    void
    oaStartDaemon(const char    *name,
                  char *const   *argvIn = 0,
                  oaUInt4       numArgs = 0);



// *****************************************************************************
// oaCast
//
// oaCast macro serves as a safe downcast (dynamic_cast), while defaulting to 
// the better performing static_cast in other configurations.
// *****************************************************************************
#if defined(OA_CAST) && !(defined(OA_WINDOWS) && defined(_MSC_VER) && (_MSC_VER < 1400))
#define oaCast  dynamic_cast
#else
#define oaCast  static_cast
#endif



END_OA_NAMESPACE



#endif

Return to top of page

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