#include <BitSpec.h>

Collaboration diagram for GlobalSim::BitField< Lo, Hi, AuxValue, Value >:

Public Types
using	value_type = Value
using	bits_type = std::bitset<width>
using	encoder_type = bits_type (*)(Value)
using	decoder_type = Value (*)(bits_type)

Public Member Functions
constexpr	BitField (std::string_view name, std::string_view auxvar, std::string_view description, encoder_type encoder=nullptr, decoder_type decoder=nullptr)
constexpr std::string_view	name () const
constexpr std::string_view	description () const
Value	value (const SG::AuxElement &obj) const
Value	value (const SG::AuxElement &obj, bool truncate) const
AuxValue &	store (SG::AuxElement &obj, Value value) const
bits_type	encode (Value value) const
bits_type	bits (const SG::AuxElement &obj) const
Value	decode (bits_type bits) const
template<std::size_t N>
bits_type	extract (const std::bitset< N > &packed) const
template<std::size_t N>
Value	decodeFrom (const std::bitset< N > &packed) const
template<std::size_t N>
void	decodeAndAssignFrom (const std::bitset< N > &packed, SG::AuxElement &obj) const
template<std::size_t N>
void	pack (std::bitset< N > &result, const SG::AuxElement &obj) const

Public Attributes
AuxSpec	auxspec

Static Public Attributes
static constexpr unsigned	lo = Lo
static constexpr unsigned	hi = Hi
static constexpr unsigned	width = Hi - Lo + 1

Private Attributes
std::string_view	m_name
std::string_view	m_description
encoder_type	m_encoder
decoder_type	m_decoder
SG::ConstAccessor< AuxValue >	m_acc
SG::Accessor< AuxValue >	m_wacc

Detailed Description

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>
class GlobalSim::BitField< Lo, Hi, AuxValue, Value >

Definition at line 122 of file BitSpec.h.

Member Typedef Documentation

◆ bits_type

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

using GlobalSim::BitField< Lo, Hi, AuxValue, Value >::bits_type = std::bitset<width>

Definition at line 142 of file BitSpec.h.

◆ decoder_type

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

using GlobalSim::BitField< Lo, Hi, AuxValue, Value >::decoder_type = Value (*)(bits_type)

Definition at line 145 of file BitSpec.h.

◆ encoder_type

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

using GlobalSim::BitField< Lo, Hi, AuxValue, Value >::encoder_type = bits_type (*)(Value)

Definition at line 144 of file BitSpec.h.

◆ value_type

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

using GlobalSim::BitField< Lo, Hi, AuxValue, Value >::value_type = Value

Definition at line 141 of file BitSpec.h.

Constructor & Destructor Documentation

◆ BitField()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

GlobalSim::BitField< Lo, Hi, AuxValue, Value >::BitField	(	std::string_view	name,
		std::string_view	auxvar,
		std::string_view	description,
		encoder_type	encoder = nullptr,
		decoder_type	decoder = nullptr )

inlineconstexpr

Definition at line 147 of file BitSpec.h.

                : auxspec(AuxSpec::parse(auxvar)),
                  m_name(name),
                  m_description(description),
                  m_encoder(encoder),
                  m_decoder(decoder),
                  m_acc(std::string{auxspec.name}), m_wacc(std::string{auxspec.name}) {
 
        }

Member Function Documentation

◆ bits()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

bits_type GlobalSim::BitField< Lo, Hi, AuxValue, Value >::bits ( const SG::AuxElement & obj ) const

inline

Definition at line 233 of file BitSpec.h.

                                                      {
            return encode(value(obj));
        }

◆ decode()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

Value GlobalSim::BitField< Lo, Hi, AuxValue, Value >::decode ( bits_type bits ) const

inline

Definition at line 241 of file BitSpec.h.

                                           {
            if (m_decoder)
                return m_decoder(bits);
 
            return static_cast<Value>(bits.to_ullong());
        }

◆ decodeAndAssignFrom()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

template<std::size_t N>

void GlobalSim::BitField< Lo, Hi, AuxValue, Value >::decodeAndAssignFrom	(	const std::bitset< N > &	packed,
		SG::AuxElement &	obj ) const

inline

Definition at line 274 of file BitSpec.h.

                                                                                       {
            store( obj, decode(extract(packed)));
        }

◆ decodeFrom()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

template<std::size_t N>

Value GlobalSim::BitField< Lo, Hi, AuxValue, Value >::decodeFrom ( const std::bitset< N > & packed ) const

inline

Definition at line 269 of file BitSpec.h.

                                                            {
            return decode(extract(packed));
        }

◆ description()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

std::string_view GlobalSim::BitField< Lo, Hi, AuxValue, Value >::description ( ) const

inlineconstexpr

Definition at line 168 of file BitSpec.h.

168{ return m_description; }

◆ encode()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

bits_type GlobalSim::BitField< Lo, Hi, AuxValue, Value >::encode ( Value value ) const

inline

Definition at line 216 of file BitSpec.h.

                                            {
            if (m_encoder)
                return m_encoder(value);
 
            // Default behaviour: integral conversion.
 
            // should we check for out-of-range given size of bitset?
 
            return bits_type{
                    static_cast<unsigned long long>(value)
            };
        }

◆ extract()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

template<std::size_t N>

bits_type GlobalSim::BitField< Lo, Hi, AuxValue, Value >::extract ( const std::bitset< N > & packed ) const

inline

