GlobalSim::v1::GenericTOB Class Reference

#include <GenericTOB.h>

Inheritance diagram for GlobalSim::v1::GenericTOB:

Collaboration diagram for GlobalSim::v1::GenericTOB:

Public Types
using	bitset_type
using	BaseSpec

Public Member Functions
	DECLARE_FIELDS (et, eta, phi)

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

Static Public Attributes
static const BitField< 0, 12, float >	et {{.name="et", .auxvar="et", .description="Transverse energy", .scale=0.1, .centre=0}}
static const SignedBitField< 13, 22, float >	eta {{.name="eta", .auxvar="eta", .description="Eta coordinate", .scale=0.0125}}
static const UnclampedBitField< 23, 31, float >	phi {{.name="phi", .auxvar="phi", .description="Phi coordinate", .scale=M_PI / 256}}
static constexpr std::size_t	width

Static Protected Member Functions
static constexpr auto	makeFields (Fields &... fields)
static constexpr auto	allFields ()
static consteval bool	validateFields ()

Static Private Member Functions
static consteval bool	validateFieldList ()
static consteval bool	validateField ()
static consteval bool	checkOverlap ()

Detailed Description

Definition at line 13 of file Global/GlobalSimulation/GlobalSimulation/GenericTOB.h.

Member Typedef Documentation

BaseSpec

using GlobalSim::BitSpec< GenericTOB, N, NoBase >::BaseSpec

inherited

Definition at line 642 of file BitSpec.h.

bitset_type

using GlobalSim::BitSpec< GenericTOB, N, NoBase >::bitset_type

inherited

Definition at line 640 of file BitSpec.h.

Member Function Documentation

allFields()

constexpr auto GlobalSim::BitSpec< GenericTOB, N, NoBase >::allFields ( )

inlinestaticconstexprprotectedinherited

Definition at line 687 of file BitSpec.h.

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

checkOverlap()

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

inlinestaticconstevalprivateinherited

Definition at line 767 of file BitSpec.h.

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

DECLARE_FIELDS()

GlobalSim::v1::GenericTOB::DECLARE_FIELDS	(	et	,
		eta	,
		phi	)

field()

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

inlinestaticconstexprinherited

Definition at line 646 of file BitSpec.h.

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

forEachField()

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

inlinestaticconstexprinherited

Definition at line 658 of file BitSpec.h.

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

json()

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

inlinestaticconstexprinherited

Definition at line 663 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()

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

inlinestaticconstexprprotectedinherited

Definition at line 682 of file BitSpec.h.

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

numFields()

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

inlinestaticconstexprinherited

Definition at line 653 of file BitSpec.h.

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

packFields()

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

inlinestaticinherited

Definition at line 701 of file BitSpec.h.

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

validateField()

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

inlinestaticconstevalprivateinherited

Definition at line 758 of file BitSpec.h.

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

validateFieldList()

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

inlinestaticconstevalprivateinherited

Definition at line 742 of file BitSpec.h.

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

validateFields()

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

inlinestaticconstevalprotectedinherited

Definition at line 725 of file BitSpec.h.

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

Member Data Documentation

et

const BitField<0, 12, float> GlobalSim::v1::GenericTOB::et {{.name="et", .auxvar="et", .description="Transverse energy", .scale=0.1, .centre=0}}

inlinestatic

Definition at line 15 of file Global/GlobalSimulation/GlobalSimulation/GenericTOB.h.

{{.name="et", .auxvar="et", .description="Transverse energy", .scale=0.1/*GeV*/, .centre=0}};

eta

const SignedBitField<13, 22, float> GlobalSim::v1::GenericTOB::eta {{.name="eta", .auxvar="eta", .description="Eta coordinate", .scale=0.0125}}

inlinestatic

Definition at line 16 of file Global/GlobalSimulation/GlobalSimulation/GenericTOB.h.

{{.name="eta", .auxvar="eta", .description="Eta coordinate", .scale=0.0125}};

phi

const UnclampedBitField<23, 31, float> GlobalSim::v1::GenericTOB::phi {{.name="phi", .auxvar="phi", .description="Phi coordinate", .scale=M_PI / 256}}

inlinestatic

Definition at line 17 of file Global/GlobalSimulation/GlobalSimulation/GenericTOB.h.

{{.name="phi", .auxvar="phi", .description="Phi coordinate", .scale=M_PI / 256}};

width

std::size_t GlobalSim::BitSpec< GenericTOB, N, NoBase >::width

staticconstexprinherited

Definition at line 639 of file BitSpec.h.

---

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

• Global/GlobalSimulation/GlobalSimulation/GenericTOB.h