Fawkes API Fawkes Development Version
fawkes::OutOfBoundsException Class Reference

Index out of bounds. More...

#include <>>

Inheritance diagram for fawkes::OutOfBoundsException:

Public Member Functions

 OutOfBoundsException (const char *msg) noexcept
 Constructor. More...
 
 OutOfBoundsException (const char *msg, float val, float min, float max) noexcept
 Range constructor. More...
 
- Public Member Functions inherited from fawkes::Exception
 Exception (const char *format,...) noexcept
 Constructor. More...
 
 Exception (int errnoval, const char *format,...) noexcept
 Constructor. More...
 
 Exception (const Exception &exc) noexcept
 Copy constructor. More...
 
virtual ~Exception () noexcept
 Destructor. More...
 
virtual void raise ()
 This can be used to throw this exception. More...
 
void prepend (const char *format,...) noexcept
 Prepend messages to the message list. More...
 
void append (const char *format,...) noexcept
 Append messages to the message list. More...
 
void append_va (const char *format, va_list va) noexcept
 Append messages to the message list. More...
 
void append (const Exception &e) noexcept
 Append message that are from another Exception. More...
 
void print_trace () noexcept
 Prints trace to stderr. More...
 
void print_backtrace () const noexcept
 Prints a backtrace. More...
 
char * generate_backtrace () const noexcept
 Generate backtrace string. More...
 
int get_errno () noexcept
 Get errno. More...
 
void set_type_id (const char *id)
 Set exception type ID. More...
 
const char * type_id () const
 Get type ID. More...
 
virtual const char * what () const noexcept
 Get primary string. More...
 
virtual const char * what_no_backtrace () const noexcept
 Get primary string (does not implicitly print the back trace). More...
 
Exceptionoperator= (const Exception &exc) noexcept
 Assign an Exception. More...
 
iterator begin () noexcept
 Get iterator for messages. More...
 
iterator end () noexcept
 Get end iterator for messages. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Exception
 Exception () noexcept
 Constructor for subclasses. More...
 
void append_nolock (const char *format,...) noexcept
 Append messages without lock. More...
 
void append_nolock_va (const char *format, va_list va) noexcept
 Append messages without lock by formatted string. More...
 
void append_nolock_nocopy (char *msg) noexcept
 Append message without copying. More...
 
void prepend_nolock_va (const char *format, va_list va) noexcept
 Prepend messages without lock by formatted string. More...
 
void copy_messages (const Exception &exc) noexcept
 Copy messages from given exception. More...
 
- Protected Attributes inherited from fawkes::Exception
message_list_tmessages
 List of messages. More...
 
message_list_tmessages_iterator
 Iterator to iterate over messages. More...
 
message_list_tmessages_end
 Pointer that points to the very last message. More...
 
Mutexmessages_mutex
 Mutex to protect operations on messages list. More...
 
int _errno
 Error number, should be used if the error was caused by a method that supplies errno. More...
 

Detailed Description

Index out of bounds.

Throw this exception if a value is out of bounds or if someone tries to access an iterator that is not in the allowed range.

Definition at line 85 of file software.h.

Constructor & Destructor Documentation

◆ OutOfBoundsException() [1/2]

fawkes::OutOfBoundsException::OutOfBoundsException ( const char *  msg)
noexcept

Constructor.

Parameters
msginformative message, appended to exception, base message is "Out Of Bounds"

Definition at line 193 of file software.cpp.

◆ OutOfBoundsException() [2/2]

fawkes::OutOfBoundsException::OutOfBoundsException ( const char *  msg,
float  val,
float  min,
float  max 
)
noexcept

Range constructor.

Additionally to the message the ranges and actual values are added to the primary message.

Parameters
msginformative message
valactual value
minminimum required value
maxmaximum allowed value

Definition at line 206 of file software.cpp.


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