#include <JetCMXTopoData.h>

Collaboration diagram for LVL1::JetCMXTopoData:

Public Member Functions
	JetCMXTopoData (int crate, bool overflow, const std::vector< uint32_t > &tobWords)
	Constructor with Crate number, overflow flag and vector of TOB words. More...

	JetCMXTopoData (int crate, bool overflow, const std::vector< JetTopoTOB > &tobs)
	Constructor with Crate number, overflow flag and TOB vector. More...

	JetCMXTopoData (int crate, const std::vector< uint32_t > &roiWords)
	For HLT: Constructor with Crate number and vector of RoI words. More...

	JetCMXTopoData (int crate)
	Constructor with Crate number only. More...

	JetCMXTopoData ()
	Default constructor. More...

	~JetCMXTopoData ()
	Destructor. More...

int	crate () const
	Return crate number (0-1) More...

bool	overflow () const
	Return overflow flag. More...

void	tobs (std::vector< JetTopoTOB > &tobs) const
	Return vector of TOBs. More...

const std::vector< uint32_t > &	tobWords () const
	Return vector of TOB words. More...

void	addTOB (const JetTopoTOB tob)
	Add TOB to record. More...

void	addTOB (uint32_t tobWord)
	Add another TOB word to the collection. More...

void	addRoI (uint32_t roiWord)
	Add TOB from RoI word. More...

void	setOverflow (bool overflow)
	Set overflow flag. More...

JetCMXTopoData &	checkJemOverflow ()
	count whether any transmission JEM -> CMX had too many TOBs More...

Private Attributes
int	m_crate
	Data members. More...

bool	m_overflow
	overflow on CMX -> L1Topo transmission More...

bool	m_jem_overflow
	overflow on JEM -> CMX transmission More...

std::vector< uint32_t >	m_tobWords

Static Private Attributes
static const unsigned int	s_maxTOBsPerLink = 32
	Static constants. More...

static const unsigned int	s_maxTOBsPerJem = 4
	as specified in BackplaneFormats_v3.xlsx More...

Detailed Description

Definition at line 22 of file JetCMXTopoData.h.

Constructor & Destructor Documentation

◆ JetCMXTopoData() [1/5]

LVL1::JetCMXTopoData::JetCMXTopoData	(	int	crate,
		bool	overflow,
		const std::vector< uint32_t > &	tobWords
	)

Constructor with Crate number, overflow flag and vector of TOB words.

Constructors.

Definition at line 16 of file JetCMXTopoData.cxx.

     : m_crate( crate ), m_overflow( overflow ),
       m_jem_overflow(false)
   {    
  
     m_tobWords.clear();
     for (std::vector<uint32_t>::const_iterator it = tobWords.begin(); it != tobWords.end(); ++it) {
       if (m_tobWords.size() < s_maxTOBsPerLink) m_tobWords.push_back( (*it) );
       else m_overflow = true;
     }
     checkJemOverflow();
   }

◆ JetCMXTopoData() [2/5]

LVL1::JetCMXTopoData::JetCMXTopoData	(	int	crate,
		bool	overflow,
		const std::vector< JetTopoTOB > &	tobs
	)

Constructor with Crate number, overflow flag and TOB vector.

Definition at line 30 of file JetCMXTopoData.cxx.

     : m_crate( crate ), m_overflow( overflow ),
       m_jem_overflow(false)
   {
     
     m_tobWords.clear();
     for (std::vector<JetTopoTOB>::const_iterator it = tobs.begin(); it != tobs.end(); ++it) {
       if (m_tobWords.size() < s_maxTOBsPerLink) m_tobWords.push_back( (*it).tobWord() );
       else m_overflow = true;
     }
     checkJemOverflow();
   }

◆ JetCMXTopoData() [3/5]

LVL1::JetCMXTopoData::JetCMXTopoData	(	int	crate,
		const std::vector< uint32_t > &	roiWords
	)

For HLT: Constructor with Crate number and vector of RoI words.

Definition at line 44 of file JetCMXTopoData.cxx.

     : m_crate( crate ),
       m_jem_overflow(false)
   {    
  
     m_overflow = false;
     m_tobWords.clear();
     
     for (std::vector<uint32_t>::const_iterator it = roiWords.begin(); it != roiWords.end(); ++it) {
       JetTopoTOB tob((*it));
       if (tob.crate() == m_crate) m_tobWords.push_back( tob.tobWord() );
     }
     checkJemOverflow();
   }

◆ JetCMXTopoData() [4/5]

LVL1::JetCMXTopoData::JetCMXTopoData ( int crate )

Constructor with Crate number only.

Definition at line 60 of file JetCMXTopoData.cxx.

     : m_crate( crate ), m_overflow( false ),
       m_jem_overflow(false)
   {
      m_tobWords.clear();
   }

◆ JetCMXTopoData() [5/5]

LVL1::JetCMXTopoData::JetCMXTopoData ( )

Default constructor.

Definition at line 68 of file JetCMXTopoData.cxx.

     : m_crate( 0 ), m_overflow ( false ),
       m_jem_overflow(false)
  {
      m_tobWords.clear();
   }

◆ ~JetCMXTopoData()

LVL1::JetCMXTopoData::~JetCMXTopoData ( )

Destructor.

Definition at line 77 of file JetCMXTopoData.cxx.

77 {

78 }

Member Function Documentation

◆ addRoI()

void LVL1::JetCMXTopoData::addRoI ( uint32_t roiWord )

Add TOB from RoI word.

