fcml::ErrorContainerAwareException Class Reference

Base class for all exceptions that are aware of ErrorContainer. More...

#include <fcml_errors.hpp>

Inheritance diagram for fcml::ErrorContainerAwareException:

Collaboration diagram for fcml::ErrorContainerAwareException:

Public Member Functions
	ErrorContainerAwareException (const fcml_cstring &msg, const ErrorContainer &errorContainer, fcml_ceh_error error=FCML_CEH_GEC_NO_ERROR)
	Creates an error container aware exception instance and sets basic information for it.
const ErrorContainer &	getErrorContainer () const
	Gets a reference to an error container associated with the exception.
void	setErrorContainer (const ErrorContainer &errorContainer)
	Sets a new error container for the exception.
Public Member Functions inherited from fcml::BaseException
	BaseException (fcml_ceh_error error=FCML_CEH_GEC_NO_ERROR)
	BaseException (const fcml_cstring &msg, fcml_ceh_error error=FCML_CEH_GEC_NO_ERROR)
	BaseException (const BaseException &cpy)
BaseException &	operator= (const BaseException &exc)
const fcml_cstring	getMsg () const
const fcml_ceh_error &	getError () const

Detailed Description

Base class for all exceptions that are aware of ErrorContainer.

Since

1.1.0

Constructor & Destructor Documentation

ErrorContainerAwareException()

fcml::ErrorContainerAwareException::ErrorContainerAwareException ( const fcml_cstring & msg, const ErrorContainer & errorContainer, fcml_ceh_error error = FCML_CEH_GEC_NO_ERROR )

inline

Creates an error container aware exception instance and sets basic information for it.

Parameters

msg	An error message.
errorContainer	An error container for exception.
error	An optional FCML error code.

Since

1.1.0

Member Function Documentation

getErrorContainer()

const ErrorContainer & fcml::ErrorContainerAwareException::getErrorContainer ( ) const

inline

Gets a reference to an error container associated with the exception.

Returns

The error container.

Since

1.1.0

setErrorContainer()

void fcml::ErrorContainerAwareException::setErrorContainer ( const ErrorContainer & errorContainer )

inline

Sets a new error container for the exception.

Parameters

errorContainer

The new error container to be set for the exception.

Since

1.1.0

---

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

• include/fcml_errors.hpp