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

Exception thrown when a key is already contained in a MultiHandedClock. More...

#include <multi_clock_exceptions.hpp>

Inheritance diagram for zero::multi_clock::MultiHandedClockAlreadyContainedException< 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

 MultiHandedClockAlreadyContainedException (const MultiHandedClock< key_type, value_type, clock_count, invalid_index, invalid_clock_index > *multiHandedClock, const key_type &alreadyContainedIndex)
 Constructor of an exception thrown when a key was unexpectedly already contained in any clock of the MultiHandedClock. 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 key_type _alreadyContainedIndex
 The unexpected key. 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::MultiHandedClockAlreadyContainedException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >

Exception thrown when a key is already contained in a MultiHandedClock.

Represents an exception that can be thrown in instances of MultiHandedClock when a key was unexpectedly already contained in any clock of the MultiHandedClock.

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

§ MultiHandedClockAlreadyContainedException()

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::MultiHandedClockAlreadyContainedException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::MultiHandedClockAlreadyContainedException ( const MultiHandedClock< key_type, value_type, clock_count, invalid_index, invalid_clock_index > *  multiHandedClock,
const key_type &  alreadyContainedIndex 
)
inline

Constructor of an exception thrown when a key was unexpectedly already contained in any clock of the MultiHandedClock.

This constructor instantiates an MultiHandedClockAlreadyContainedException with all its variables.

Parameters
multiHandedClockSee _multiHandedClock.
alreadyContainedIndexSee _alreadyContainedIndex.

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::MultiHandedClockAlreadyContainedException< key_type, value_type, clock_count, invalid_index, invalid_clock_index >::what ( ) const
inlineoverridenoexcept

Member Data Documentation

§ _alreadyContainedIndex

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

The unexpected key.

The key that was unexpectedly already contained.


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