GlobalSim::BitSpec< Derived, N > Class Template Reference

#include <BitSpec.h>

Collaboration diagram for GlobalSim::BitSpec< Derived, N >:

Public Types
using	bitset_type = std::bitset<N>

Static Public Member Functions
template<std::size_t I>
static constexpr decltype(auto)	field ()
static constexpr std::size_t	numFields ()
static constexpr void	forEachField (auto &&func)
static constexpr std::string	json ()
template<typename Fields>
static bitset_type	packFields (const Fields &fields, const SG::AuxElement &obj)

Static Public Attributes
static constexpr std::size_t	width = N

Static Protected Member Functions
template<typename... Fields>
static constexpr auto	makeFields (Fields &... fields)
static consteval bool	validateFields ()

Static Private Member Functions
template<typename First, typename... Rest>
static consteval bool	validateFieldList ()
template<typename Field>
static consteval bool	validateField ()
template<typename A, typename B>
static consteval bool	checkOverlap ()

Detailed Description

template<typename Derived, std::size_t N>
class GlobalSim::BitSpec< Derived, N >

Definition at line 390 of file BitSpec.h.

Member Typedef Documentation

bitset_type

template<typename Derived, std::size_t N>

using GlobalSim::BitSpec< Derived, N >::bitset_type = std::bitset<N>

Definition at line 393 of file BitSpec.h.

Member Function Documentation

checkOverlap()

template<typename Derived, std::size_t N>

template<typename A, typename B>

consteval bool GlobalSim::BitSpec< Derived, N >::checkOverlap ( )

inlinestaticconstevalprivate

Definition at line 510 of file BitSpec.h.

                                             {
            if (A::lo <= B::hi && B::lo <= A::hi) {
                return true;
            }
            return false;
        }

field()

template<typename Derived, std::size_t N>

template<std::size_t I>

constexpr decltype(auto) GlobalSim::BitSpec< Derived, N >::field ( )

inlinestaticconstexpr

Definition at line 398 of file BitSpec.h.

                                                                      {
            return *std::get<I>(Derived::fields);
        }

forEachField()

template<typename Derived, std::size_t N>

constexpr void GlobalSim::BitSpec< Derived, N >::forEachField ( auto && func )

inlinestaticconstexpr

Definition at line 410 of file BitSpec.h.

                                                        {
            std::apply([&](const auto *... field) { (func(*field), ...); }, Derived::fields);
        }

json()

template<typename Derived, std::size_t N>

constexpr std::string GlobalSim::BitSpec< Derived, N >::json ( )

inlinestaticconstexpr

Definition at line 415 of file BitSpec.h.

                                          {
            nlohmann::json j;
            j["data_width"] = width;
            j["fields"] = nlohmann::json::array();
            forEachField([&](const auto &field) {
                nlohmann::json f;
                f["name"] = field.name();
                f["description"] = field.description();
                f["start"] = field.lo;
                f["width"] = field.width;
                j["fields"].push_back(f);
            });
            return j.dump(4);
        }

makeFields()

template<typename Derived, std::size_t N>

template<typename... Fields>

constexpr auto GlobalSim::BitSpec< Derived, N >::makeFields ( Fields &... fields )

inlinestaticconstexprprotected

Definition at line 434 of file BitSpec.h.

                                                             {
            return std::tuple{&fields...};
        }

numFields()

template<typename Derived, std::size_t N>

constexpr std::size_t GlobalSim::BitSpec< Derived, N >::numFields ( )

inlinestaticconstexpr

Definition at line 405 of file BitSpec.h.

                    {
            return std::tuple_size_v < std::remove_cvref_t < decltype(Derived::fields) >> ;
        }

packFields()

template<typename Derived, std::size_t N>

template<typename Fields>

bitset_type GlobalSim::BitSpec< Derived, N >::packFields ( const Fields & fields, const SG::AuxElement & obj )

inlinestatic

Definition at line 444 of file BitSpec.h.

                                                                                     {
            bitset_type result;
 
            std::apply(
                    [&](const auto *... field) {
                        (field->pack(result, obj), ...);
                    },
                    fields);
 
            return result;
        }

validateField()

template<typename Derived, std::size_t N>

template<typename Field>

consteval bool GlobalSim::BitSpec< Derived, N >::validateField ( )

inlinestaticconstevalprivate

Definition at line 501 of file BitSpec.h.

                                              {
            return Field::lo <= Field::hi && Field::hi < N;
        }

validateFieldList()

template<typename Derived, std::size_t N>

template<typename First, typename... Rest>

consteval bool GlobalSim::BitSpec< Derived, N >::validateFieldList ( )

inlinestaticconstevalprivate

Definition at line 485 of file BitSpec.h.

        {
            if constexpr (sizeof...(Rest) == 0)
            {
                return validateField<First>();
            }
            else
            {
                return validateField<First>() &&
                       (validateField<Rest>() && ...) &&
                       ((!checkOverlap<First, Rest>()) && ...) &&
                       validateFieldList<Rest...>();
            }
        }

validateFields()

template<typename Derived, std::size_t N>

consteval bool GlobalSim::BitSpec< Derived, N >::validateFields ( )

inlinestaticconstevalprotected

Definition at line 468 of file BitSpec.h.

        {
            return std::apply(
                    []<typename... FieldPtrs>(FieldPtrs... field) {
                        return validateFieldList<
                               std::remove_cvref_t<decltype(*field)>...
                        >();
                    },
                    Derived::fields);
        }

Member Data Documentation

width

template<typename Derived, std::size_t N>

std::size_t GlobalSim::BitSpec< Derived, N >::width = N

staticconstexpr

Definition at line 392 of file BitSpec.h.

---

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

• BitSpec.h