Add another TOB word to the collection.

Note: overflows ignored in this method

Definition at line 96 of file JetCMXTopoData.cxx.

                                                 {
     JetTopoTOB tob(roiWord);
     if (tob.crate() == m_crate) m_tobWords.push_back( tob.tobWord() );
   }

◆ addTOB() [1/2]

void LVL1::JetCMXTopoData::addTOB ( const JetTopoTOB tob )

Add TOB to record.

Add another TOB to the collection.

Definition at line 82 of file JetCMXTopoData.cxx.

                                                     {
     if (m_tobWords.size() < s_maxTOBsPerLink)
       m_tobWords.push_back(tob.tobWord());
     else m_overflow = true;
   }

◆ addTOB() [2/2]

void LVL1::JetCMXTopoData::addTOB ( uint32_t tobWord )

Add another TOB word to the collection.

Definition at line 90 of file JetCMXTopoData.cxx.

                                                 {
     if (m_tobWords.size() < s_maxTOBsPerLink) m_tobWords.push_back( tobWord );
     else m_overflow = true;
   }

◆ checkJemOverflow()

JetCMXTopoData & LVL1::JetCMXTopoData::checkJemOverflow ( )

count whether any transmission JEM -> CMX had too many TOBs

In which case toggle m_jem_overflow

Definition at line 137 of file JetCMXTopoData.cxx.

 {
     const size_t max_jem_index = 15; // as indicated in JetTopoTOB::jem()
     std::vector<uint32_t> counters_tob_per_jem(max_jem_index, 0);
     for(const uint32_t word : m_tobWords) {
         JetTopoTOB tob(m_crate, word);
         const size_t iJem = tob.jem();
         counters_tob_per_jem[iJem] += 1;
     }
     m_jem_overflow = (m_jem_overflow ||
                       std::any_of(counters_tob_per_jem.begin(),
                                   counters_tob_per_jem.end(),
                                   [](const uint32_t &c) { return (c >= s_maxTOBsPerJem); }));
     return *this;
 }

◆ crate()

int LVL1::JetCMXTopoData::crate ( ) const

Return crate number (0-1)

Access methods.

Definition at line 109 of file JetCMXTopoData.cxx.

                                   {
     return m_crate;
   }

◆ overflow()

bool LVL1::JetCMXTopoData::overflow ( ) const

Return overflow flag.

Definition at line 114 of file JetCMXTopoData.cxx.

                                       {
     if ( m_overflow ||
          (m_tobWords.size() > s_maxTOBsPerLink) ||
         m_jem_overflow ) return true;
     return false;
   }

◆ setOverflow()

void LVL1::JetCMXTopoData::setOverflow ( bool overflow )

Set overflow flag.

Definition at line 103 of file JetCMXTopoData.cxx.

                                                   {
     m_overflow = overflow;
   }

◆ tobs()

void LVL1::JetCMXTopoData::tobs ( std::vector< JetTopoTOB > & tobs ) const

Return vector of TOBs.

Definition at line 127 of file JetCMXTopoData.cxx.

                                                                {
     tobs.clear();
     
     std::vector< uint32_t >::const_iterator it = m_tobWords.begin();
     for ( ; it != m_tobWords.end(); ++it) 
        tobs.push_back(JetTopoTOB(m_crate, (*it)));
     
     return;
   }

◆ tobWords()

const std::vector< uint32_t > & LVL1::JetCMXTopoData::tobWords ( ) const

Return vector of TOB words.

Definition at line 122 of file JetCMXTopoData.cxx.

                                                               {
     return m_tobWords;
   }

Member Data Documentation

◆ m_crate

int LVL1::JetCMXTopoData::m_crate

private

Data members.

Definition at line 64 of file JetCMXTopoData.h.

◆ m_jem_overflow

bool LVL1::JetCMXTopoData::m_jem_overflow

private

overflow on JEM -> CMX transmission

Definition at line 66 of file JetCMXTopoData.h.

◆ m_overflow

bool LVL1::JetCMXTopoData::m_overflow

private

overflow on CMX -> L1Topo transmission

Definition at line 65 of file JetCMXTopoData.h.

◆ m_tobWords

std::vector< uint32_t > LVL1::JetCMXTopoData::m_tobWords

private

Definition at line 67 of file JetCMXTopoData.h.

◆ s_maxTOBsPerJem

const unsigned int LVL1::JetCMXTopoData::s_maxTOBsPerJem = 4

staticprivate

as specified in BackplaneFormats_v3.xlsx

Definition at line 70 of file JetCMXTopoData.h.

◆ s_maxTOBsPerLink

const unsigned int LVL1::JetCMXTopoData::s_maxTOBsPerLink = 32

staticprivate

Static constants.

Definition at line 69 of file JetCMXTopoData.h.

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

Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JetCMXTopoData() [1/5]

◆ JetCMXTopoData() [2/5]

◆ JetCMXTopoData() [3/5]

◆ JetCMXTopoData() [4/5]

◆ JetCMXTopoData() [5/5]

◆ ~JetCMXTopoData()

Member Function Documentation

◆ addRoI()

◆ addTOB() [1/2]

◆ addTOB() [2/2]

◆ checkJemOverflow()

◆ crate()

◆ overflow()

◆ setOverflow()

◆ tobs()

◆ tobWords()

Member Data Documentation

◆ m_crate

◆ m_jem_overflow

◆ m_overflow

◆ m_tobWords

◆ s_maxTOBsPerJem

◆ s_maxTOBsPerLink