ExceptionBase Class Reference

Inheritance diagram for ExceptionBase:

IException


Public Methods

 ExceptionBase (oa::oaUInt4 idIn, const char *msgIn)
virtual oa::oaUInt4 getMsgId () const
virtual const char * getMsg () const

Detailed Description

This is a base class that clients can use to derive their own IException based exception classes.

Constructor & Destructor Documentation

ExceptionBase::ExceptionBase (  oa::oaUInt4    idIn,
const char *    msgIn
)  [inline]
 

This constructor takes in the exception ID and the message string. Note that the plug-in system makes no assumptions about the values of the ID - the clients must interpret them in the context of the plug-in that throws the exception.

Parameters:
idIn An integer representing the ID value of this exception
msgIn A c-style string to use as the message for this exception.

Member Function Documentation

const char * ExceptionBase::getMsg (    )  const [inline, virtual]
 

This function implements the IException::getMsg() function. It return a pointer to a copy of the c-style string that was passed into the msgIn parameter of the constructor.

Implements IException.

oa::oaUInt4 ExceptionBase::getMsgId (    )  const [inline, virtual]
 

This function implements the IException::getMsgId() function. It returns the value that was passed in to the idIn parameter of the constructor.

Implements IException.

The documentation for this class was generated from the following files:

Return to top of page




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