Tool to handle TP conversions for Tracking EDM. More...

#include <EventCnvSuperTool.h>

Inheritance diagram for Trk::EventCnvSuperTool:

Collaboration diagram for Trk::EventCnvSuperTool:

Public Member Functions
	EventCnvSuperTool (const std::string &t, const std::string &n, const IInterface *p)
virtual	~EventCnvSuperTool ()
virtual StatusCode	initialize () override
virtual StatusCode	finalize () override
virtual const Trk::ITrkEventCnvTool *	getCnvTool (const Identifier &id) const override
virtual const Trk::Surface *	getSurface (const Identifier &id) const override
	From passed Identifier.
virtual void	recreateRIO_OnTrack (RIO_OnTrack *RoT) const override
	Take the passed RoT and recreate it (i.e.
virtual void	prepareRIO_OnTrack (RIO_OnTrack *Rot) const override
	Take the passed RoT and prepare the PRD ElementLink for writing to disc.
virtual void	prepareRIO_OnTrackLink (const RIO_OnTrack *Rot, ELKey_t &key, ELIndex_t &index) const override
	Take the passed RoT and return the EL components to write to disc.
virtual bool	canHandleInDet () const override
virtual bool	canHandleMuonSpectrometer () const override
virtual int	maxNumberOfErrors () const override
virtual bool	noGeometry () const override
virtual bool	doTrackOverlay () const override

Private Attributes
ToolHandle< Trk::ITrkEventCnvTool >	m_idCnvTool {this, "IdCnvTool", "InDet::InDetEventCnvTool/InDetEventCnvTool", "Tool used to handle ID RoTs etc"}
	Tool used to handle ID RoTs etc.
ToolHandle< Trk::ITrkEventCnvTool >	m_muonCnvTool {this, "MuonCnvTool", "Muon::MuonEventCnvTool/MuonEventCnvTool", "Tool used to handle Muon RoTs etc"}
	Tool used to handle Muon RoTs etc.
const AtlasDetectorID *	m_detID
bool	m_haveIdCnvTool
	Flag set in intialise, letting us know whether the tool has been found.
bool	m_haveMuonCnvTool
	Flag set in intialise, letting us know whether the tool has been found.
bool	m_doMuons
	Property deciding whether to attempt Muon conversions.
bool	m_doID
	Property deciding whether to attempt ID conversions.
bool	m_doTrackOverlay
	Property for whether track overlay is being used, in which case different PRD containers are used by the converters.
std::atomic_int	m_errCount
	Current number of ERROR/WARNING messages sent to output.
int	m_maxErrCount
	Maximum number of permissable ERROR/WARNING messages sent to output.

Detailed Description

Tool to handle TP conversions for Tracking EDM.

This tool has sub tools that do the detector-specific conversions

Definition at line 26 of file EventCnvSuperTool.h.

Constructor & Destructor Documentation

◆ EventCnvSuperTool()

Trk::EventCnvSuperTool::EventCnvSuperTool	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p )

Definition at line 16 of file EventCnvSuperTool.cxx.

    : base_class(t, n, p),
      m_detID(nullptr),
      m_haveIdCnvTool(false),    // Will be set to true on retrieval
      m_haveMuonCnvTool(false),  // Will be set to true on retrieval
      m_doMuons(true),
      m_doID(true),
      m_doTrackOverlay(false),
      m_errCount(0),
      m_maxErrCount(10) {
  declareProperty("DoMuons", m_doMuons,
                  "If true (default), attempt to retrieve Muon helper tool and "
                  "convert Muon objects.");
  declareProperty("DoID", m_doID,
                  "If true (default), attempt to retrieve Inner Detector "
                  "helper tool and convert ID objects.");
  declareProperty("DoTrackOverlay", m_doTrackOverlay,
                  "If true, ID on-track conversion tools will look for "
                  "background PRD collections");
  declareProperty("MaxErrorCount", m_maxErrCount,
                  "Maximum number of errors that will be reported");
}

◆ ~EventCnvSuperTool()

Trk::EventCnvSuperTool::~EventCnvSuperTool ( )

virtual

