GlobalSim::BitFieldAccessor< Field > Class Template Reference

#include <BitSpec.h>

Inheritance diagram for GlobalSim::BitFieldAccessor< Field >:

Collaboration diagram for GlobalSim::BitFieldAccessor< Field >:

Public Member Functions
	BitFieldAccessor (const Field &field, const SG::AuxElement &obj)
BitFieldAccessor &	operator() ()
auto	value (bool truncate=false) const
BitFieldAccessor &	operator= (const Field::value_type &value)
BitFieldAccessor &	operator= (const Field::bits_type &bits)
auto	bits () const
constexpr auto	spec () const
template<std::size_t N>
auto	extract (const std::bitset< N > &packed) const
template<std::size_t N>
auto	decodeFrom (const std::bitset< N > &packed) const

Private Attributes
const Field &	m_field
const SG::AuxElement &	m_obj

Detailed Description

template<typename Field>
class GlobalSim::BitFieldAccessor< Field >

Definition at line 311 of file BitSpec.h.

Constructor & Destructor Documentation

BitFieldAccessor()

template<typename Field>

GlobalSim::BitFieldAccessor< Field >::BitFieldAccessor ( const Field & field, const SG::AuxElement & obj )

inline

Definition at line 313 of file BitSpec.h.

                                                                      : Field(field), m_field(field), m_obj(obj) {
        }

Member Function Documentation

bits()

template<typename Field>

auto GlobalSim::BitFieldAccessor< Field >::bits ( ) const

inline

Definition at line 346 of file BitSpec.h.

                          {
            return m_field.bits(m_obj);
        }

decodeFrom()

template<typename Field>

template<std::size_t N>

auto GlobalSim::BitFieldAccessor< Field >::decodeFrom ( const std::bitset< N > & packed ) const

inline

Definition at line 370 of file BitSpec.h.

                                                           {
            return m_field.decodeFrom(packed);
        }

extract()

template<typename Field>

template<std::size_t N>

auto GlobalSim::BitFieldAccessor< Field >::extract ( const std::bitset< N > & packed ) const

inline

Definition at line 361 of file BitSpec.h.

                                                        {
            return m_field.extract(packed);
        }

operator()()

template<typename Field>

BitFieldAccessor & GlobalSim::BitFieldAccessor< Field >::operator() ( )

inline

Definition at line 317 of file BitSpec.h.

                                       {
            return *this;
        }

operator=() [1/2]

template<typename Field>

BitFieldAccessor & GlobalSim::BitFieldAccessor< Field >::operator= ( const Field::bits_type & bits )

inline

Definition at line 336 of file BitSpec.h.

                                                              {
            // Decode bits and set the value in m_obj
            // ...
            return operator=(m_field.decode(bits));
        }

operator=() [2/2]

template<typename Field>

BitFieldAccessor & GlobalSim::BitFieldAccessor< Field >::operator= ( const Field::value_type & value )

inline

Definition at line 331 of file BitSpec.h.

                                                                {
            m_field.store(const_cast<SG::AuxElement &>(m_obj),value);
            return *this;
        }

spec()

template<typename Field>

auto GlobalSim::BitFieldAccessor< Field >::spec ( ) const

inlineconstexpr

Definition at line 353 of file BitSpec.h.

{ return m_field; }

value()

template<typename Field>

auto GlobalSim::BitFieldAccessor< Field >::value ( bool truncate = false ) const

inline

Definition at line 325 of file BitSpec.h.

                                            {
            if(truncate) return m_field.value(m_obj,true);
            return m_field.value(m_obj);
        }

Member Data Documentation

m_field

template<typename Field>

const Field& GlobalSim::BitFieldAccessor< Field >::m_field

private

Definition at line 375 of file BitSpec.h.

m_obj

template<typename Field>

const SG::AuxElement& GlobalSim::BitFieldAccessor< Field >::m_obj

private

Definition at line 376 of file BitSpec.h.

---

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

• BitSpec.h