Errors Class Reference

#include <errors.hpp>

Static Public Member Functions
static void	Validate (const Error_t error)
	Receives an error state and sets up the corresponding LED indicator. More...
static Error_t	Precison_Threshold (double error_val, double error_limit)
	Receives error value and error threshold and returns an appropriate error state. More...
template<unsigned int Lin_channels, index_t Series_size, unsigned int Bin_Ratio>
static Error_t	Auto_MultiTau_Input_Validator ()
	Input Validator for MultiTau auto-correlator. More...
static void	_assert_ (bool expression, const char *__attribute__((unused)) message="")
	Custom assertion function. More...

Detailed Description

@breif Contains functions that handle errors of type Error_t.

Member Function Documentation

_assert_()

static void Errors::_assert_ ( bool  expression, const char *__attribute__((unused))  message = ""  )

inlinestatic

Custom assertion function.

Parameters

expression	which must evaluate to false for the assertion to call abort.
message	which is ignored in the function, but helps with code redability

Auto_MultiTau_Input_Validator()

template<unsigned int Lin_channels, index_t Series_size, unsigned int Bin_Ratio>

static Error_t Errors::Auto_MultiTau_Input_Validator ( )

inlinestatic

Input Validator for MultiTau auto-correlator.

Todo:

Change name to indicate Auto Correlator link.

Precison_Threshold()

static Error_t Errors::Precison_Threshold ( double  error_val, double  error_limit  )

inlinestatic

Receives error value and error threshold and returns an appropriate error state.

Validate()

static void Errors::Validate ( const Error_t  error )

inlinestatic

Receives an error state and sets up the corresponding LED indicator.

---

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

• code/hardware/errors.hpp