oaCommonPlugInError.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaCommonPlugInError.h
//
// This file contains the definition of the oaPlugInError class, which is used
// to throw plugin-related exceptions.
//
// *****************************************************************************
// 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(oaCommonError_P)
#define oaCommonError_P

#ifdef NDEBUG
#define oaCommonAssert(exp)            ((void)0)
#else
#define oaCommonAssert(exp) \
{\
    if (!(exp)) {\
      throw oaPlugInError (IBase::cFail, #exp);\
    }\
}
#endif


// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaCommonIBase.h"
#include <string>



// *****************************************************************************
// Declare and define types in the oaCommon namespace
// *****************************************************************************
BEGIN_OA_COMMON_NAMESPACE



// *****************************************************************************
// oaPlugInError
// *****************************************************************************
class OA_COMMON_DLL_API oaPlugInError : public IPlugInException {
public:
                            oaPlugInError(IBase::Status statusIn,
                                          const char    *msgIn = NULL);

    virtual oa::oaUInt4     getStatus() const;
    virtual oa::oaUInt4     getMsgId()  const;
    virtual const char      *getMsg() const;

private:
    const char              *getStandardMsg() const;

    IBase::Status           status;
    std::string             msg;
};



END_OA_COMMON_NAMESPACE

#endif

Return to top of page

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