DD4hep  1.28.0
Detector Description Toolkit for High Energy Physics
Public Member Functions | Private Attributes | List of all members
dd4hep::DDSegmentation::BitFieldValue Class Reference

Lightweight helper class for BitField64 that corresponds to one field value. More...

#include <BitField64.h>

Public Member Functions

 BitFieldValue ()=delete
 
 BitFieldValue (CellID &bitfield, const BitFieldElement &bv)
 only c'tor with reference to bitfield and BitFieldElement More...
 
FieldID value () const
 
FieldID value (CellID id) const
 Calculate Field value given an external 64 bit bitmap value. More...
 
BitFieldValueoperator= (FieldID in)
 
 operator FieldID () const
 
const std::string & name () const
 
unsigned offset () const
 
unsigned width () const
 
bool isSigned () const
 
CellID mask () const
 
int minValue () const
 
int maxValue () const
 

Private Attributes

CellID_value
 
const BitFieldElement_bv
 

Detailed Description

Lightweight helper class for BitField64 that corresponds to one field value.

(Not thread safe - only use directly through BitField64).

Author
F.Gaede, DESY
Date
2017-09

Definition at line 36 of file BitField64.h.

Constructor & Destructor Documentation

◆ BitFieldValue() [1/2]

dd4hep::DDSegmentation::BitFieldValue::BitFieldValue ( )
delete

◆ BitFieldValue() [2/2]

dd4hep::DDSegmentation::BitFieldValue::BitFieldValue ( CellID bitfield,
const BitFieldElement bv 
)
inline

only c'tor with reference to bitfield and BitFieldElement

Definition at line 46 of file BitField64.h.

Member Function Documentation

◆ isSigned()

bool dd4hep::DDSegmentation::BitFieldValue::isSigned ( ) const
inline

True if field is interpreted as signed

Definition at line 77 of file BitField64.h.

◆ mask()

CellID dd4hep::DDSegmentation::BitFieldValue::mask ( ) const
inline

The field's mask

Definition at line 80 of file BitField64.h.

◆ maxValue()

int dd4hep::DDSegmentation::BitFieldValue::maxValue ( ) const
inline

Maximal value

Definition at line 86 of file BitField64.h.

◆ minValue()

int dd4hep::DDSegmentation::BitFieldValue::minValue ( ) const
inline

Minimal value

Definition at line 83 of file BitField64.h.

◆ name()

const std::string& dd4hep::DDSegmentation::BitFieldValue::name ( ) const
inline

The field's name

Definition at line 68 of file BitField64.h.

◆ offset()

unsigned dd4hep::DDSegmentation::BitFieldValue::offset ( ) const
inline

The field's offset

Definition at line 71 of file BitField64.h.

◆ operator FieldID()

dd4hep::DDSegmentation::BitFieldValue::operator FieldID ( ) const
inline

Conversion operator for long64 - allows to write:
long64 index = myBitFieldValue ;

Definition at line 65 of file BitField64.h.

◆ operator=()

BitFieldValue& dd4hep::DDSegmentation::BitFieldValue::operator= ( FieldID  in)
inline

Definition at line 57 of file BitField64.h.

◆ value() [1/2]

FieldID dd4hep::DDSegmentation::BitFieldValue::value ( ) const
inline

Returns the current field value

Definition at line 51 of file BitField64.h.

◆ value() [2/2]

FieldID dd4hep::DDSegmentation::BitFieldValue::value ( CellID  id) const
inline

Calculate Field value given an external 64 bit bitmap value.

Definition at line 54 of file BitField64.h.

◆ width()

unsigned dd4hep::DDSegmentation::BitFieldValue::width ( ) const
inline

The field's width

Definition at line 74 of file BitField64.h.

Member Data Documentation

◆ _bv

const BitFieldElement& dd4hep::DDSegmentation::BitFieldValue::_bv
private

Definition at line 39 of file BitField64.h.

◆ _value

CellID& dd4hep::DDSegmentation::BitFieldValue::_value
private

Definition at line 38 of file BitField64.h.


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