BitReference.hpp

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: BitReference
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/BaseValues.h>
#include <NDEVR/BitFlag.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief  A convenience class used with Buffers or Vectors of bools for referencing or acting on a
        single bit.
    **/
    class BitReference
    {
    public:
        constexpr BitReference(BitFlag& flag, uint01 bit)
            : m_flag(flag)
            , m_bit(bit)
        {
            lib_assert(bit < 8, "Bit out of expected range");
        }
        constexpr BitReference(const BitReference& reference)
            : m_flag(reference.m_flag)
            , m_bit(reference.m_bit)
        {}
 
        [[nodiscard]] constexpr bool get() const
        {
            return m_flag[m_bit];
        }
        constexpr void set(const bool& value)
        {
            m_flag(m_bit, value);
        }
        constexpr BitReference& operator=(const bool& b)
        {
            m_flag(m_bit, b);
            return *this;
        };
        constexpr BitReference& operator=(const BitReference& b)
        {
            m_flag(m_bit, b.get());
            return *this;
        };
        constexpr BitReference& operator|=(const bool& b)
        {
            m_flag(m_bit, b || get());
            return *this;
        };
        constexpr BitReference& operator|=(const BitReference& b)
        {
            m_flag(m_bit, b.get() || get());
            return *this;
        };
        constexpr bool operator==(const bool& b) const
        {
            return get() == b;
        };
        constexpr bool operator!=(const bool& b) const
        {
            return get() != b;
        };
        constexpr operator bool() const
        {
            return m_flag[m_bit];
        }
        constexpr bool operator!() const
        {
            return !m_flag[m_bit];
        }
    private:
        BitFlag& m_flag;
        const uint01 m_bit;
    };
 
    template<class t_to>
    constexpr t_to cast(BitReference value)
    {
        return static_cast<t_to>(value.get());
    }
};