#include <BitSpec.h>

Inheritance diagram for GlobalSim::BitSpec< Derived, N, Base >:

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

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

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 constexpr auto	allFields ()
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 ()

Friends
template<typename>
class	Object

Detailed Description

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

Definition at line 499 of file BitSpec.h.

Member Typedef Documentation

◆ BaseSpec

template<typename Derived, std::size_t N, typename Base = NoBase>

using GlobalSim::BitSpec< Derived, N, Base >::BaseSpec = Base

Definition at line 504 of file BitSpec.h.

◆ bitset_type

template<typename Derived, std::size_t N, typename Base = NoBase>

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

Definition at line 502 of file BitSpec.h.

Member Function Documentation

◆ allFields()

template<typename Derived, std::size_t N, typename Base = NoBase>

constexpr auto GlobalSim::BitSpec< Derived, N, Base >::allFields ( )

inlinestaticconstexprprotected

Definition at line 549 of file BitSpec.h.

        {
            return std::tuple_cat(
                    Base::allFields(),
                    Derived::fields
            );
        }

◆ checkOverlap()

template<typename Derived, std::size_t N, typename Base = NoBase>

template<typename A, typename B>

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

inlinestaticconstevalprivate

Definition at line 629 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, typename Base = NoBase>

template<std::size_t I>

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

inlinestaticconstexpr

Definition at line 508 of file BitSpec.h.

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

◆ forEachField()

template<typename Derived, std::size_t N, typename Base = NoBase>

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

inlinestaticconstexpr

Definition at line 520 of file BitSpec.h.

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

◆ json()

template<typename Derived, std::size_t N, typename Base = NoBase>

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

inlinestaticconstexpr

Definition at line 525 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, typename Base = NoBase>

template<typename... Fields>

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

inlinestaticconstexprprotected

Definition at line 544 of file BitSpec.h.

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

◆ numFields()

template<typename Derived, std::size_t N, typename Base = NoBase>

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

inlinestaticconstexpr

Definition at line 515 of file BitSpec.h.

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

◆ packFields()

template<typename Derived, std::size_t N, typename Base = NoBase>

template<typename Fields>

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

inlinestatic

Definition at line 563 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, typename Base = NoBase>

template<typename Field>

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

inlinestaticconstevalprivate

Definition at line 620 of file BitSpec.h.

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

◆ validateFieldList()

template<typename Derived, std::size_t N, typename Base = NoBase>

template<typename First, typename... Rest>

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

inlinestaticconstevalprivate

Definition at line 604 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, typename Base = NoBase>

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

inlinestaticconstevalprotected

Definition at line 587 of file BitSpec.h.

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

◆ Object

template<typename Derived, std::size_t N, typename Base = NoBase>

template<typename>

friend class Object

friend

Definition at line 503 of file BitSpec.h.

Member Data Documentation

◆ width

template<typename Derived, std::size_t N, typename Base = NoBase>

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

staticconstexpr

Definition at line 501 of file BitSpec.h.

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

BitSpec.h

Public Types

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Static Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ BaseSpec

◆ bitset_type

Member Function Documentation

◆ allFields()

◆ checkOverlap()

◆ field()

◆ forEachField()

◆ json()

◆ makeFields()

◆ numFields()

◆ packFields()

◆ validateField()

◆ validateFieldList()

◆ validateFields()

Friends And Related Symbol Documentation

◆ Object

Member Data Documentation

◆ width