CaloCellPackerUtils::Bitfield Class Reference

Helper for packing into/out of a bit field. More...

#include <CaloCellPackerUtils.h>

Inheritance diagram for CaloCellPackerUtils::Bitfield:

Collaboration diagram for CaloCellPackerUtils::Bitfield:

Public Member Functions
	Bitfield (unsigned int mask=1)
	Constructor.
unsigned int	in (unsigned int x) const
	Shift and mask a value into the bitfield.
unsigned int	out (unsigned int x) const
	Extract a value from the bitfield.

Protected Attributes
unsigned int	m_mask
	Bitmask. Lower bit should be 1.
unsigned int	m_shift
	Shift count.

Detailed Description

Helper for packing into/out of a bit field.

The bitfield is identified by a bitmask, which should contain a contiguous string of 1's. The in function will then take a value and shift and mask it appropriately for the bitfield. The out function will extract a value from the bitfield.

Definition at line 36 of file CaloCellPackerUtils.h.

Constructor & Destructor Documentation

Bitfield()

CaloCellPackerUtils::Bitfield::Bitfield

(

unsigned int

mask = 1

)

Constructor.

Parameters

The	bit mask. Should contain a single contiguous string of 1's.

Definition at line 25 of file CaloCellPackerUtils.cxx.

{
  // Shift the mask until the rightmost bit is non-zero.
  assert (mask != 0);
  m_shift = 0;
  while ((mask & 1) == 0) {
    mask >>= 1;
    ++m_shift;
  }
  m_mask = mask;
}

Member Function Documentation

in()

unsigned int CaloCellPackerUtils::Bitfield::in

(

unsigned int

x

)

const

Shift and mask a value into the bitfield.

Parameters

x	The input value.

Returns

The value shifted and masked to go into the bitfield.

out()

unsigned int CaloCellPackerUtils::Bitfield::out

(

unsigned int

x

)

const

Extract a value from the bitfield.

Parameters

x	The input bitfield.

Returns

The value extracted from the bitfield.

Member Data Documentation

m_mask

unsigned int CaloCellPackerUtils::Bitfield::m_mask

protected

Bitmask. Lower bit should be 1.

Definition at line 64 of file CaloCellPackerUtils.h.

m_shift

unsigned int CaloCellPackerUtils::Bitfield::m_shift

protected

Shift count.

Definition at line 67 of file CaloCellPackerUtils.h.

---

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

• CaloCellPackerUtils.h
• CaloCellPackerUtils.cxx