FountainErrors.h File Reference

FountainErrorCode enum and FountainException class declaration. More...

#include "define.h"
#include <string>
#include <stdexcept>

Include dependency graph for FountainErrors.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	FountainException
	A base class for all exceptions thrown by various Fountain components. More...
class	FatalFountainException
	This class inherits from the FountainException class to override its isFatal method to distinguish between exceptions that should be rethrown when caught and those that should not. More...
Enumerations
enum	FountainErrorCode
Functions
bool	fountain_convert (const char *s, FountainErrorCode &t)
	Convert a string into an enum.
const char *	fountain_convert (FountainErrorCode t)
	Convert a FountainErrorCode enum into a string.

---

Detailed Description

FountainErrorCode enum and FountainException class declaration.

Definition in file FountainErrors.h.

---

Enumeration Type Documentation

enum FountainErrorCode

Contains error codes for various Fountain error states Definition at line 22 of file FountainErrors.h.

---

Function Documentation

const char* fountain_convert (  FountainErrorCode  t  )

Convert a FountainErrorCode enum into a string. Return values: char*  pointer to a static string with the enum value, returns NULL if the conversion failed. Definition at line 67 of file FountainErrors.cpp.

bool fountain_convert (  const char *  s, FountainErrorCode &  t )

Convert a string into an enum. Parameters: [in]  s  The string to convert [out]  t  the resulting enum value Precondition: Assigned(s), Assigned(t) Return values: bool  True if the conversion was successful, false otherwise Definition at line 28 of file FountainErrors.cpp.

---