L1GctJetCount< nBits > Class Template Reference

Definition of unsigned integer types with increment and overflow. More...

#include <L1GctJetCount.h>

Inheritance diagram for L1GctJetCount< nBits >:

Public Member Functions
	L1GctJetCount ()
	Construct a counter and initialise its value to zero. More...
	L1GctJetCount (unsigned value)
	Construct a counter, checking for overFlow. More...
template<int mBits>
	L1GctJetCount (const L1GctJetCount< mBits > &rhs)
	Copy contructor to move data between representations with different numbers of bits. More...
L1GctJetCount	operator+ (const L1GctJetCount &rhs) const
	add two numbers More...
L1GctJetCount &	operator++ ()
	Define increment operators, since this is a counter. More...
L1GctJetCount	operator++ (int)
L1GctJetCount &	operator= (int value)
	overload = operator More...
void	setOverFlow (bool oflow)
	set the overflow bit More...
void	setValue (unsigned value)
	Set value from unsigned. More...
	~L1GctJetCount ()
	Destructor. More...
Public Member Functions inherited from L1GctUnsignedInt< nBits >
	L1GctUnsignedInt ()
	Construct an unsigned integer with initial value zero. More...
	L1GctUnsignedInt (unsigned value)
	Construct an unsigned integer and check for overFlow. More...
template<int mBits>
	L1GctUnsignedInt (const L1GctUnsignedInt< mBits > &rhs)
	Copy contructor to move data between representations with different numbers of bits. More...
L1GctUnsignedInt	operator+ (const L1GctUnsignedInt &rhs) const
	add two numbers More...
L1GctUnsignedInt &	operator= (int value)
	overload = operator More...
bool	overFlow () const
	access overflow More...
void	reset ()
	reset value and overflow to zero More...
void	setOverFlow (bool oflow)
	set the overflow bit More...
void	setValue (unsigned value)
	Set value from unsigned. More...
int	size () const
	return number of bits More...
unsigned	value () const
	access value as unsigned More...
	~L1GctUnsignedInt ()
	Destructor. More...

Additional Inherited Members
Protected Attributes inherited from L1GctUnsignedInt< nBits >
int	m_nBits
bool	m_overFlow
unsigned	m_value
Static Protected Attributes inherited from L1GctUnsignedInt< nBits >
static const int	MAX_NBITS = 24

Detailed Description

template<int nBits>
class L1GctJetCount< nBits >

Definition of unsigned integer types with increment and overflow.

This file defines the template class L1GctJetCount. It is used to store energy values that are represented in a given number of bits in hardware. The value is set to the maximum (all bits set to '1') to represent an overFlow condition, if the number to be represented is outside the allowed range for that number of bits. The counters are unsigned integers. Functions are defined to increment the counter, to add two values, and to copy data into a different number of bits.

this header file contains method definitions because these are template classes see http://www.parashift.com/c++-faq-lite/templates.html#faq-35.12

Author

Jim Brooke & Greg Heath

Date

May 2006

Definition at line 30 of file L1GctJetCount.h.

Constructor & Destructor Documentation

L1GctJetCount() [1/3]

template<int nBits>

L1GctJetCount< nBits >::L1GctJetCount

(

)

Construct a counter and initialise its value to zero.

Definition at line 61 of file L1GctJetCount.h.

: L1GctUnsignedInt<nBits>() {}

L1GctJetCount() [2/3]

template<int nBits>

L1GctJetCount< nBits >::L1GctJetCount

(

unsigned

value

)

Construct a counter, checking for overFlow.

Definition at line 64 of file L1GctJetCount.h.

: L1GctUnsignedInt<nBits>(value) {}

~L1GctJetCount()

template<int nBits>

L1GctJetCount< nBits >::~L1GctJetCount

(

)

Destructor.

Definition at line 67 of file L1GctJetCount.h.

{}

L1GctJetCount() [3/3]

template<int nBits>

template<int mBits>

L1GctJetCount< nBits >::L1GctJetCount

(

const L1GctJetCount< mBits > &

rhs

)

Copy contructor to move data between representations with different numbers of bits.

Definition at line 73 of file L1GctJetCount.h.

                                                                   {
  this->m_nBits = nBits > 0 && nBits < this->MAX_NBITS ? nBits : 16;
  this->setValue(rhs.value());
  this->setOverFlow(this->overFlow() || rhs.overFlow());
}

Member Function Documentation

operator+()

template<int nBits>

L1GctJetCount< nBits > L1GctJetCount< nBits >::operator+

(

const L1GctJetCount< nBits > &

rhs

)

const

add two numbers

Definition at line 115 of file L1GctJetCount.h.

                                                                                          {
  // temporary variable for storing the result (need to set its size)
  L1GctJetCount<nBits> temp;

  unsigned sum;
  bool ofl;

  // do the addition here
  sum = this->value() + rhs.value();
  ofl = this->overFlow() || rhs.overFlow();

  //fill the temporary argument
  temp.setValue(sum);
  temp.setOverFlow(temp.overFlow() || ofl);

  // return the temporary
  return temp;
}

operator++() [1/2]

template<int nBits>

L1GctJetCount< nBits > & L1GctJetCount< nBits >::operator++

(

void

)

Define increment operators, since this is a counter.

Definition at line 100 of file L1GctJetCount.h.

                                                       {
  this->setValue(this->m_value + 1);
  return *this;
}

operator++() [2/2]

template<int nBits>

L1GctJetCount< nBits > L1GctJetCount< nBits >::operator++

(

int

)

Definition at line 106 of file L1GctJetCount.h.

                                                         {
  L1GctJetCount<nBits> temp(this->m_value);
  temp.setOverFlow(this->m_overFlow);
  this->setValue(this->m_value + 1);
  return temp;
}

operator=()

template<int nBits>

L1GctJetCount< nBits > & L1GctJetCount< nBits >::operator=

(

int

value

)

overload = operator

Definition at line 136 of file L1GctJetCount.h.

                                                               {
  this->setValue(value);
  return *this;
}

setOverFlow()

template<int nBits>

void L1GctJetCount< nBits >::setOverFlow

(

bool

oflow

)

set the overflow bit

Definition at line 91 of file L1GctJetCount.h.

                                                 {
  this->m_overFlow = oflow;
  if (oflow) {
    this->m_value = ((1 << this->m_nBits) - 1);
  }
}

setValue()

template<int nBits>

void L1GctJetCount< nBits >::setValue

(

unsigned

value

)

Set value from unsigned.

Definition at line 80 of file L1GctJetCount.h.

                                                  {
  // check for overflow
  if (value >= (static_cast<unsigned>((1 << this->m_nBits) - 1))) {
    this->m_overFlow = true;
    this->m_value = ((1 << this->m_nBits) - 1);
  } else {
    this->m_value = value;
  }
}