L1Topo::L1TopoTOB Class Reference

Represents the L1Topo TOB word of the L1Topo ROI data, with decode and encoder. More...

#include <L1TopoTOB.h>

Collaboration diagram for L1Topo::L1TopoTOB:

Public Member Functions
	L1TopoTOB (const uint32_t ctp_signal, uint32_t overflow_bits, uint32_t trigger_bits, uint32_t error_bits)
	Construct from contents and encode word. More...
	L1TopoTOB (const uint32_t ctp_signal, uint32_t overflow_bits, uint32_t trigger_bits)
	Construct from contents and encode word, without CRC error bits (they will be 0 by default) More...
	L1TopoTOB (const uint32_t word)
	Construct with word and decode contents. More...
uint32_t	ctp_signal () const
	access method for ctp signal bits More...
uint32_t	overflow_bits () const
	accessor method for overflow bits More...
uint32_t	trigger_bits () const
	accessor method for trigger bits More...
uint32_t	word () const
	accessor method for data word More...
uint32_t	index () const
	index bit, 0 or 1, part ofthe ctp_signal More...
uint32_t	clock () const
	clock cycle bit, 0 or 1, part ofthe ctp_signal More...
uint32_t	fpga () const
	fpga number bit , 0 or 1, part ofthe ctp_signal More...
uint32_t	error_bits () const
	access to five bits which flag CRC errors on the input links. They are available as individual flags below. More...
bool	crc_EM () const
	flag true if EM TOB input links have errors (bit 16) More...
bool	crc_Tau () const
	flag true if Tau TOB input links have errors (bit 17) More...
bool	crc_Muon () const
	flag true if Muon TOB input links have errors (bit 18) More...
bool	crc_Jet () const
	flag true if Jet TOB input links have errors (bit 19) More...
bool	crc_Energy () const
	flag true if Energy TOB input links have errors (bit 20) More...

Protected Member Functions
void	decode ()
	method used by constructor to decode word More...
void	encode ()
	method used by constructor to encode word More...

Private Attributes
uint32_t	m_ctp_signal
uint32_t	m_overflow_bits
uint32_t	m_trigger_bits
uint32_t	m_error_bits
uint32_t	m_word

Detailed Description

Represents the L1Topo TOB word of the L1Topo ROI data, with decode and encoder.

Used to decode/encode the 32-bit word that contains the trigger bits and overflow bits sent to the CTP by L1Topo.

Definition at line 17 of file L1TopoTOB.h.

Constructor & Destructor Documentation

L1TopoTOB() [1/3]

L1Topo::L1TopoTOB::L1TopoTOB	(	const uint32_t	ctp_signal,
		uint32_t	overflow_bits,
		uint32_t	trigger_bits,
		uint32_t	error_bits
	)

Construct from contents and encode word.

Definition at line 14 of file L1TopoTOB.cxx.

    : m_ctp_signal(ctp_signal), m_overflow_bits(overflow_bits), m_trigger_bits(trigger_bits),m_error_bits(error_bits),m_word(0){
    this->encode();
  }

L1TopoTOB() [2/3]

L1Topo::L1TopoTOB::L1TopoTOB	(	const uint32_t	ctp_signal,
		uint32_t	overflow_bits,
		uint32_t	trigger_bits
	)

Construct from contents and encode word, without CRC error bits (they will be 0 by default)

Definition at line 18 of file L1TopoTOB.cxx.

    : m_ctp_signal(ctp_signal), m_overflow_bits(overflow_bits), m_trigger_bits(trigger_bits),m_error_bits(0),m_word(0){
    this->encode();
  }

L1TopoTOB() [3/3]

L1Topo::L1TopoTOB::L1TopoTOB

(

const uint32_t

word

)

Construct with word and decode contents.

Definition at line 22 of file L1TopoTOB.cxx.

    : m_word(word){
    this->decode();
  }

Member Function Documentation

clock()

uint32_t L1Topo::L1TopoTOB::clock

(

)

const

clock cycle bit, 0 or 1, part ofthe ctp_signal

Definition at line 96 of file L1TopoTOB.cxx.

                                 {
    return (m_ctp_signal >> 1) & 0x1;
  }

crc_EM()

bool L1Topo::L1TopoTOB::crc_EM

(

)

const

flag true if EM TOB input links have errors (bit 16)

Definition at line 66 of file L1TopoTOB.cxx.

                              {
    return (m_error_bits & 0x01);
  }

crc_Energy()

bool L1Topo::L1TopoTOB::crc_Energy

(

)

const

flag true if Energy TOB input links have errors (bit 20)

