CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes
L1GctInternHtMiss Class Reference

L1 GCT internal Ht Miss component(s) Ht_x and/or Ht_y. More...

#include <L1GctInternHtMiss.h>

Public Types

enum  L1GctInternHtMissType {
  nulltype, miss_htx, miss_hty, miss_htx_and_hty,
  jf_miss_htx_and_hty
}
 Enum for the variants of Internal HtMiss. More...
 
enum  numberOfBits { kJetMissHtNBits = 12, kMissHxAndHyNBits = 14, kMissHxOrHyNBits = 16 }
 

Public Member Functions

int16_t bx () const
 Get BX number. More...
 
uint16_t capBlock () const
 Get capture block. More...
 
uint16_t capIndex () const
 Get index within capture block. More...
 
int16_t htx () const
 Get Ht x-component value. More...
 
int16_t hty () const
 Get Ht y-component. More...
 
bool isThereHtx () const
 Is there a valid Ht x-component stored? More...
 
bool isThereHty () const
 Is there a valid Ht y-component stored? More...
 
 L1GctInternHtMiss ()
 default constructor (for vector initialisation etc.) More...
 
bool operator!= (const L1GctInternHtMiss &rhs) const
 Inequality operator. More...
 
bool operator== (const L1GctInternHtMiss &rhs) const
 Equality operator. More...
 
bool overflow () const
 Get overflow. More...
 
uint32_t raw () const
 Get the raw data. More...
 
L1GctInternHtMiss::L1GctInternHtMissType type () const
 'type' of object? More...
 
 ~L1GctInternHtMiss ()
 destructor More...
 

Static Public Member Functions

static L1GctInternHtMiss emulatorJetMissHt (const int htx, const int hty, const bool overFlow, const int16_t bx)
 Named ctor for making missing Ht x & y components object from emulator (jetFinder output). More...
 
static L1GctInternHtMiss emulatorMissHtx (const int htx, const bool overFlow, const int16_t bx)
 Named ctor for making missing Ht x component object from emulator. More...
 
static L1GctInternHtMiss emulatorMissHtxHty (const int htx, const int hty, const bool overFlow, const int16_t bx)
 Named ctor for making missing Ht x & y components object from emulator (wheel input). More...
 
static L1GctInternHtMiss emulatorMissHty (const int hty, const bool overFlow, const int16_t bx)
 Named ctor for making missing Ht y component object from emulator. More...
 
static L1GctInternHtMiss unpackerMissHtx (const uint16_t capBlock, const uint16_t capIndex, const int16_t bx, const uint32_t data)
 Named ctor for making missing Ht x-component object from unpacker raw data. More...
 
static L1GctInternHtMiss unpackerMissHtxHty (const uint16_t capBlock, const uint16_t capIndex, const int16_t bx, const uint32_t data)
 Named ctor for making missing Ht x & y components object from unpacker raw data (wheel input). More...
 
static L1GctInternHtMiss unpackerMissHty (const uint16_t capBlock, const uint16_t capIndex, const int16_t bx, const uint32_t data)
 Named ctor for making missing Ht y-component object from unpacker raw data. More...
 

Private Types

enum  ShiftsAndMasks {
  kDoubleComponentHtyShift = 16, kSingleComponentOflowMask = (1 << 30), kDoubleComponentOflowMask = (1 << 15), kSingleComponentHtMask = 0xffff,
  kDoubleComponentHtMask = 0x3fff, kJetFinderComponentHtMask = 0x0fff, kSingleComponentRawMask = kSingleComponentOflowMask | kSingleComponentHtMask, kDoubleComponentRawMask
}
 Useful bit masks and bit shifts. More...
 

Private Member Functions

int16_t convert14BitTwosCompTo16Bit (const uint16_t data) const
 Converts 14-bit two's complement numbers to 16-bit two's complement (i.e. an int16_t) More...
 
 L1GctInternHtMiss (const L1GctInternHtMissType type, const uint16_t capBlock, const uint16_t capIndex, const int16_t bx, const uint32_t data)
 Private constructor that the named ctors use. More...
 

Private Attributes

int16_t bx_
 
uint16_t capBlock_
 
uint16_t capIndex_
 
uint32_t data_
 The captured raw data. More...
 
L1GctInternHtMissType type_
 'Type' of the data More...
 

Detailed Description

L1 GCT internal Ht Miss component(s) Ht_x and/or Ht_y.

Author
Robert Frazier
Date
March 2009

Definition at line 17 of file L1GctInternHtMiss.h.

Member Enumeration Documentation

Enum for the variants of Internal HtMiss.

Enumerator
nulltype 
miss_htx 
miss_hty 
miss_htx_and_hty 
jf_miss_htx_and_hty 

Definition at line 23 of file L1GctInternHtMiss.h.

Enumerator
kJetMissHtNBits 
kMissHxAndHyNBits 
kMissHxOrHyNBits 

Definition at line 29 of file L1GctInternHtMiss.h.

Useful bit masks and bit shifts.

Enumerator
kDoubleComponentHtyShift 
kSingleComponentOflowMask 
kDoubleComponentOflowMask 
kSingleComponentHtMask 
kDoubleComponentHtMask 
kJetFinderComponentHtMask 
kSingleComponentRawMask 
kDoubleComponentRawMask 

Definition at line 137 of file L1GctInternHtMiss.h.

Constructor & Destructor Documentation

L1GctInternHtMiss::L1GctInternHtMiss ( )

