libSBML C# API  libSBML 5.12.0 C# API
libsbmlcs.SBMLConstructorException Class Reference
Inheritance diagram for libsbmlcs.SBMLConstructorException:
[legend]

Detailed Description

{core}

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

virtual void Dispose ()
 
string getSBMLErrMsg ()
 Returns the message associated with this SBML exception. More...
 
 SBMLConstructorException (string v)
 
 SBMLConstructorException ()
 
 SBMLConstructorException (string errmsg, string sbmlErrMsg)
 
 SBMLConstructorException (string elementName, SBMLNamespaces xmlns)
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

libsbmlcs.SBMLConstructorException.SBMLConstructorException ( string  v)
libsbmlcs.SBMLConstructorException.SBMLConstructorException ( )
libsbmlcs.SBMLConstructorException.SBMLConstructorException ( string  errmsg,
string  sbmlErrMsg 
)
libsbmlcs.SBMLConstructorException.SBMLConstructorException ( string  elementName,
SBMLNamespaces  xmlns 
)

Member Function Documentation

virtual void libsbmlcs.SBMLConstructorException.Dispose ( )
virtual
string libsbmlcs.SBMLConstructorException.getSBMLErrMsg ( )

Returns the message associated with this SBML exception.

Returns
the message string.

Member Data Documentation

bool libsbmlcs.SBMLConstructorException.swigCMemOwn
protected