Definition at line 78 of file L1TopoTOB.cxx.

                                  {
    return (m_error_bits & 0x10);
  }

crc_Jet()

bool L1Topo::L1TopoTOB::crc_Jet

(

)

const

flag true if Jet TOB input links have errors (bit 19)

Definition at line 75 of file L1TopoTOB.cxx.

                               {
    return (m_error_bits & 0x08);
  }

crc_Muon()

bool L1Topo::L1TopoTOB::crc_Muon

(

)

const

flag true if Muon TOB input links have errors (bit 18)

Definition at line 72 of file L1TopoTOB.cxx.

                                {
    return (m_error_bits & 0x04);
  }

crc_Tau()

bool L1Topo::L1TopoTOB::crc_Tau

(

)

const

flag true if Tau TOB input links have errors (bit 17)

Definition at line 69 of file L1TopoTOB.cxx.

                               {
    return (m_error_bits & 0x02);
  }

ctp_signal()

uint32_t L1Topo::L1TopoTOB::ctp_signal

(

)

const

access method for ctp signal bits

Definition at line 60 of file L1TopoTOB.cxx.

                                      {
    return m_ctp_signal;
  }

decode()

void L1Topo::L1TopoTOB::decode ( )

protected

method used by constructor to decode word

Definition at line 42 of file L1TopoTOB.cxx.

                        {
    // assert (L1Topo::blockType(m_word)==L1Topo::BlockTypes::L1TOPO_TOB);
    m_trigger_bits = m_word & 0xff;
    m_overflow_bits = (m_word>>8) & 0xff;
    m_error_bits = (m_word>>16) & 0x1f;
    m_ctp_signal = (m_word>>24) & 0xf;
    return;
  }

encode()

void L1Topo::L1TopoTOB::encode ( )

protected

method used by constructor to encode word

Definition at line 51 of file L1TopoTOB.cxx.

                        {
    m_word = static_cast<uint32_t>(L1Topo::BlockTypes::L1TOPO_TOB) << 28;
    m_word |= (m_trigger_bits & 0xff);
    m_word |= (m_overflow_bits & 0xff) << 8;
    m_word |= (m_error_bits & 0x1f) << 16;
    m_word |= (m_ctp_signal &= 0xf) << 24; 
    return;
  }

error_bits()

uint32_t L1Topo::L1TopoTOB::error_bits

(

)

const

access to five bits which flag CRC errors on the input links. They are available as individual flags below.

Definition at line 63 of file L1TopoTOB.cxx.

                                      {
    return m_error_bits;
  }

fpga()

uint32_t L1Topo::L1TopoTOB::fpga

(

)

const

fpga number bit , 0 or 1, part ofthe ctp_signal

Definition at line 99 of file L1TopoTOB.cxx.

                                {
    return (m_ctp_signal >> 3) & 0x1;
  }

index()

uint32_t L1Topo::L1TopoTOB::index

(

)

const

index bit, 0 or 1, part ofthe ctp_signal

Definition at line 93 of file L1TopoTOB.cxx.

                                 {
    return m_ctp_signal & 0x1;
  }

overflow_bits()

uint32_t L1Topo::L1TopoTOB::overflow_bits

(

)

const

accessor method for overflow bits

Definition at line 81 of file L1TopoTOB.cxx.

                                         {
    return m_overflow_bits;
  }

trigger_bits()

uint32_t L1Topo::L1TopoTOB::trigger_bits

(

)

const

accessor method for trigger bits

Definition at line 84 of file L1TopoTOB.cxx.

                                        {
    return m_trigger_bits;
  }

word()

uint32_t L1Topo::L1TopoTOB::word

(

)

const

accessor method for data word

Definition at line 87 of file L1TopoTOB.cxx.

                                {
    return m_word;
  }

Member Data Documentation

m_ctp_signal

uint32_t L1Topo::L1TopoTOB::m_ctp_signal

private

Definition at line 57 of file L1TopoTOB.h.

m_error_bits

uint32_t L1Topo::L1TopoTOB::m_error_bits

private

Definition at line 60 of file L1TopoTOB.h.

m_overflow_bits

uint32_t L1Topo::L1TopoTOB::m_overflow_bits

private

Definition at line 58 of file L1TopoTOB.h.

m_trigger_bits

uint32_t L1Topo::L1TopoTOB::m_trigger_bits

private

Definition at line 59 of file L1TopoTOB.h.

m_word

uint32_t L1Topo::L1TopoTOB::m_word

private

Definition at line 61 of file L1TopoTOB.h.

---

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

• L1TopoTOB.h
• L1TopoTOB.cxx