Zero  0.1.0
Public Member Functions | Protected Attributes | List of all members
zero::multi_clock::MultiHandedClockException< key_type, value_type, clock_count, invalid_index, invalid_clock_index > Class Template Reference

Exception thrown in a MultiHandedClock. More...

#include <multi_clock_exceptions.hpp>

Inheritance diagram for zero::multi_clock::MultiHandedClockException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >:
zero::multi_clock::MultiHandedClockAlreadyContainedException< key_type, value_type, clock_count, invalid_index, invalid_clock_index > zero::multi_clock::MultiHandedClockEmptyException< key_type, value_type, clock_count, invalid_index, invalid_clock_index > zero::multi_clock::MultiHandedClockInvalidIndexException< key_type, value_type, clock_count, invalid_index, invalid_clock_index > zero::multi_clock::MultiHandedClockNotContainedException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >

Public Member Functions

 MultiHandedClockException (const MultiHandedClock< key_type, value_type, clock_count, invalid_index, invalid_clock_index > *multiHandedClock)
 Constructor of an exception thrown in MultiHandedClock. More...
 
const char * what () const noexcept override
 What caused the exception happened? More...
 

Protected Attributes

const MultiHandedClock< key_type, value_type, clock_count, invalid_index, invalid_clock_index > * _multiHandedClock
 The MultiHandedClock. More...
 

Detailed Description

template<class key_type, class value_type, uint32_t clock_count, key_type invalid_index, key_type invalid_clock_index = clock_count>
class zero::multi_clock::MultiHandedClockException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >

Exception thrown in a MultiHandedClock.

Represents an arbitrary exception that can be thrown in instances of MultiHandedClock. Every exception that is specific for the MultiHandedClock have to inherit from this class.

Template Parameters
key_typeThe key type of the corresponding MultiHandedClock.
value_typeThe value type of the corresponding MultiHandedClock.
clock_countThe number of clocks contained in the corresponding MultiHandedClock.
invalid_indexThe invalid key used in the corresponding MultiHandedClock.
invalid_clock_indexThe invalid clock index used in the corresponding MultiHandedClock.
Author
Max Gilbert

Constructor & Destructor Documentation

§ MultiHandedClockException()

template<class key_type , class value_type , uint32_t clock_count, key_type invalid_index, key_type invalid_clock_index = clock_count>
zero::multi_clock::MultiHandedClockException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::MultiHandedClockException ( const MultiHandedClock< key_type, value_type, clock_count, invalid_index, invalid_clock_index > *  multiHandedClock)
inline

Constructor of an exception thrown in MultiHandedClock.

This constructor instantiates an MultiHandedClockException with all its variables.

Parameters
multiHandedClockSee _multiHandedClock.

Member Function Documentation

§ what()

template<class key_type , class value_type , uint32_t clock_count, key_type invalid_index, key_type invalid_clock_index = clock_count>
zero::multi_clock::MultiHandedClockException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::what ( ) const
inlineoverridenoexcept

What caused the exception happened?

Returns description about what caused this exception to be thrown.

Returns
A description about what caused this exception to be thrown.

Member Data Documentation

§ _multiHandedClock

template<class key_type , class value_type , uint32_t clock_count, key_type invalid_index, key_type invalid_clock_index = clock_count>
zero::multi_clock::MultiHandedClockException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::_multiHandedClock
protected

The MultiHandedClock.

A pointer to the MultiHandedClock where this exception was thrown.


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