Definition at line 41 of file EventCnvSuperTool.cxx.

                                         {
  if (m_errCount > m_maxErrCount)
    ATH_MSG_WARNING("Suppressed " << (m_errCount - m_maxErrCount)
                                  << " WARNING or ERROR messages");
}

Member Function Documentation

◆ canHandleInDet()

virtual bool Trk::EventCnvSuperTool::canHandleInDet ( ) const

inlineoverridevirtual

Definition at line 56 of file EventCnvSuperTool.h.

56{ return m_haveIdCnvTool;}

◆ canHandleMuonSpectrometer()

virtual bool Trk::EventCnvSuperTool::canHandleMuonSpectrometer ( ) const

inlineoverridevirtual

Definition at line 57 of file EventCnvSuperTool.h.

57{ return m_haveMuonCnvTool;}

◆ doTrackOverlay()

virtual bool Trk::EventCnvSuperTool::doTrackOverlay ( ) const

inlineoverridevirtual

Definition at line 62 of file EventCnvSuperTool.h.

62{return m_doTrackOverlay;}

◆ finalize()

StatusCode Trk::EventCnvSuperTool::finalize ( )

overridevirtual

Definition at line 102 of file EventCnvSuperTool.cxx.

                                          {
  msg() << "Finalize().";
  if (m_errCount > 0)
    msg() << " Tried to print " << m_errCount
          << " ERROR/WARNING messages (with maximum permissable = "
          << m_maxErrCount << ")";
  msg() << endmsg;
  return StatusCode::SUCCESS;
}

◆ getCnvTool()

const Trk::ITrkEventCnvTool * Trk::EventCnvSuperTool::getCnvTool ( const Identifier & id ) const

overridevirtual

Definition at line 112 of file EventCnvSuperTool.cxx.

                                {
  if (m_detID == nullptr)
    return nullptr;
 
  if (m_detID->is_indet(id)) {
    if (m_haveIdCnvTool) {
      return &(*m_idCnvTool);
    } else {
      if ((m_errCount++) < m_maxErrCount)
        ATH_MSG_WARNING("ID RIO_OnTrack, but have no ID cnv tool!");
      return nullptr;
    }
  } else {
    if (m_detID->is_muon(id)) {
      if (m_haveMuonCnvTool) {
        return &(*m_muonCnvTool);
      } else {
        if ((m_errCount++) < m_maxErrCount)
          ATH_MSG_WARNING(
              "Muon RIO_OnTrack, but have no muon cnv tool. Cannot set check "
              "RoT.");
        return nullptr;
      }
    }
  }
 
  if ((m_errCount++) < m_maxErrCount) {
    std::string ident = m_detID->show_to_string(id);
    ATH_MSG_WARNING("Unknown Identifier: (" << ident << "), that is (" << id
                                            << ")");
  }
  return nullptr;
}

◆ getSurface()

const Trk::Surface * Trk::EventCnvSuperTool::getSurface ( const Identifier & id ) const

overridevirtual

From passed Identifier.

Definition at line 147 of file EventCnvSuperTool.cxx.

                                {
  const Surface* surface = nullptr;
  const Trk::ITrkEventCnvTool* cnvTool = getCnvTool(id);
  if (cnvTool != nullptr) {
    const TrkDetElementBase* detEl = cnvTool->getDetectorElement(id);
    if (detEl != nullptr)
      surface = &(detEl->surface(id));
    else if ((m_errCount++) < m_maxErrCount)
      ATH_MSG_WARNING("getSurface: could not get detector element from id:"
                      << id << " Returning 0.");
  } else {
    if ((m_errCount++) < m_maxErrCount)
      ATH_MSG_WARNING(
          "getSurface: could not get cnv tool for Identifier:" << id);
  }
  return surface;
}

◆ initialize()

StatusCode Trk::EventCnvSuperTool::initialize ( )

overridevirtual

