libSBML C++ API  5.20.2
SBMLConstructorException Class Reference
Inheritance diagram for SBMLConstructorException:
[legend]

Detailed Description

Exceptions thrown by some libSBML constructors.

In some situations, constructors for SBML objects may need to indicate to callers that the creation of the object failed. The failure may be for different reasons, such as an attempt to use invalid parameters or a system condition such as a memory error. To communicate this to callers, those classes will throw an SBMLConstructorException.

In languages that don't have an exception mechanism (e.g., C), the constructors generally try to return an error code instead of throwing an exception.

Public Member Functions

const std::string getSBMLErrMsg () const
 Returns the message associated with this SBML exception. More...
 

Private Attributes

std::string mSBMLErrMsg
 

Member Function Documentation

◆ getSBMLErrMsg()

const std::string SBMLConstructorException::getSBMLErrMsg ( ) const
inline

Returns the message associated with this SBML exception.

Returns
the message string.

Member Data Documentation

◆ mSBMLErrMsg

std::string SBMLConstructorException::mSBMLErrMsg
private