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

Exception thrown when a MultiHandedClock is empty. More...

#include <multi_clock_exceptions.hpp>

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

Public Member Functions

 MultiHandedClockEmptyException (const MultiHandedClock< key_type, value_type, clock_count, invalid_index, invalid_clock_index > *multiHandedClock, const ClockIndex &emptyClock)
 Constructor of an exception thrown when an MultiHandedClock is empty. More...
 
const char * what () const noexcept override
 
- Public Member Functions inherited from 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)
 Constructor of an exception thrown in MultiHandedClock. More...
 
const char * what () const noexcept override
 What caused the exception happened? More...
 

Protected Attributes

const ClockIndex _emptyClock
 Index of the Empty Clock. More...
 
- Protected Attributes inherited from zero::multi_clock::MultiHandedClockException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >
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::MultiHandedClockEmptyException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >

Exception thrown when a MultiHandedClock is empty.

Represents an exception that can be thrown in instances of MultiHandedClock when it is unexpectedly empty.

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

§ MultiHandedClockEmptyException()

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::MultiHandedClockEmptyException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::MultiHandedClockEmptyException ( const MultiHandedClock< key_type, value_type, clock_count, invalid_index, invalid_clock_index > *  multiHandedClock,
const ClockIndex emptyClock 
)
inline

Constructor of an exception thrown when an MultiHandedClock is empty.

This constructor instantiates an MultiHandedClockEmptyException with all its variables.

Parameters
multiHandedClockSee _multiHandedClock.
emptyClockSee _emptyClock.

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>
const char* zero::multi_clock::MultiHandedClockEmptyException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::what ( ) const
inlineoverridenoexcept

Member Data Documentation

§ _emptyClock

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::MultiHandedClockEmptyException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::_emptyClock
protected

Index of the Empty Clock.

The index of the clock that was unexpectedly empty (corresponding to _multiHandedClock ).


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