Definition at line 47 of file EventCnvSuperTool.cxx.

                                            {
  // Try to get AtlasID
  StatusCode sc = detStore()->retrieve(m_detID, "AtlasID");
  if (sc.isFailure()) {
    ATH_MSG_WARNING("Could not get AtlasDetectorID ");
  }
 
  if (!m_doID && !m_doMuons) {
    ATH_MSG_WARNING(
        "This tool has been configured without either Muons or ID, and so "
        "can't do anything. Problems likely.");
  }
 
  // Now try to get the tools
  if (m_doID && !m_idCnvTool.empty()) {
    if (m_idCnvTool.retrieve().isFailure()) {
      ATH_MSG_DEBUG(
          "Failed to retrieve InDet helper tool "
          << m_idCnvTool
          << ". Will not be able to recreate ID Surfaces / Det Elements.");
      m_doID = false;
    } else {
      ATH_MSG_VERBOSE("Retrieved tool " << m_idCnvTool);
      m_haveIdCnvTool = true;
    }
  } else {
    m_idCnvTool.setTypeAndName("");
  }
 
  if (m_doMuons && !m_muonCnvTool.empty()) {
    if (m_muonCnvTool.retrieve().isFailure()) {
      ATH_MSG_DEBUG(
          "Failed to retrieve Muon helper tool "
          << m_muonCnvTool
          << ". Will not be able to recreate ID Surfaces / Det Elements.");
      m_doMuons = false;
    } else {
      ATH_MSG_VERBOSE("Retrieved tool " << m_muonCnvTool);
      m_haveMuonCnvTool = true;
    }
  } else {
    m_muonCnvTool.setTypeAndName("");
  }
 
  // Print an extra warning if neither tool found.
  if (!m_haveIdCnvTool && !m_haveMuonCnvTool) {
    ATH_MSG_WARNING(
        "Failed to retrieve either and InDet or a Muon tool. Will not be able "
        "to recreate surfaces / detector elements.");
    m_maxErrCount = 0;  // No point in further WARNINGs
  }
 
  return StatusCode::SUCCESS;
}

◆ maxNumberOfErrors()

virtual int Trk::EventCnvSuperTool::maxNumberOfErrors ( ) const

inlineoverridevirtual

Definition at line 58 of file EventCnvSuperTool.h.

58{ return m_maxErrCount;}

◆ noGeometry()

virtual bool Trk::EventCnvSuperTool::noGeometry ( ) const

inlineoverridevirtual

Definition at line 60 of file EventCnvSuperTool.h.

60{return !(m_haveIdCnvTool&&m_haveMuonCnvTool);}

◆ prepareRIO_OnTrack()

void Trk::EventCnvSuperTool::prepareRIO_OnTrack ( Trk::RIO_OnTrack * RoT ) const

overridevirtual

Take the passed RoT and prepare the PRD ElementLink for writing to disc.

Definition at line 181 of file EventCnvSuperTool.cxx.

                                                                       {
  const Trk::ITrkEventCnvTool* cnvTool = getCnvTool(RoT->identify());
  if (cnvTool != nullptr) {
    cnvTool->prepareRIO_OnTrack(RoT);
  } else {
    if ((m_errCount++) < m_maxErrCount)
      msg() << "prepareRIO_OnTrack could not find appropriate tool to prepare: "
            << *RoT << std::endl;
  }
}

◆ prepareRIO_OnTrackLink()

void Trk::EventCnvSuperTool::prepareRIO_OnTrackLink	(	const RIO_OnTrack *	Rot,
		ELKey_t &	key,
		ELIndex_t &	index ) const

overridevirtual

Take the passed RoT and return the EL components to write to disc.

Definition at line 192 of file EventCnvSuperTool.cxx.

                                                                            {
  const Trk::ITrkEventCnvTool* cnvTool = getCnvTool(RoT->identify());
  if (cnvTool != nullptr) {
    cnvTool->prepareRIO_OnTrackLink(RoT, key, index);
  } else {
    if ((m_errCount++) < m_maxErrCount)
      msg() << "prepareRIO_OnTrack could not find appropriate tool to prepare: "
            << *RoT << std::endl;
  }
}

◆ recreateRIO_OnTrack()

void Trk::EventCnvSuperTool::recreateRIO_OnTrack ( Trk::RIO_OnTrack * RoT ) const

overridevirtual

Take the passed RoT and recreate it (i.e.

fill missing pointers etc)

