oaException.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaException.h
//
// This file contains the definitions for the oaException, oaError, oaOSError
// and other derived error classes. These classes implement various types of 
// exception objects that OpenAccess may throw.
//
//  oaException
//      This is the base class for all the OA exceptions and errors.
//
//  oaError
//      This is the generic error class that is usually thrown by OA 
//      implementation.
//
//  oaOSError
//
//  oaSocketError
//
//  oaCompatiblityError
//      This new error class is not defined in this header, but it represents
//      the errors while data compatibility is limited by the presence of 
//      future features in the data.
//
//  oaMemoryError
//      This error class is designed to be used when the process run out of
//      memory. It does the allocation and initialzation seperately.
// *****************************************************************************
// 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(oaException_P)
#define oaException_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaString.h"
#include "oaArray.h"
#include <stdarg.h>



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



// *****************************************************************************
// Debug purpose Macro definitions
// *****************************************************************************
#ifdef NDEBUG
#define oaValidate(exp, errorID) ((void)0)
#define oaAssert(exp)            ((void)0)
#define oaInternalError(str)     ((void)0)
#define oaUnexpectedCase(value)  ((void)0)
#else
#define oaValidate(exp, errorID) \
{\
    if (!(exp)) {\
        throw oa::oaError(errorID);\
    }\
}
#define oaAssert(exp) \
{\
    if (!(exp)) {\
        throw oa::oaError(oa::oacInternalError, #exp, __FILE__, __LINE__);\
    }\
}
#define oaInternalError(str) throw oa::oaError(oa::oacInternalError, str, __FILE__, __LINE__)
#define oaUnexpectedCase(value) \
{\
    oa::oaString    str;\
    \
    str.format("Unexpected case %d", (oaUInt4) value);\
    \
    throw oa::oaError(oa::oacInternalError, (const char *) str, __FILE__, __LINE__);\
}
#endif



// *****************************************************************************
// oaException
// *****************************************************************************
class OA_BASE_DLL_API oaException {
public:
                            oaException(oaUInt4 msgIdIn);
    virtual inline          ~oaException();

    oaUInt4                 getMsgId() const;
    const oaString          &getMsg() const;

    static oaUInt8          getLastOSError();

protected:
    virtual const oaString  &getFormatString() const;

    void                    format(va_list &args);
    static oaUInt4          getOSErrorStr(oaString &errStr);

    oaUInt4                 msgId;
    oaString                msg;
};



// *****************************************************************************
// oaError
// *****************************************************************************
class OA_BASE_DLL_API oaError : public oaException {
public:
                            oaError(oaUInt4 msgIdIn,
                                    ...);
};



// *****************************************************************************
// oaOSError
// *****************************************************************************
class OA_BASE_DLL_API oaOSError : public oaException {
public:
                            oaOSError();
};



// *****************************************************************************
// oaSocketError
// *****************************************************************************
class OA_BASE_DLL_API oaSocketError : public oaException {
public:
                            oaSocketError();
};



// *****************************************************************************
// oaCompatibilityError
// *****************************************************************************
class OA_BASE_DLL_API oaCompatibilityError : public oaException {
public:
                            oaCompatibilityError(oaUInt4                msgIdIn,
                                                 const oaString         &dbNameIn,
                                                 const oaString         &dbType,
                                                 const oaString         &dbDataModelBuildNameIn,
                                                 oaUInt4                dbDataModelRevIn,
                                                 const oaFeatureArray   &features,
                                                 oaUInt4                limitType);

    const oaString          &getAppBuildName() const;
    const oaString          &getKitBuildName() const;
    const oaString          &getDataModelBuildName() const;
    const oaString          &getDatabaseName() const;

    oaUInt4                 getAppDataModelRev() const;
    oaUInt4                 getKitDataModelRev() const;
    oaUInt4                 getDBDataModelRev() const;

    const oaFeatureArray    &getFeatures() const;

private:
    oaFeatureArray          features;
    oaString                dbDataModelBuildName;
    oaUInt4                 dbDataModelRev;
    oaString                dbName;
};



// *****************************************************************************
// oaMemoryError
// *****************************************************************************
class OA_BASE_DLL_API oaMemoryError : public oaException {
public:
    virtual                 ~oaMemoryError();

    oaUInt8                 getAllocSize() const;
    oaUInt8                 getSbrk() const;
    oaUInt8                 getOAVMSize() const;
    oaUInt8                 getAvailableMem() const;
    oaUInt8                 getPhysicalMem() const;
    oaUInt8                 getLimitMem() const;
    oaBoolean               isUnlimited() const;

private:
                            oaMemoryError();
    void                    setValues(oaUInt4   newMsgId,
                                      size_t    size);

    oaUInt8                 allocSize;
    oaUInt8                 sbrkDiff;
    oaUInt8                 oaVMSize;
    oaUInt8                 available;
    oaUInt8                 physical;
    oaUInt8                 limit;
    void                    *obsolete;

    friend class oaMemoryErrorFactory;
};



END_OA_NAMESPACE

#endif

Return to top of page

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