SCT_ReadoutTool Class Reference

Example class to show calling the SCT_ReadoutTool. More...

#include <SCT_ReadoutTool.h>

Inheritance diagram for SCT_ReadoutTool:

Collaboration diagram for SCT_ReadoutTool:

Public Member Functions
	SCT_ReadoutTool (const std::string &type, const std::string &name, const IInterface *parent)
	Usual framework methods for an AlgTool.
virtual	~SCT_ReadoutTool ()=default
StatusCode	initialize () override
StatusCode	finalize () override
virtual StatusCode	determineReadout (const Identifier &moduleId, std::vector< SCT_Chip > &chips, bool link0ok, bool link1ok) const override
	Determine which chips are in the readout for a module of a particular type by Identifier.
virtual StatusCode	determineReadout (const int truncatedSerialNumber, std::vector< SCT_Chip > &chips, bool link0ok, bool link1ok) const override
	Determine which chips are in the readout for a module of a particular type by truncated serial number.

Private Attributes
const SCT_ID *	m_sctId
	Private data.
ToolHandle< ISCT_CablingTool >	m_cablingTool {this, "SCT_CablingTool", "SCT_CablingTool", "Tool to retrieve SCT Cabling"}

Detailed Description

Example class to show calling the SCT_ReadoutTool.

Class to represent the SCT module readout.

Definition at line 32 of file SCT_ReadoutTool.h.

Constructor & Destructor Documentation

SCT_ReadoutTool()

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

Usual framework methods for an AlgTool.

Definition at line 13 of file SCT_ReadoutTool.cxx.

                                                                                                      :
  base_class(type, name, parent),
  m_sctId{nullptr}
{
}

~SCT_ReadoutTool()

virtual SCT_ReadoutTool::~SCT_ReadoutTool ( )

virtualdefault

Member Function Documentation

determineReadout() [1/2]

StatusCode SCT_ReadoutTool::determineReadout ( const Identifier & moduleId, std::vector< SCT_Chip > & chips, bool link0ok, bool link1ok ) const

overridevirtual

Determine which chips are in the readout for a module of a particular type by Identifier.

Definition at line 50 of file SCT_ReadoutTool.cxx.

                                                                                                                                     {
  // This determineReadout(const Identifier is the main method of this class.
  // Methods of SCT_ReadoutData are called in the following order in this method:
  // setChips
  // setLinkStatus
  // setModuleType
  // setChipMap
  // clearChipReadout
  // checkLink
  // \_ followReadoutUpstream
  //    \_ setChipIn
  // \_ setChipOut
  // \_ hasConnectedInput
  //    \_ inputChip
  // maskChipsNotInReadout
  // \_ isChipReadOut
  // printStatus
  // \_ isLinkStandard
  //
  // The following two methods are not used.
  // isEndBeingTalkedTo
  // \_ outputChip
 
  // Determine which chips are in the module readout from Identifier
  ATH_MSG_DEBUG("Determining Readout for module ID = " << moduleId);
 
  // Make sure there are 12 chips
  if (chips.size()!=12) {
    ATH_MSG_DEBUG("Readout must contain exactly 12 chips");
    return StatusCode::SUCCESS;
  }
 
  SCT_ReadoutData data(msgSvc());
 
  // Set the chips and sort in order of ID
  data.setChips(chips);
 
  // Set link status
  data.setLinkStatus(link0ok, link1ok);
 
  // Determine module type (as per ModuleType enum) and set mapping
  data.setModuleType(moduleId, m_sctId->barrel_ec(moduleId));
  data.setChipMap();
 
  // Set all chips out of readout and clear both links to start
  data.clearChipReadout();
 
  // Check the links
  data.checkLink(0);
  data.checkLink(1);
 
  // Mask chips not in readout
  data.maskChipsNotInReadout();
 
  data.printStatus(moduleId);
 
  return StatusCode::SUCCESS;
}

determineReadout() [2/2]

StatusCode SCT_ReadoutTool::determineReadout ( const int truncatedSerialNumber, std::vector< SCT_Chip > & chips, bool link0ok, bool link1ok ) const

overridevirtual

Determine which chips are in the readout for a module of a particular type by truncated serial number.

Definition at line 38 of file SCT_ReadoutTool.cxx.

                                                                                                                                          {
  // Determine which chips are in the module readout from truncated serial number
  
  // Get moduleId
  const IdentifierHash& hash{m_cablingTool->getHashFromSerialNumber(truncatedSerialNumber)};
  if (not hash.is_valid()) return StatusCode::SUCCESS;
  Identifier moduleId{m_sctId->module_id(m_sctId->wafer_id(hash))};
 
  // Call identifier version
  return determineReadout(moduleId, chips, link0ok, link1ok);
}

finalize()

StatusCode SCT_ReadoutTool::finalize ( )

override

Definition at line 33 of file SCT_ReadoutTool.cxx.

                                     {
  ATH_MSG_DEBUG("Finalize SCT_ReadoutTool");
  return StatusCode::SUCCESS;
}

initialize()

StatusCode SCT_ReadoutTool::initialize ( )

override

Definition at line 20 of file SCT_ReadoutTool.cxx.

                                       {
  ATH_MSG_DEBUG("Initialize SCT_ReadoutTool");
  // Retrieve cabling
  if (not m_cablingTool.empty()) {
    ATH_CHECK(m_cablingTool.retrieve());
  }
  // Retrieve SCT helper
  ATH_CHECK(detStore()->retrieve(m_sctId, "SCT_ID"));
 
  return StatusCode::SUCCESS;
}

Member Data Documentation

m_cablingTool

ToolHandle<ISCT_CablingTool> SCT_ReadoutTool::m_cablingTool {this, "SCT_CablingTool", "SCT_CablingTool", "Tool to retrieve SCT Cabling"}

private

Definition at line 51 of file SCT_ReadoutTool.h.

{this, "SCT_CablingTool", "SCT_CablingTool", "Tool to retrieve SCT Cabling"};

m_sctId

const SCT_ID* SCT_ReadoutTool::m_sctId

private

Private data.

ID helper for SCT

Definition at line 50 of file SCT_ReadoutTool.h.

---

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

• SCT_ReadoutTool.h
• SCT_ReadoutTool.cxx