oaDMException.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaDMException.h
//
// This file contains the definitions for the classes which return information
// for cellview database exceptions.
//
// oaDMException
//     This is the base class for cellview database exceptions.
//
// oaDMError
//     This class is used to return information about cellview database
// exceptions.
//
// oaDMPlugInError
//     This oaDMError derived class is specialized to wrap an IException, such 
//     as those received from the plug-ins. It represents 
//     an `oacInterfaceException` which also report the information about the 
//     originating Plug-In exception.
//
// *****************************************************************************
// 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(oaDMException_P)
#define oaDMException_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaException.h"
#include "oaDMTypes.h"
#include "oaDMMsgs.h"



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



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

protected:
    virtual const oaString  &getFormatString() const;
};



// *****************************************************************************
// oaDMError
// *****************************************************************************
class OA_DM_DLL_API oaDMError : public oaDMException {
public:
                            oaDMError(oaUInt4 msgIdIn,
                                      ...);
    virtual inline          ~oaDMError();
};



// *****************************************************************************
// oaDMPlugInError
// *****************************************************************************
class OA_DM_DLL_API oaDMPlugInError : public oaDMError {
public:
                            oaDMPlugInError(oaDMMsgIds      msgIdIn,
                                            const oaString  &systemName,
                                            const oaString  &libNameStr,
                                            oaUInt4         plugInMsgIdIn,
                                            const oaString  &plugInMsgStr);

    oaUInt4                 getPlugInMsgId() const;

private:
    oaUInt4                 plugInMsgId;
};



END_OA_NAMESPACE

#endif

Return to top of page

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