Tool to visualise muon structure, authors and content in logfile or extra dump text file, combining code from Staco/Mutag and the muon builder. More...

#include <MuonPrintingTool.h>

Inheritance diagram for Rec::MuonPrintingTool:

Collaboration diagram for Rec::MuonPrintingTool:

Public Member Functions
	MuonPrintingTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor.
virtual	~MuonPrintingTool ()
	Standard destructor.
virtual StatusCode	initialize ()
	Overriding initialize and finalize.
virtual StatusCode	finalize ()
	end of the job - finalize
std::string	print (const xAOD::Muon &muon) const
	print muon object to a string
std::string	print (const xAOD::MuonContainer &muons) const
	print a muon container to a string
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
std::string	print (const xAOD::TrackParticle &tp) const
	print muon object to a string
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
PublicToolHandle< Muon::MuonEDMPrinterTool >	m_edmPrinter {this, "MuonStationPrinter",""}
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Tool to visualise muon structure, authors and content in logfile or extra dump text file, combining code from Staco/Mutag and the muon builder.

Author: Jean-Francois Laporte, Wolfgang Liebig, Niels van Eldik

Definition at line 34 of file MuonPrintingTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MuonPrintingTool()

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

Standard Constructor.

Rec::MuonPringingTool.h, (c) ATLAS Detector software /// /// This tool creates dump output of different detail to strings/// strings or files for an Analysis::Muon or a whole collection.

/// constructor

Definition at line 24 of file MuonPrintingTool.cxx.

                                                                                                            :
    AthAlgTool(type, name, parent) {
    declareInterface<IMuonPrintingTool>(this);
}

◆ ~MuonPrintingTool()

Rec::MuonPrintingTool::~MuonPrintingTool ( )

virtual

Standard destructor.

destructor

Definition at line 30 of file MuonPrintingTool.cxx.

30{}

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode Rec::MuonPrintingTool::finalize ( )

virtual

end of the job - finalize

Definition at line 42 of file MuonPrintingTool.cxx.

                                         {
    ATH_MSG_DEBUG("Nothing to finalize.");
    return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Rec::MuonPrintingTool::initialize ( )

virtual

Overriding initialize and finalize.

initialization

Definition at line 33 of file MuonPrintingTool.cxx.

                                           {
    ATH_CHECK(m_edmPrinter.retrieve());
    ATH_MSG_DEBUG("Retrieved " << m_edmPrinter);
 
    ATH_MSG_INFO("Initialize() successful in " << name());
    return StatusCode::SUCCESS;
}

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & Rec::IMuonPrintingTool::interfaceID ( )

inlinestaticinherited

Definition at line 25 of file IMuonPrintingTool.h.

25{ return IID_IMuonPrintingTool; };

Rec::IID_IMuonPrintingTool

static const InterfaceID IID_IMuonPrintingTool("Rec::IMuonPrintingTool", 1, 0)

Interface ID for Muon.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ print() [1/3]

std::string Rec::MuonPrintingTool::print ( const xAOD::Muon & muon ) const

virtual

print muon object to a string

Implements Rec::IMuonPrintingTool.

Definition at line 47 of file MuonPrintingTool.cxx.

                                                                      {
    std::ostringstream sout;
    sout << "  pt : " << tp.pt() << " eta : " << tp.eta() << " phi : " << tp.phi();
    return sout.str();
}

◆ print() [2/3]

std::string Rec::MuonPrintingTool::print ( const xAOD::MuonContainer & muons ) const

virtual

print a muon container to a string

Implements Rec::IMuonPrintingTool.

Definition at line 258 of file MuonPrintingTool.cxx.

                                                                         {
    std::ostringstream sout;
    sout << "Muon Container Size :" << muons.size() << std::endl;
 
    for (const auto *m : muons) { sout << print(*m); }
    return sout.str();
}

◆ print() [3/3]

std::string Rec::MuonPrintingTool::print ( const xAOD::TrackParticle & muon ) const

privatevirtual

print muon object to a string

Implements Rec::IMuonPrintingTool.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_edmPrinter

PublicToolHandle<Muon::MuonEDMPrinterTool> Rec::MuonPrintingTool::m_edmPrinter {this, "MuonStationPrinter",""}

private

Definition at line 55 of file MuonPrintingTool.h.

55{this, "MuonStationPrinter",""};

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MuonPrintingTool()

◆ ~MuonPrintingTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ print() [1/3]

◆ print() [2/3]

◆ print() [3/3]

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_edmPrinter

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka