StormByte::ArithmeticMutexed< T > Class Template Reference

Inheritance diagram for StormByte::ArithmeticMutexed< T >:

Collaboration diagram for StormByte::ArithmeticMutexed< T >:

Public Member Functions
	ArithmeticMutexed () noexcept=default
	ArithmeticMutexed (const T &value) noexcept
	ArithmeticMutexed (T &&value) noexcept
	ArithmeticMutexed (const ArithmeticMutexed &other) noexcept=default
	ArithmeticMutexed (ArithmeticMutexed &&other) noexcept=default
ArithmeticMutexed &	operator= (const ArithmeticMutexed &other) noexcept=default
ArithmeticMutexed &	operator= (ArithmeticMutexed &&other) noexcept=default
ArithmeticMutexed &	operator= (const T &value) noexcept override
ArithmeticMutexed &	operator= (T &&value) noexcept override
std::strong_ordering	operator<=> (const ArithmeticMutexed &other) const noexcept
bool	operator!= (const ArithmeticMutexed &other) const noexcept
ArithmeticMutexed	operator+ (const ArithmeticMutexed &value) const noexcept
ArithmeticMutexed	operator+ (ArithmeticMutexed &&value) const noexcept
ArithmeticMutexed &	operator+= (ArithmeticMutexed &value) noexcept
ArithmeticMutexed &	operator+= (ArithmeticMutexed &&value) noexcept
T	operator+ (const T &value) const noexcept
T	operator+ (T &&value) const noexcept
T &	operator+= (T &value) noexcept
T &	operator+= (T &&value) noexcept
Public Member Functions inherited from StormByte::Mutexed< T >
	Mutexed () noexcept=default
	Default constructor.
	Mutexed (const T &value) noexcept
	Constructor with value.
	Mutexed (const Mutexed< T > &other) noexcept
	Copy constructor.
	Mutexed (Mutexed< T > &&other) noexcept
	Move constructor.
Mutexed< T > &	operator= (const Mutexed< T > &other) noexcept
	Copy assignment operator.
Mutexed< T > &	operator= (Mutexed< T > &&other) noexcept
	Move assignment operator.
virtual	~Mutexed () noexcept=default
	Destructor.
std::strong_ordering	operator<=> (const Mutexed &other) const noexcept
	Spaceship operator for comparison.
bool	operator!= (const Mutexed &other) const noexcept
	Inequality operator.
virtual T &	operator* () noexcept
	Dereference operator (use with explicit locking).
virtual const T &	operator* () const noexcept
	Dereference operator (use with explicit locking).
virtual T *	operator-> () noexcept
	Pointer dereference operator (use with explicit locking).
virtual const T *	operator-> () const noexcept
	Pointer dereference operator (use with explicit locking).
void	Lock () const
	Locks the mutex.
void	Unlock () const
	Unlocks the mutex.

Additional Inherited Members
Protected Attributes inherited from StormByte::Mutexed< T >
T	m_value
	Value.
std::mutex	m_mutex
	Mutex.

Constructor & Destructor Documentation

ArithmeticMutexed() [1/5]

template<typename T >

StormByte::ArithmeticMutexed< T >::ArithmeticMutexed ( )

defaultnoexcept

Default constructor

ArithmeticMutexed() [2/5]

template<typename T >

StormByte::ArithmeticMutexed< T >::ArithmeticMutexed ( const T &  value )

inlinenoexcept

Constructor with value

Parameters

value

value to set

ArithmeticMutexed() [3/5]

template<typename T >

StormByte::ArithmeticMutexed< T >::ArithmeticMutexed ( T &&  value )

inlinenoexcept

Constructor with value

Parameters

value

value to set

ArithmeticMutexed() [4/5]

template<typename T >

StormByte::ArithmeticMutexed< T >::ArithmeticMutexed ( const ArithmeticMutexed< T > &  other )

defaultnoexcept

Copy constructor

Parameters

value

value to set

ArithmeticMutexed() [5/5]

