@sbmlbrief{} TODO:Definition of the CaErrorLog class. More...

#include <CaErrorLog.h>

Inheritance diagram for CaErrorLog:

Public Member Functions
const CaError *	getError (unsigned int n) const
	Returns the nth CaError object in this log. More...

const CaError *	getErrorWithSeverity (unsigned int n, unsigned int severity) const
	Returns the nth CaError object with given severity in this log. More...

unsigned int	getNumFailsWithSeverity (unsigned int severity)
	Returns the number of errors that have been logged with the given severity code. More...

unsigned int	getNumFailsWithSeverity (unsigned int severity) const
	Returns the number of errors that have been logged with the given severity code. More...

Detailed Description

@sbmlbrief{} TODO:Definition of the CaErrorLog class.

Member Function Documentation

◆ getError()

const CaError * CaErrorLog::getError ( unsigned int n ) const

Returns the nth CaError object in this log.

Index n is counted from 0. Callers should first inquire about the number of items in the log by using the getNumErrors() method. Attempts to use an error index number that exceeds the actual number of errors in the log will result in a NULL being returned.

Parameters

n	the index number of the error to retrieve (with 0 being the first error).

Returns: the nth CaError in this log, or NULL if n is greater than or equal to getNumErrors()

See also: getNumErrors()

◆ getErrorWithSeverity()

const CaError * CaErrorLog::getErrorWithSeverity	(	unsigned int	n,
		unsigned int	severity
	)		const

Returns the nth CaError object with given severity in this log.

Index n is counted from 0. Callers should first inquire about the number of items in the log by using the getNumFailsWithSeverity() method. Attempts to use an error index number that exceeds the actual number of errors in the log will result in a NULL being returned.

Parameters

n	the index number of the error to retrieve (with 0 being the first error).
severity	the severity of the error to retrieve

Returns: the nth CaError in this log, or NULL if n is greater than or equal to getNumFailsWithSeverity()

See also: getNumFailsWithSeverity(unsigned int severity)

◆ getNumFailsWithSeverity() [1/2]

unsigned int CaErrorLog::getNumFailsWithSeverity ( unsigned int severity )

Returns the number of errors that have been logged with the given severity code.

Returns: a count of the number of errors with the given severity code.

See also: getNumErrors()

◆ getNumFailsWithSeverity() [2/2]

unsigned int CaErrorLog::getNumFailsWithSeverity ( unsigned int severity ) const