InDet::BeamSpotStatusCode Class Reference

Class to hold the definition and accessor methods for the beamspot status-word. More...

#include <BeamSpotStatusCode.h>

Collaboration diagram for InDet::BeamSpotStatusCode:

Public Member Functions
	BeamSpotStatusCode ()
	~BeamSpotStatusCode ()
bool	isOnline () const
void	setOnlineStatus (bool isOnline)
int	fitStatus () const
void	setFitStatus (int status)
int	algType () const
void	setAlgType (int type)
bool	fitWidth () const
void	setFitWidth (bool fitWidth)
void	clearWord ()
void	setWord (int word)
int	getWord () const

Static Public Member Functions
static bool	isOnline (int word)
static void	setOnlineStatus (bool isOnline, int &word)
static int	fitStatus (int word)
static void	setFitStatus (int status, int &word)
static int	algType (int word)
static void	setAlgType (int type, int &word)
static bool	fitWidth (int word)
static void	setFitWidth (bool fitWidth, int &word)

Private Member Functions
int	getItem (int bit, int length) const

Static Private Member Functions
static int	getItem (int word, int bit, int length)
static int	formBit (int bit, int word)
static void	setWordBit (int flag, int &word)

Private Attributes
int	m_word

Static Private Attributes
static const int	m_onlineBit = 2
static const int	m_onlineLength = 1
static const int	m_fitStatusBit = 0
static const int	m_fitStatusLength = 2
static const int	m_algorithmTypeBit = 4
static const int	m_algorithmTypeLength = 4
static const int	m_widthBit = 3
static const int	m_widthLength = 1

Detailed Description

Class to hold the definition and accessor methods for the beamspot status-word.

As well as position etc., meta-data is also required, i.e. beamspot fit result status, beamspot algorithm type, online/offline mode. This class defines the meaning of the word and supplies the necessary methods to access/set the information.

Definition at line 19 of file BeamSpotStatusCode.h.

Constructor & Destructor Documentation

BeamSpotStatusCode()

InDet::BeamSpotStatusCode::BeamSpotStatusCode ( )

inline

Definition at line 21 of file BeamSpotStatusCode.h.

                      :
    m_word(0)
    {}

~BeamSpotStatusCode()

InDet::BeamSpotStatusCode::~BeamSpotStatusCode ( )

inline

Definition at line 24 of file BeamSpotStatusCode.h.

{}    

Member Function Documentation

algType() [1/2]

int InDet::BeamSpotStatusCode::algType ( ) const

inline

Definition at line 43 of file BeamSpotStatusCode.h.

{ return algType(m_word);} 

algType() [2/2]

static int InDet::BeamSpotStatusCode::algType ( int  word )

inlinestatic

Definition at line 44 of file BeamSpotStatusCode.h.

{ return getItem(word, m_algorithmTypeBit, m_algorithmTypeLength);}

clearWord()

void InDet::BeamSpotStatusCode::clearWord ( )

inline

Definition at line 57 of file BeamSpotStatusCode.h.

{ m_word = 0;}

fitStatus() [1/2]

int InDet::BeamSpotStatusCode::fitStatus ( ) const

inline

Definition at line 36 of file BeamSpotStatusCode.h.

{return fitStatus(m_word);}

fitStatus() [2/2]

static int InDet::BeamSpotStatusCode::fitStatus ( int  word )

inlinestatic

Definition at line 37 of file BeamSpotStatusCode.h.

{ return getItem(word, m_fitStatusBit, m_fitStatusLength);}

fitWidth() [1/2]

bool InDet::BeamSpotStatusCode::fitWidth ( ) const

inline

Definition at line 50 of file BeamSpotStatusCode.h.

{return fitWidth(m_word);}

fitWidth() [2/2]

static bool InDet::BeamSpotStatusCode::fitWidth ( int  word )

inlinestatic

Definition at line 51 of file BeamSpotStatusCode.h.

{ return getItem(word, m_widthBit, m_widthLength);}

formBit()

static int InDet::BeamSpotStatusCode::formBit ( int  bit, int  word  )

inlinestaticprivate

Definition at line 71 of file BeamSpotStatusCode.h.

                                         {
    return (word << bit);
  }  

getItem() [1/2]

int InDet::BeamSpotStatusCode::getItem ( int  bit, int  length  ) const

inlineprivate

Definition at line 62 of file BeamSpotStatusCode.h.

{return getItem(m_word, bit,length);}

getItem() [2/2]

static int InDet::BeamSpotStatusCode::getItem ( int  word, int  bit, int  length  )

inlinestaticprivate

Definition at line 63 of file BeamSpotStatusCode.h.

                                                     {
    int temp = 0;
    for (int i =0; i < length; ++i) {
      temp = (temp << 1) + 1;
    }
    return (word >> bit) & temp;
  }

getWord()

