ATLAS Offline Software
Public Member Functions | Static Public Member Functions | List of all members
Trk::IDetailedMuonPatternTruthBuilder Class Referenceabstract

Provides interface for tool to return a "detailed" track truth map. More...

#include <IDetailedMuonPatternTruthBuilder.h>

Inheritance diagram for Trk::IDetailedMuonPatternTruthBuilder:
Collaboration diagram for Trk::IDetailedMuonPatternTruthBuilder:

Public Member Functions

virtual void buildDetailedMuonPatternTruth (DetailedMuonPatternTruthCollection *output, const MuonPatternCombinationCollection &tracks, const std::vector< const PRD_MultiTruthCollection * > &prdTruth)=0
 The main tool method. More...
 
virtual void buildDetailedTrackTruth (std::vector< DetailedTrackTruth > *output, const Muon::MuonPatternCombination &pattern, const std::vector< const PRD_MultiTruthCollection * > &prdTruth)=0
 
virtual void buildDetailedTrackTruthFromSegments (std::vector< DetailedSegmentTruth > *output, const Muon::MuonSegment &segment, const std::vector< const PRD_MultiTruthCollection * > &prdTruth)=0
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 

Detailed Description

Provides interface for tool to return a "detailed" track truth map.

Author
Andrei Gaponenko agapo.nosp@m.nenk.nosp@m.o@lbl.nosp@m..gov

Definition at line 31 of file IDetailedMuonPatternTruthBuilder.h.

Member Function Documentation

◆ buildDetailedMuonPatternTruth()

virtual void Trk::IDetailedMuonPatternTruthBuilder::buildDetailedMuonPatternTruth ( DetailedMuonPatternTruthCollection output,
const MuonPatternCombinationCollection tracks,
const std::vector< const PRD_MultiTruthCollection * > &  prdTruth 
)
pure virtual

The main tool method.

Fills a pre-existing DetailedTrackTruthCollection pointed to by output with data for the tracks, using the prdTruth collections. pdrTruth is allowed to contain null pointers. Each non-null pointer must correspond to collection for a single subdetector.

This method does not impose a memory management model on the caller. (As e.g. returning an object on the heap would do.) The caller can use it to work with stack or heap objects. Call with output==0 is a no-op. (But output should not be garbage, it must be initialized.)

Implemented in Trk::DetailedMuonPatternTruthBuilder.

◆ buildDetailedTrackTruth()

virtual void Trk::IDetailedMuonPatternTruthBuilder::buildDetailedTrackTruth ( std::vector< DetailedTrackTruth > *  output,
const Muon::MuonPatternCombination pattern,
const std::vector< const PRD_MultiTruthCollection * > &  prdTruth 
)
pure virtual

◆ buildDetailedTrackTruthFromSegments()

virtual void Trk::IDetailedMuonPatternTruthBuilder::buildDetailedTrackTruthFromSegments ( std::vector< DetailedSegmentTruth > *  output,
const Muon::MuonSegment segment,
const std::vector< const PRD_MultiTruthCollection * > &  prdTruth 
)
pure virtual

◆ interfaceID()

static const InterfaceID& Trk::IDetailedMuonPatternTruthBuilder::interfaceID ( )
inlinestatic

Definition at line 33 of file IDetailedMuonPatternTruthBuilder.h.

33 { return IID_IDetailedMuonPatternTruthBuilder; }

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