Definition at line 253 of file BitSpec.h.

                                                             {
            static_assert(Hi < N, "BitField extends beyond the specification width");
 
            bits_type result;
 
            for (unsigned i = 0; i < width; ++i)
                result[i] = packed[Lo + i];
 
            return result;
        }

◆ name()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

std::string_view GlobalSim::BitField< Lo, Hi, AuxValue, Value >::name ( ) const

inlineconstexpr

Definition at line 166 of file BitSpec.h.

166{ return m_name; }

◆ pack()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

template<std::size_t N>

void GlobalSim::BitField< Lo, Hi, AuxValue, Value >::pack	(	std::bitset< N > &	result,
		const SG::AuxElement &	obj ) const

inline

Definition at line 283 of file BitSpec.h.

                                               {
            static_assert(
                    Hi < N,
                    "BitField extends beyond the specification width");
 
            const bits_type field_bits = bits(obj);
 
            for (unsigned i = 0; i < width; ++i)
                result[Lo + i] = field_bits[i];
        }

◆ store()

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

AuxValue & GlobalSim::BitField< Lo, Hi, AuxValue, Value >::store	(	SG::AuxElement &	obj,
		Value	value ) const

inline

Definition at line 196 of file BitSpec.h.

                                                              {
            if constexpr (std::is_integral_v<AuxValue>)
            { // ensures have bitwise operators, has_mask is not constexpr so must hide this from invalid AuxValue types
                // leaving this commented as may revery to constexpr again at some point
                //            if constexpr (has_mask) {
                //                auto& val = m_wacc(obj);
                //                val = (val & ~Mask) | ((value << shift) & Mask);
                if (auxspec.has_mask) {
                    auto &val = m_wacc(obj);
                    return (val = (val & ~auxspec.mask) | ((value << auxspec.shift) & auxspec.mask));
                }
            }
            return (m_wacc(obj) = value);
 
        }

◆ value() [1/2]

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

Value GlobalSim::BitField< Lo, Hi, AuxValue, Value >::value ( const SG::AuxElement & obj ) const

inline

Definition at line 174 of file BitSpec.h.

                                                   {
 
            if constexpr (std::is_integral_v<AuxValue>)
            { // ensures have bitwise operators
 
                /*if constexpr(has_mask) {
                    return (m_acc(obj) & Mask) >> shift;*/
                if (auxspec.has_mask) {
                    return (m_acc(obj) & auxspec.mask) >> auxspec.shift;
                }
            }
 
            return m_acc(obj);
 
        }

◆ value() [2/2]

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

Value GlobalSim::BitField< Lo, Hi, AuxValue, Value >::value	(	const SG::AuxElement &	obj,
		bool	truncate ) const

inline

Definition at line 191 of file BitSpec.h.

                                                                  {
            if(!truncate) return value(obj);
            return decode(encode(value(obj)));
        }

Member Data Documentation

◆ auxspec

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

AuxSpec GlobalSim::BitField< Lo, Hi, AuxValue, Value >::auxspec

Definition at line 296 of file BitSpec.h.

◆ hi

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

unsigned GlobalSim::BitField< Lo, Hi, AuxValue, Value >::hi = Hi

staticconstexpr

Definition at line 129 of file BitSpec.h.

◆ lo

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

unsigned GlobalSim::BitField< Lo, Hi, AuxValue, Value >::lo = Lo

staticconstexpr

Definition at line 128 of file BitSpec.h.

◆ m_acc

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

SG::ConstAccessor<AuxValue> GlobalSim::BitField< Lo, Hi, AuxValue, Value >::m_acc

private

Definition at line 305 of file BitSpec.h.

◆ m_decoder

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

decoder_type GlobalSim::BitField< Lo, Hi, AuxValue, Value >::m_decoder

private

Definition at line 303 of file BitSpec.h.

◆ m_description

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

std::string_view GlobalSim::BitField< Lo, Hi, AuxValue, Value >::m_description

private

Definition at line 300 of file BitSpec.h.

◆ m_encoder

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

encoder_type GlobalSim::BitField< Lo, Hi, AuxValue, Value >::m_encoder

private

Definition at line 302 of file BitSpec.h.

◆ m_name

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

std::string_view GlobalSim::BitField< Lo, Hi, AuxValue, Value >::m_name

private

Definition at line 299 of file BitSpec.h.

◆ m_wacc

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

SG::Accessor<AuxValue> GlobalSim::BitField< Lo, Hi, AuxValue, Value >::m_wacc

private

Definition at line 306 of file BitSpec.h.

◆ width

template<unsigned Lo, unsigned Hi, typename AuxValue, typename Value = AuxValue>

unsigned GlobalSim::BitField< Lo, Hi, AuxValue, Value >::width = Hi - Lo + 1

staticconstexpr

Definition at line 130 of file BitSpec.h.

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

BitSpec.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ bits_type

◆ decoder_type

◆ encoder_type

◆ value_type

Constructor & Destructor Documentation

◆ BitField()

Member Function Documentation

◆ bits()

◆ decode()

◆ decodeAndAssignFrom()

◆ decodeFrom()

◆ description()

◆ encode()

◆ extract()

◆ name()

◆ pack()

◆ store()

◆ value() [1/2]

◆ value() [2/2]

Member Data Documentation

◆ auxspec

◆ hi

◆ lo

◆ m_acc

◆ m_decoder

◆ m_description

◆ m_encoder

◆ m_name

◆ m_wacc

◆ width