AFP_WordReadOut Class Reference

Class capable spliting word into parts, used to fill raw containers. More...

#include <AFP_WordReadOut.h>

Inheritance diagram for AFP_WordReadOut:

Collaboration diagram for AFP_WordReadOut:

Public Member Functions
	AFP_WordReadOut (const std::string &type, const std::string &name, const IInterface *parent)
virtual	~AFP_WordReadOut () override
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
bool	isHeader (uint32_t the_word) const override
	Returns true if the word is marked as header word.
bool	isData (uint32_t the_word) const override
	Returns true if the word is marked as data word.
bool	isService (uint32_t the_word) const override
	Returns true if the word is marked as service word.
uint32_t	link (uint32_t the_word) const override
	Value of 5-8 most significant bits.
uint32_t	getBits (uint32_t the_word, const uint16_t start, const uint16_t stop) const override
	Returns integer value of the selcted bits.

Static Public Attributes
static constexpr uint16_t	s_wordHeader = 3
	Header word is marked with four most significant bits set to 0011.
static constexpr uint16_t	s_wordData = 3
	Data word is marked with two most significant bits set to 11.
static constexpr uint16_t	s_wordService = 0
	Service word is marked with four most significant bits set to 0000.

Private Attributes
ToolHandle< AFP_LinkNumTranslator >	m_linkNumTrans {this, "AFP_LinkNumTranslator", "AFP_LinkNumTranslator", "Tool that translates link numbers"}

Detailed Description

Class capable spliting word into parts, used to fill raw containers.

Definition at line 16 of file AFP_WordReadOut.h.

Constructor & Destructor Documentation

AFP_WordReadOut()

AFP_WordReadOut::AFP_WordReadOut	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 7 of file AFP_WordReadOut.cxx.

                                                                                                       :
  base_class(type, name, parent)
{
}

~AFP_WordReadOut()

AFP_WordReadOut::~AFP_WordReadOut ( )

overridevirtual

Definition at line 12 of file AFP_WordReadOut.cxx.

{
}

Member Function Documentation

finalize()

StatusCode AFP_WordReadOut::finalize ( )

overridevirtual

Definition at line 27 of file AFP_WordReadOut.cxx.

{
  return StatusCode::SUCCESS;
}

getBits()

uint32_t AFP_WordReadOut::getBits ( uint32_t the_word, const uint16_t start, const uint16_t stop ) const

override

Returns integer value of the selcted bits.

Bits are numbered starting from 0 for the least significant bit and raising as bits significance rises.

Parameters

start	the most significant bit from which decoding should begin (the start bit will be included)
stop	the least significant bit where decoding should end (the stop bit will be included)

For example for word 0011 1010 the function will give following results:

• getBits (7, 4) = 3
• getBits (3, 0) = 10
• getBits (4, 4) = 1
• getBits (2, 2) = 0
• getBits (5, 3) = 7

Definition at line 32 of file AFP_WordReadOut.cxx.

{
  uint32_t word = 0;
  for (uint16_t i = stop; i < start; i++) {
    word = ((word | 1) << 1);
  }
  uint32_t result = (the_word >> stop) & (word | 1);
  return result;
}

initialize()

StatusCode AFP_WordReadOut::initialize ( )

overridevirtual

Definition at line 16 of file AFP_WordReadOut.cxx.

{
  if (m_linkNumTrans.retrieve().isFailure()) {
    ATH_MSG_WARNING("Failed to retrieve service " << m_linkNumTrans );
    return StatusCode::SUCCESS;
  } else {
    ATH_MSG_DEBUG("Retrieved service " << m_linkNumTrans );
  }
  return StatusCode::SUCCESS;
}

isData()

bool AFP_WordReadOut::isData ( uint32_t the_word ) const

inlineoverride

Returns true if the word is marked as data word.

The word is marked as data word if two most significant bits are equal s_wordData.

Definition at line 34 of file AFP_WordReadOut.h.

{return s_wordData == getBits(the_word, 31, 30);}

isHeader()

bool AFP_WordReadOut::isHeader ( uint32_t the_word ) const

inlineoverride

Returns true if the word is marked as header word.

The word is marked as header if four most significant bits are equal s_wordHeader.

Definition at line 28 of file AFP_WordReadOut.h.

{return s_wordHeader == getBits(the_word, 31, 28);}

isService()

bool AFP_WordReadOut::isService ( uint32_t the_word ) const

inlineoverride

Returns true if the word is marked as service word.

The word is marked as service word if four most significant bits are equal s_wordService.

Definition at line 40 of file AFP_WordReadOut.h.

{return s_wordService == getBits(the_word, 31, 28);}

link()

uint32_t AFP_WordReadOut::link ( uint32_t the_word ) const

inlineoverride

Value of 5-8 most significant bits.

In the following word: xxxx LLLL xxxx xxxx xxxx xxxx xxxx xxxx it means bits marked with L.

Definition at line 46 of file AFP_WordReadOut.h.

{return m_linkNumTrans->translate(getBits (the_word, 27, 24));}

Member Data Documentation

m_linkNumTrans

ToolHandle<AFP_LinkNumTranslator> AFP_WordReadOut::m_linkNumTrans {this, "AFP_LinkNumTranslator", "AFP_LinkNumTranslator", "Tool that translates link numbers"}

private

Definition at line 77 of file AFP_WordReadOut.h.

{this, "AFP_LinkNumTranslator", "AFP_LinkNumTranslator", "Tool that translates link numbers"};

s_wordData

uint16_t AFP_WordReadOut::s_wordData = 3

staticconstexpr

Data word is marked with two most significant bits set to 11.

Definition at line 71 of file AFP_WordReadOut.h.

s_wordHeader

uint16_t AFP_WordReadOut::s_wordHeader = 3

staticconstexpr

Header word is marked with four most significant bits set to 0011.

Definition at line 68 of file AFP_WordReadOut.h.

s_wordService

uint16_t AFP_WordReadOut::s_wordService = 0

staticconstexpr

Service word is marked with four most significant bits set to 0000.

Definition at line 74 of file AFP_WordReadOut.h.

---

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

• AFP_WordReadOut.h
• AFP_WordReadOut.cxx