int InDet::BeamSpotStatusCode::getWord ( ) const

inline

Definition at line 59 of file BeamSpotStatusCode.h.

{return m_word;} 

isOnline() [1/2]

bool InDet::BeamSpotStatusCode::isOnline ( ) const

inline

Definition at line 26 of file BeamSpotStatusCode.h.

{return isOnline(m_word);}

isOnline() [2/2]

static bool InDet::BeamSpotStatusCode::isOnline ( int  word )

inlinestatic

Definition at line 27 of file BeamSpotStatusCode.h.

                                { 
    int i = getItem(word, m_onlineBit, m_onlineLength);
    return ( i > 0 ? true : false );
  } 

setAlgType() [1/2]

void InDet::BeamSpotStatusCode::setAlgType ( int  type )

inline

Definition at line 45 of file BeamSpotStatusCode.h.

{setAlgType(type,m_word);}

setAlgType() [2/2]

static void InDet::BeamSpotStatusCode::setAlgType ( int  type, int &  word  )

inlinestatic

Definition at line 46 of file BeamSpotStatusCode.h.

                                               {
    setWordBit( formBit(m_algorithmTypeBit, type), word);}

setFitStatus() [1/2]

void InDet::BeamSpotStatusCode::setFitStatus ( int  status )

inline

Definition at line 38 of file BeamSpotStatusCode.h.

{setFitStatus(status, m_word);}

setFitStatus() [2/2]

static void InDet::BeamSpotStatusCode::setFitStatus ( int  status, int &  word  )

inlinestatic

Definition at line 39 of file BeamSpotStatusCode.h.

                                                   {
    setWordBit( formBit( m_fitStatusBit, status), word); } 

setFitWidth() [1/2]

void InDet::BeamSpotStatusCode::setFitWidth ( bool  fitWidth )

inline

Definition at line 52 of file BeamSpotStatusCode.h.

{setFitWidth(fitWidth,m_word);}

setFitWidth() [2/2]

static void InDet::BeamSpotStatusCode::setFitWidth ( bool  fitWidth, int &  word  )

inlinestatic

Definition at line 53 of file BeamSpotStatusCode.h.

                                                     {
    setWordBit( formBit( m_widthBit, (fitWidth?1:0)),word); }

setOnlineStatus() [1/2]

void InDet::BeamSpotStatusCode::setOnlineStatus ( bool  isOnline )

inline

Definition at line 31 of file BeamSpotStatusCode.h.

{setOnlineStatus(isOnline, m_word);}

setOnlineStatus() [2/2]

static void InDet::BeamSpotStatusCode::setOnlineStatus ( bool  isOnline, int &  word  )

inlinestatic

Definition at line 32 of file BeamSpotStatusCode.h.

                                                        { 
    setWordBit( formBit( m_onlineBit, (isOnline?1:0)), word);}

setWord()

void InDet::BeamSpotStatusCode::setWord ( int  word )

inline

Definition at line 58 of file BeamSpotStatusCode.h.

{ m_word = word;}

setWordBit()

static void InDet::BeamSpotStatusCode::setWordBit ( int  flag, int &  word  )

inlinestaticprivate

Definition at line 74 of file BeamSpotStatusCode.h.

                                               {
    word = (word | flag);
  }

Member Data Documentation

m_algorithmTypeBit

const int BeamSpotStatusCode::m_algorithmTypeBit = 4

staticprivate

Definition at line 80 of file BeamSpotStatusCode.h.

m_algorithmTypeLength

const int BeamSpotStatusCode::m_algorithmTypeLength = 4

staticprivate

Definition at line 80 of file BeamSpotStatusCode.h.

m_fitStatusBit

const int BeamSpotStatusCode::m_fitStatusBit = 0

staticprivate

Definition at line 79 of file BeamSpotStatusCode.h.

m_fitStatusLength

const int BeamSpotStatusCode::m_fitStatusLength = 2

staticprivate

Definition at line 79 of file BeamSpotStatusCode.h.

m_onlineBit

const int BeamSpotStatusCode::m_onlineBit = 2

staticprivate

Definition at line 78 of file BeamSpotStatusCode.h.

m_onlineLength

const int BeamSpotStatusCode::m_onlineLength = 1

staticprivate

Definition at line 78 of file BeamSpotStatusCode.h.

m_widthBit

const int BeamSpotStatusCode::m_widthBit = 3

staticprivate

Definition at line 81 of file BeamSpotStatusCode.h.

m_widthLength

const int BeamSpotStatusCode::m_widthLength = 1

staticprivate

Definition at line 81 of file BeamSpotStatusCode.h.

m_word

int InDet::BeamSpotStatusCode::m_word

private

Definition at line 83 of file BeamSpotStatusCode.h.

---

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

• BeamSpotStatusCode.h
• BeamSpotStatusCode.cxx