template<typename T >

StormByte::ArithmeticMutexed< T >::ArithmeticMutexed ( ArithmeticMutexed< T > &&  other )

defaultnoexcept

Move constructor

Parameters

value

value to set

Member Function Documentation

operator!=()

template<typename T >

bool StormByte::ArithmeticMutexed< T >::operator!= ( const ArithmeticMutexed< T > &  other ) const

inlinenoexcept

InEquality operator

Parameters

other

other value to compare

Returns

false if equal

operator+() [1/4]

template<typename T >

ArithmeticMutexed StormByte::ArithmeticMutexed< T >::operator+ ( ArithmeticMutexed< T > &&  value ) const

inlinenoexcept

Addition operator

Parameters

value

value to add

Returns

reference to this

operator+() [2/4]

template<typename T >

ArithmeticMutexed StormByte::ArithmeticMutexed< T >::operator+ ( const ArithmeticMutexed< T > &  value ) const

inlinenoexcept

Addition operator

Parameters

value

value to add

Returns

reference to this

operator+() [3/4]

template<typename T >

T StormByte::ArithmeticMutexed< T >::operator+ ( const T &  value ) const

inlinenoexcept

Addition operator

Parameters

value

value to add

Returns

reference to this

operator+() [4/4]

template<typename T >

T StormByte::ArithmeticMutexed< T >::operator+ ( T &&  value ) const

inlinenoexcept

Addition operator

Parameters

value

value to add

Returns

reference to this

operator+=() [1/4]

template<typename T >

ArithmeticMutexed & StormByte::ArithmeticMutexed< T >::operator+= ( ArithmeticMutexed< T > &&  value )

inlinenoexcept

Addition operator with assignment

Parameters

value

value to add

Returns

reference to this

operator+=() [2/4]

template<typename T >

ArithmeticMutexed & StormByte::ArithmeticMutexed< T >::operator+= ( ArithmeticMutexed< T > &  value )

inlinenoexcept

Addition operator with assignment

Parameters

value

value to add

Returns

reference to this

operator+=() [3/4]

template<typename T >

T & StormByte::ArithmeticMutexed< T >::operator+= ( T &&  value )

inlinenoexcept

Addition operator with assignment

Parameters

value

value to add

Returns

reference to this

operator+=() [4/4]

template<typename T >

T & StormByte::ArithmeticMutexed< T >::operator+= ( T &  value )

inlinenoexcept

Addition operator with assignment

Parameters

value

value to add

Returns

reference to this

operator<=>()

template<typename T >

std::strong_ordering StormByte::ArithmeticMutexed< T >::operator<=> ( const ArithmeticMutexed< T > &  other ) const

inlinenoexcept

Spaceship operator

Parameters

other

other value to compare

Returns

strong ordering

operator=() [1/4]

template<typename T >

ArithmeticMutexed & StormByte::ArithmeticMutexed< T >::operator= ( ArithmeticMutexed< T > &&  other )

defaultnoexcept

Move assignment operator

Parameters

value

value to set

operator=() [2/4]

template<typename T >

ArithmeticMutexed & StormByte::ArithmeticMutexed< T >::operator= ( const ArithmeticMutexed< T > &  other )

defaultnoexcept

Copy assignment operator

Parameters

value

value to set

operator=() [3/4]

template<typename T >

ArithmeticMutexed & StormByte::ArithmeticMutexed< T >::operator= ( const T &  value )

inlineoverridevirtualnoexcept

Assignment operator

Parameters

value

value to set

Reimplemented from StormByte::Mutexed< T >.

operator=() [4/4]

template<typename T >

ArithmeticMutexed & StormByte::ArithmeticMutexed< T >::operator= ( T &&  value )

inlineoverridevirtualnoexcept

Assignment move operator

Parameters

value

value to set

Reimplemented from StormByte::Mutexed< T >.

---

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

• /home/runner/work/StormByte/StormByte/lib/public/StormByte/arithmetic_mutexed.hxx