Leviathan::PotentiallySetIndex Struct Reference

#include <Types.h>

Public Member Functions
	PotentiallySetIndex (size_t index)
	PotentiallySetIndex ()=default
	operator bool () const
	operator size_t () const
bool	operator== (const PotentiallySetIndex &other) const
PotentiallySetIndex &	operator= (const PotentiallySetIndex &other)
PotentiallySetIndex &	operator= (const size_t &value)
bool	IsSet () const

Public Attributes
bool	ValueSet = false
size_t	Index = 0

Detailed Description

Definition at line 39 of file Types.h.

Constructor & Destructor Documentation

PotentiallySetIndex() [1/2]

Leviathan::PotentiallySetIndex::PotentiallySetIndex ( size_t  index )

inline

Definition at line 41 of file Types.h.

: ValueSet(true), Index(index) {}

PotentiallySetIndex() [2/2]

Leviathan::PotentiallySetIndex::PotentiallySetIndex ( )

inlinedefault

Member Function Documentation

IsSet()

bool Leviathan::PotentiallySetIndex::IsSet ( ) const

inline

Definition at line 85 of file Types.h.

    {

        return ValueSet;
    }

operator bool()

Leviathan::PotentiallySetIndex::operator bool ( ) const

inline

Definition at line 44 of file Types.h.

    {

        return ValueSet;
    }

operator size_t()

Leviathan::PotentiallySetIndex::operator size_t ( ) const

inline

Definition at line 50 of file Types.h.

    {
#ifdef _DEBUG
        LEVIATHAN_ASSERT(
            ValueSet, "PotentiallySetIndex size_t() called when ValueSet is false");
#endif // _DEBUG

        return Index;
    }

operator=() [1/2]

PotentiallySetIndex& Leviathan::PotentiallySetIndex::operator= ( const PotentiallySetIndex &  other )

inline

Definition at line 69 of file Types.h.

    {

        ValueSet = other.ValueSet;
        Index = other.Index;
        return *this;
    }

operator=() [2/2]

PotentiallySetIndex& Leviathan::PotentiallySetIndex::operator= ( const size_t &  value )

inline

Definition at line 77 of file Types.h.

    {

        ValueSet = true;
        Index = value;
        return *this;
    }

operator==()

bool Leviathan::PotentiallySetIndex::operator== ( const PotentiallySetIndex &  other ) const

inline

Definition at line 60 of file Types.h.

    {

        if(!ValueSet)
            return ValueSet == other.ValueSet;

        return Index == other.Index;
    }

Member Data Documentation

Index

size_t Leviathan::PotentiallySetIndex::Index = 0

Definition at line 92 of file Types.h.

ValueSet

bool Leviathan::PotentiallySetIndex::ValueSet = false

Definition at line 91 of file Types.h.

---

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

• Types.h