TCS::BaseTOB Class Reference

#include <BaseTOB.h>

Inherited by TCS::ClusterTOB, TCS::cTauTOB, TCS::eEmTOB, TCS::eTauTOB, TCS::GenericTOB, TCS::gJetTOB, TCS::gLJetTOB, TCS::gTETOB, TCS::gXETOB, TCS::jEmTOB, TCS::JetTOB, TCS::jJetTOB, TCS::jLJetTOB, TCS::jTauTOB, TCS::jTETOB, TCS::jXETOB, TCS::LateMuonTOB, TCS::MetTOB, TCS::MuonNextBCTOB, and TCS::MuonTOB.

Collaboration diagram for TCS::BaseTOB:

Public Member Functions
	BaseTOB (uint32_t roiWord, const std::string &tobType)
virtual	~BaseTOB ()
virtual void	print (std::ostream &) const =0
virtual inputTOBType_t	tobType () const =0
uint32_t	roiWord () const
const std::string &	tobName () const

Static Public Member Functions
static size_t	instances ()

Protected Member Functions
int	sizeCheck (int value, unsigned int size) const
int	sizeCheckM (int value, unsigned int size) const
unsigned int	sizeCheck (unsigned int value, unsigned int size) const

Private Attributes
uint32_t	m_roiWord
std::string	m_tobName

Detailed Description

Definition at line 12 of file BaseTOB.h.

Constructor & Destructor Documentation

BaseTOB()

TCS::BaseTOB::BaseTOB	(	uint32_t	roiWord,
		const std::string &	tobType
	)

Definition at line 11 of file BaseTOB.cxx.

                                                              :
  m_roiWord(roiWord),
  m_tobName(tobName)
{}

~BaseTOB()

TCS::BaseTOB::~BaseTOB ( )

virtualdefault

Member Function Documentation

instances()

static size_t TCS::BaseTOB::instances ( )

inlinestatic

Definition at line 25 of file BaseTOB.h.

{ return 0; }

print()

virtual void TCS::BaseTOB::print ( std::ostream &  ) const

pure virtual

Implemented in TCS::GenericTOB, TCS::JetTOB, TCS::MuonTOB, TCS::jEmTOB, TCS::gJetTOB, TCS::gLJetTOB, TCS::jTauTOB, TCS::LateMuonTOB, TCS::jJetTOB, TCS::jLJetTOB, TCS::cTauTOB, TCS::eEmTOB, TCS::eTauTOB, TCS::MuonNextBCTOB, TCS::ClusterTOB, TCS::MetTOB, TCS::gXETOB, TCS::jXETOB, TCS::jTETOB, TCS::CompositeTOB, and TCS::gTETOB.

roiWord()

uint32_t TCS::BaseTOB::roiWord ( ) const

inline

Definition at line 21 of file BaseTOB.h.

{ return m_roiWord; }

sizeCheck() [1/2]

int TCS::BaseTOB::sizeCheck ( int  value, unsigned int  size  ) const

protected

Definition at line 32 of file BaseTOB.cxx.

{
   int max(0x1 << (size-1));
   int min(~max + 1);
   --max;
   if(value>max || value<min) {
      TCS_EXCEPTION("Integer value " << value << " outside firmware specifications. Maximum number of bits is " << size << " -> range ["<<min<<" - "<<max<<"]" << ", for " << m_tobName);
   }
   return value;
}

sizeCheck() [2/2]

unsigned int TCS::BaseTOB::sizeCheck ( unsigned int  value, unsigned int  size  ) const

protected

Definition at line 44 of file BaseTOB.cxx.

{
   unsigned int max( (0x1 << size)-1 );
   if(value>max) {
      TCS_EXCEPTION("Unsigned integer value " << value << " outside firmware specifications. Maximum number of bits is " << size << " -> range [0"<<" - "<<max<<"]" << ", for " << m_tobName);
   }
   return value;
}

sizeCheckM()

int TCS::BaseTOB::sizeCheckM ( int  value, unsigned int  size  ) const

protected

Definition at line 19 of file BaseTOB.cxx.

{
   int max(0x1 << (size-1));
   int min(~max + 1);
   --max;
   if( (-value)>max || (-value)<min) {
     TCS_EXCEPTION("Integer value " << -value << " outside firmware specifications. Maximum number of bits is " << size << " -> range ["<<min<<" - "<<max<<"]" << ", for " << m_tobName);
   }
   return value;
}

tobName()

const std::string& TCS::BaseTOB::tobName ( ) const

inline

Definition at line 23 of file BaseTOB.h.

{ return m_tobName; }

tobType()

virtual inputTOBType_t TCS::BaseTOB::tobType ( ) const

pure virtual

Implemented in TCS::GenericTOB, TCS::MuonTOB, TCS::cTauTOB, TCS::LateMuonTOB, TCS::eEmTOB, TCS::JetTOB, TCS::eTauTOB, TCS::jEmTOB, TCS::ClusterTOB, TCS::gXETOB, TCS::jXETOB, TCS::gJetTOB, TCS::gLJetTOB, TCS::MuonNextBCTOB, TCS::jTauTOB, TCS::jTETOB, TCS::MetTOB, TCS::jJetTOB, TCS::jLJetTOB, and TCS::gTETOB.

Member Data Documentation

m_roiWord

uint32_t TCS::BaseTOB::m_roiWord

private

Definition at line 36 of file BaseTOB.h.

m_tobName

std::string TCS::BaseTOB::m_tobName

private

Definition at line 37 of file BaseTOB.h.

---

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

• BaseTOB.h
• BaseTOB.cxx