ecl_exceptions Documentation

ecl_exceptions

Template based exceptions - these are simple and practical and avoid the proliferation of exception types. Although not syntatactically ideal, it is convenient and eminently practical.

Embedded Control Library

    The embedded control libraries provide and internally make
    use of a variety of error mechanisms tailored to suit
    different situations. For lean and mean, there are c
    style error functions and macros in ecl_errors. 
    At a higher level, there are template based
    exceptions, these are defined in this library.

    These are further enabled via the use of macros which allow
    code location (file and line #) reporting as well as
    debug mode only handling.

Compiling & Linking

    Include the following at the top of any translation unit:

    @code
    #include <ecl/exceptions.hpp>

    // The exception classes
    using ecl::StandardException;
    using ecl::DataException;

    // Posix Tools
    using ecl::PosixErrorHandler;

    // Error flags (from ecl_errors)
    using ecl::ConfigurationError;
    using ecl::InvalidInputError;
    //...
    @endcode

    You will also need to link to <i>-lecl_exceptions</i>.

Guides

    - @ref errorsExceptions "Exceptions" - notes on ecl exception handling.

Examples

    - src/examples/exceptions.cpp : coverage style test for exceptions.
    - src/examples/exception_tracer.cpp : getting a bactrace via exceptions, posix style.

Benchmarks

    - ecl_core_apps/src/benchmarks/exceptions.cpp : benchmarks the latencies for exception handling.

ChangeLog

Changes

  - <b>Feb 11</b> : Moved exception classes here from ecl_errors.

Bugs



ecl_exceptions
Author(s): Daniel Stonier
autogenerated on Wed Mar 2 2022 00:16:17