Definition at line 166 of file EventCnvSuperTool.cxx.

                                                                        {
  using namespace std;
  const Trk::ITrkEventCnvTool* cnvTool = getCnvTool(RoT->identify());
  if (cnvTool != nullptr) {
    cnvTool->recreateRIO_OnTrack(RoT);
  } else {
    const type_info& info = typeid(*RoT);
    if ((m_errCount++) < m_maxErrCount)
      ATH_MSG_WARNING(
          "recreateRIO_OnTrack: could not get cnv tool. Returning without "
          "correctly filling ROT of type: "
          << info.name());
  }
}

Member Data Documentation

◆ m_detID

const AtlasDetectorID* Trk::EventCnvSuperTool::m_detID

private

Definition at line 67 of file EventCnvSuperTool.h.

◆ m_doID

bool Trk::EventCnvSuperTool::m_doID

private

Property deciding whether to attempt ID conversions.

Definition at line 73 of file EventCnvSuperTool.h.

◆ m_doMuons

bool Trk::EventCnvSuperTool::m_doMuons

private

Property deciding whether to attempt Muon conversions.

Definition at line 72 of file EventCnvSuperTool.h.

◆ m_doTrackOverlay

bool Trk::EventCnvSuperTool::m_doTrackOverlay

private

Property for whether track overlay is being used, in which case different PRD containers are used by the converters.

Definition at line 75 of file EventCnvSuperTool.h.

◆ m_errCount

std::atomic_int Trk::EventCnvSuperTool::m_errCount

mutableprivate

Current number of ERROR/WARNING messages sent to output.

Definition at line 77 of file EventCnvSuperTool.h.

◆ m_haveIdCnvTool

bool Trk::EventCnvSuperTool::m_haveIdCnvTool

private

Flag set in intialise, letting us know whether the tool has been found.

Definition at line 69 of file EventCnvSuperTool.h.

◆ m_haveMuonCnvTool

bool Trk::EventCnvSuperTool::m_haveMuonCnvTool

private

Flag set in intialise, letting us know whether the tool has been found.

Definition at line 70 of file EventCnvSuperTool.h.

◆ m_idCnvTool

ToolHandle<Trk::ITrkEventCnvTool> Trk::EventCnvSuperTool::m_idCnvTool {this, "IdCnvTool", "InDet::InDetEventCnvTool/InDetEventCnvTool", "Tool used to handle ID RoTs etc"}

private

Tool used to handle ID RoTs etc.

Definition at line 65 of file EventCnvSuperTool.h.

65{this, "IdCnvTool", "InDet::InDetEventCnvTool/InDetEventCnvTool", "Tool used to handle ID RoTs etc"};

◆ m_maxErrCount

int Trk::EventCnvSuperTool::m_maxErrCount

private

Maximum number of permissable ERROR/WARNING messages sent to output.

Definition at line 78 of file EventCnvSuperTool.h.

◆ m_muonCnvTool

ToolHandle<Trk::ITrkEventCnvTool> Trk::EventCnvSuperTool::m_muonCnvTool {this, "MuonCnvTool", "Muon::MuonEventCnvTool/MuonEventCnvTool", "Tool used to handle Muon RoTs etc"}

private

Tool used to handle Muon RoTs etc.

Definition at line 66 of file EventCnvSuperTool.h.

66{this, "MuonCnvTool", "Muon::MuonEventCnvTool/MuonEventCnvTool", "Tool used to handle Muon RoTs etc"};

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EventCnvSuperTool()

◆ ~EventCnvSuperTool()

Member Function Documentation

◆ canHandleInDet()

◆ canHandleMuonSpectrometer()

◆ doTrackOverlay()

◆ finalize()

◆ getCnvTool()

◆ getSurface()

◆ initialize()

◆ maxNumberOfErrors()

◆ noGeometry()

◆ prepareRIO_OnTrack()

◆ prepareRIO_OnTrackLink()

◆ recreateRIO_OnTrack()

Member Data Documentation

◆ m_detID

◆ m_doID

◆ m_doMuons

◆ m_doTrackOverlay

◆ m_errCount

◆ m_haveIdCnvTool

◆ m_haveMuonCnvTool

◆ m_idCnvTool

◆ m_maxErrCount

◆ m_muonCnvTool