default constructor (for vector initialisation etc.)

Definition at line 7 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss::~L1GctInternHtMiss ( )

destructor

Definition at line 17 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss::L1GctInternHtMiss ( const L1GctInternHtMissType  type,
const uint16_t  capBlock,
const uint16_t  capIndex,
const int16_t  bx,
const uint32_t  data 
)
private

Private constructor that the named ctors use.

Definition at line 145 of file L1GctInternHtMiss.cc.

Member Function Documentation

int16_t L1GctInternHtMiss::bx ( ) const
inline

Get BX number.

Definition at line 101 of file L1GctInternHtMiss.h.

uint16_t L1GctInternHtMiss::capBlock ( ) const
inline

Get capture block.

Definition at line 95 of file L1GctInternHtMiss.h.

uint16_t L1GctInternHtMiss::capIndex ( ) const
inline

Get index within capture block.

Definition at line 98 of file L1GctInternHtMiss.h.

int16_t L1GctInternHtMiss::convert14BitTwosCompTo16Bit ( const uint16_t  data) const
private

Converts 14-bit two's complement numbers to 16-bit two's complement (i.e. an int16_t)

The input is the raw bits of the 14-bit two's complement in a 16-bit unsigned number.

Definition at line 158 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss L1GctInternHtMiss::emulatorJetMissHt ( const int  htx,
const int  hty,
const bool  overFlow,
const int16_t  bx 
)
static

Named ctor for making missing Ht x & y components object from emulator (jetFinder output).

Definition at line 47 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss L1GctInternHtMiss::emulatorMissHtx ( const int  htx,
const bool  overFlow,
const int16_t  bx 
)
static

Named ctor for making missing Ht x component object from emulator.

Definition at line 79 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss L1GctInternHtMiss::emulatorMissHtxHty ( const int  htx,
const int  hty,
const bool  overFlow,
const int16_t  bx 
)
static

Named ctor for making missing Ht x & y components object from emulator (wheel input).

Definition at line 63 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss L1GctInternHtMiss::emulatorMissHty ( const int  hty,
const bool  overFlow,
const int16_t  bx 
)
static

Named ctor for making missing Ht y component object from emulator.

Definition at line 93 of file L1GctInternHtMiss.cc.

int16_t L1GctInternHtMiss::htx ( ) const

Get Ht x-component value.

Definition at line 107 of file L1GctInternHtMiss.cc.

int16_t L1GctInternHtMiss::hty ( ) const

Get Ht y-component.

Definition at line 121 of file L1GctInternHtMiss.cc.

bool L1GctInternHtMiss::isThereHtx ( ) const
inline

Is there a valid Ht x-component stored?

Definition at line 104 of file L1GctInternHtMiss.h.

bool L1GctInternHtMiss::isThereHty ( ) const
inline

Is there a valid Ht y-component stored?

Definition at line 107 of file L1GctInternHtMiss.h.

bool L1GctInternHtMiss::operator!= ( const L1GctInternHtMiss rhs) const
inline

Inequality operator.

Definition at line 131 of file L1GctInternHtMiss.h.

bool L1GctInternHtMiss::operator== ( const L1GctInternHtMiss rhs) const
inline

Equality operator.

Definition at line 128 of file L1GctInternHtMiss.h.

bool L1GctInternHtMiss::overflow ( ) const

Get overflow.

Definition at line 135 of file L1GctInternHtMiss.cc.

uint32_t L1GctInternHtMiss::raw ( ) const
inline

Get the raw data.

Definition at line 113 of file L1GctInternHtMiss.h.

L1GctInternHtMiss::L1GctInternHtMissType L1GctInternHtMiss::type ( ) const
inline

'type' of object?

Definition at line 92 of file L1GctInternHtMiss.h.

L1GctInternHtMiss L1GctInternHtMiss::unpackerMissHtx ( const uint16_t  capBlock,
const uint16_t  capIndex,
const int16_t  bx,
const uint32_t  data 
)
static

Named ctor for making missing Ht x-component object from unpacker raw data.

Definition at line 20 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss L1GctInternHtMiss::unpackerMissHtxHty ( const uint16_t  capBlock,
const uint16_t  capIndex,
const int16_t  bx,
const uint32_t  data 
)
static

Named ctor for making missing Ht x & y components object from unpacker raw data (wheel input).

Definition at line 38 of file L1GctInternHtMiss.cc.

L1GctInternHtMiss L1GctInternHtMiss::unpackerMissHty ( const uint16_t  capBlock,
const uint16_t  capIndex,
const int16_t  bx,
const uint32_t  data 
)
static

Named ctor for making missing Ht y-component object from unpacker raw data.

Definition at line 29 of file L1GctInternHtMiss.cc.

Member Data Documentation

int16_t L1GctInternHtMiss::bx_
private

Definition at line 169 of file L1GctInternHtMiss.h.

uint16_t L1GctInternHtMiss::capBlock_
private

Definition at line 167 of file L1GctInternHtMiss.h.

uint16_t L1GctInternHtMiss::capIndex_
private

Definition at line 168 of file L1GctInternHtMiss.h.

uint32_t L1GctInternHtMiss::data_
private

The captured raw data.

Definition at line 172 of file L1GctInternHtMiss.h.

L1GctInternHtMissType L1GctInternHtMiss::type_
private

'Type' of the data

Definition at line 164 of file L1GctInternHtMiss.h.

Referenced by RandomRunSource.RandomRunSource::insertInto().