ATLAS Offline Software: MuonVal::IMuonTesterBranch Class Reference

ATLAS Offline Software

Most basic interface class used by the MuonTester tree. More...

#include <IMuonTesterBranch.h>

Inherited by MuonVal::ArrayBranch< ULong64_t > [virtual], MuonVal::ArrayBranch< unsigned > [virtual], MuonVal::ArrayBranch< T > [virtual], MuonVal::EventHashBranch, MuonVal::IAuxElementDecorationBranch [virtual], MuonVal::IParticleDecorationBranch [virtual], MuonVal::MuonTesterBranch [virtual], MuonVal::ScalarBranch< T > [virtual], MuonVal::SetBranch< T > [virtual], MuonVal::VectorBranch< T > [virtual], MuonVal::ScalarBranch< bool > [virtual], MuonVal::ScalarBranch< double > [virtual], MuonVal::ScalarBranch< float > [virtual], MuonVal::ScalarBranch< Identifier > [virtual], MuonVal::ScalarBranch< int > [virtual], MuonVal::ScalarBranch< short > [virtual], MuonVal::ScalarBranch< std::string > [virtual], MuonVal::ScalarBranch< uint > [virtual], MuonVal::ScalarBranch< uint16_t > [virtual], MuonVal::ScalarBranch< uint32_t > [virtual], MuonVal::ScalarBranch< uint8_t > [virtual], MuonVal::ScalarBranch< unsigned > [virtual], MuonVal::ScalarBranch< unsigned int > [virtual], MuonVal::ScalarBranch< unsigned long long > [virtual], MuonVal::ScalarBranch< unsigned short > [virtual], MuonVal::VectorBranch< bool > [virtual], MuonVal::VectorBranch< char > [virtual], MuonVal::VectorBranch< double > [virtual], MuonVal::VectorBranch< float > [virtual], MuonVal::VectorBranch< int > [virtual], MuonVal::VectorBranch< int16_t > [virtual], MuonVal::VectorBranch< int8_t > [virtual], MuonVal::VectorBranch< short > [virtual], MuonVal::VectorBranch< std::vector< int > > [virtual], MuonVal::VectorBranch< std::vector< int16_t > > [virtual], MuonVal::VectorBranch< std::vector< short > > [virtual], MuonVal::VectorBranch< std::vector< short int > > [virtual], MuonVal::VectorBranch< std::vector< short unsigned > > [virtual], MuonVal::VectorBranch< std::vector< T > > [virtual], MuonVal::VectorBranch< std::vector< uint16_t > > [virtual], MuonVal::VectorBranch< std::vector< unsigned > > [virtual], MuonVal::VectorBranch< uint > [virtual], MuonVal::VectorBranch< uint16_t > [virtual], MuonVal::VectorBranch< uint32_t > [virtual], MuonVal::VectorBranch< uint8_t > [virtual], MuonVal::VectorBranch< unsigned > [virtual], MuonVal::VectorBranch< unsigned char > [virtual], MuonVal::VectorBranch< unsigned int > [virtual], and MuonVal::VectorBranch< unsigned short > [virtual].

Collaboration diagram for MuonVal::IMuonTesterBranch:

Public Types
using	DataDependency = SG::VarHandleKey *

Public Member Functions
virtual	~IMuonTesterBranch ()=default

virtual bool	fill (const EventContext &ctx)=0
	The fill method checks if enough information is provided such that the branch is cleared from the information of the prevoius event and in cases of that updates did no happen befure a default value is provided. More...

virtual bool	init ()=0
	The init method checks whether the branch name has already registered to the MuonTree and tries then to add the branch to the tree --> return false if the branch has already been defined or the inclusion of the branch to the tree failed or the name of the branch is empty. More...

virtual std::string	name () const =0
	Returns the name of the branch. More...

virtual std::vector< DataDependency >	data_dependencies ()=0
	Returns a vector of all Event data dependencies needed by the Branch to work. More...

virtual TTree *	tree ()=0
	Returns the pointer to the underlying TTree object. More...

virtual const TTree *	tree () const =0

Detailed Description

Most basic interface class used by the MuonTester tree.

Definition at line 20 of file IMuonTesterBranch.h.

Member Typedef Documentation

◆ DataDependency

using MuonVal::IMuonTesterBranch::DataDependency = SG::VarHandleKey*

Definition at line 39 of file IMuonTesterBranch.h.

Constructor & Destructor Documentation

◆ ~IMuonTesterBranch()

virtual MuonVal::IMuonTesterBranch::~IMuonTesterBranch ( )

virtualdefault

Member Function Documentation

◆ data_dependencies()

virtual std::vector<DataDependency> MuonVal::IMuonTesterBranch::data_dependencies ( )

pure virtual

Returns a vector of all Event data dependencies needed by the Branch to work.

Implemented in MuonVal::MuonTesterBranch, MuonVal::EventHashBranch, and MuonVal::IParticleFourMomBranch.

◆ fill()

virtual bool MuonVal::IMuonTesterBranch::fill ( const EventContext & ctx )

pure virtual

The fill method checks if enough information is provided such that the branch is cleared from the information of the prevoius event and in cases of that updates did no happen befure a default value is provided.

--> returns false if no update is called or the dummy value has not been defined

Implemented in TestMuonSF::MuonSFBranches, TestMuonSF::TriggerSFBranches, CP::IsoCorrectionTestHelper, MuonVal::EventInfoBranch, MuonValR4::MmClusterVariables, MuonValR4::RpcMeasurementVariables, MuonValR4::TgcStripVariables, MuonValR4::MdtDriftCircleVariables, MuonValR4::MdtTwinDriftCircleVariables, MuonPRDTest::MMPRDVariables, MuonPRDTest::sTGCPRDVariables, MuonValR4::SpacePointTesterModule, MuonPRDTest::ParticleVariables, MuonPRDTest::RpcSDOVariables, MuonValR4::SimHitTester, MuonPRDTest::CSCRDOVariables, MuonPRDTest::SegmentVariables, MuonPRDTest::MMDigitVariables, MuonPRDTest::TGCPRDVariables, MuonPRDTest::TGCRDOVariables, MuonPRDTest::CSCPRDVariables, MuonPRDTest::MMRDOVariables, MuonPRDTest::MMSDOVariables, MuonPRDTest::MuEntryVariables, MuonPRDTest::RpcDigitVariables, MuonPRDTest::sTgcDigitVariables, MuonPRDTest::sTGCRDOVariables, MuonPRDTest::sTgcSDOVariables, MuonPRDTest::TgcDigitVariables, MuonVal::EventHashBranch, MuonPRDTest::CscDigitVariables, MuonPRDTest::CscSDOVariables, MuonPRDTest::MdtDigitVariables, MuonPRDTest::MdtSDOVariables, MuonPRDTest::MDTSimHitVariables, MuonPRDTest::MMSimHitVariables, MuonPRDTest::sTGCSimHitVariables, MuonPRDTest::TgcSDOVariables, MuonPRDTest::RPCSimHitVariables, MuonPRDTest::CSCSimHitVariables, MuonPRDTest::TGCSimHitVariables, MuonPRDTest::TruthVariables, TestMuonSF::MuonReplicaBranches, MuonVal::IParticleFourMomBranch, MuonVal::VectorBranch< T >, MuonVal::VectorBranch< int8_t >, MuonVal::VectorBranch< uint32_t >, MuonVal::VectorBranch< int16_t >, MuonVal::VectorBranch< std::vector< int > >, MuonVal::VectorBranch< double >, MuonVal::VectorBranch< float >, MuonVal::VectorBranch< int >, MuonVal::VectorBranch< unsigned int >, MuonVal::VectorBranch< std::vector< short unsigned > >, MuonVal::VectorBranch< std::vector< T > >, MuonVal::VectorBranch< std::vector< short int > >, MuonVal::VectorBranch< unsigned short >, MuonVal::VectorBranch< short >, MuonVal::VectorBranch< uint8_t >, MuonVal::VectorBranch< unsigned char >, MuonVal::VectorBranch< unsigned >, MuonVal::VectorBranch< uint16_t >, MuonVal::VectorBranch< char >, MuonVal::VectorBranch< bool >, MuonVal::VectorBranch< std::vector< unsigned > >, MuonVal::VectorBranch< uint >, MuonVal::VectorBranch< std::vector< int16_t > >, MuonVal::VectorBranch< std::vector< short > >, MuonVal::VectorBranch< std::vector< uint16_t > >, MuonVal::ScalarBranch< T >, MuonVal::ScalarBranch< uint32_t >, MuonVal::ScalarBranch< double >, MuonVal::ScalarBranch< unsigned long long >, MuonVal::ScalarBranch< std::string >, MuonVal::ScalarBranch< float >, MuonVal::ScalarBranch< Identifier >, MuonVal::ScalarBranch< int >, MuonVal::ScalarBranch< unsigned int >, MuonVal::ScalarBranch< uint8_t >, MuonVal::ScalarBranch< unsigned short >, MuonVal::ScalarBranch< short >, MuonVal::ScalarBranch< unsigned >, MuonVal::ScalarBranch< uint16_t >, MuonVal::ScalarBranch< bool >, MuonVal::ScalarBranch< uint >, MuonVal::SetBranch< T >, MuonVal::CartesFourVecBranch, MuonVal::ThreeVectorBranch, MuonVal::CoordSystemsBranch, MuonVal::PtEtaPhiEBranch, MuonVal::TwoVectorBranch, MuonVal::ArrayBranch< T >, MuonVal::MuonIdentifierBranch, MuonVal::ArrayBranch< ULong64_t >, MuonVal::ArrayBranch< unsigned >, and MuonVal::CoordTransformBranch.

◆ init()

virtual bool MuonVal::IMuonTesterBranch::init ( )

pure virtual

The init method checks whether the branch name has already registered to the MuonTree and tries then to add the branch to the tree --> return false if the branch has already been defined or the inclusion of the branch to the tree failed or the name of the branch is empty.

Implemented in TestMuonSF::MuonSFBranches, MuonVal::CartesFourVecBranch, MuonVal::ThreeVectorBranch, TestMuonSF::TriggerSFBranches, CP::IsoCorrectionTestHelper, MuonVal::CoordSystemsBranch, MuonVal::EventInfoBranch, MuonVal::PtEtaPhiEBranch, MuonVal::TwoVectorBranch, MuonVal::ArrayBranch< T >, MuonVal::ArrayBranch< ULong64_t >, MuonVal::ArrayBranch< unsigned >, MuonVal::MuonIdentifierBranch, MuonValR4::TesterModuleBase, MuonVal::CoordTransformBranch, MuonPRDTest::PrdTesterModule, MuonVal::EventHashBranch, TestMuonSF::MuonReplicaBranches, MuonVal::IParticleFourMomBranch, MuonVal::VectorBranch< T >, MuonVal::VectorBranch< int8_t >, MuonVal::VectorBranch< uint32_t >, MuonVal::VectorBranch< int16_t >, MuonVal::VectorBranch< std::vector< int > >, MuonVal::VectorBranch< double >, MuonVal::VectorBranch< float >, MuonVal::VectorBranch< int >, MuonVal::VectorBranch< unsigned int >, MuonVal::VectorBranch< std::vector< short unsigned > >, MuonVal::VectorBranch< std::vector< T > >, MuonVal::VectorBranch< std::vector< short int > >, MuonVal::VectorBranch< unsigned short >, MuonVal::VectorBranch< short >, MuonVal::VectorBranch< uint8_t >, MuonVal::VectorBranch< unsigned char >, MuonVal::VectorBranch< unsigned >, MuonVal::VectorBranch< uint16_t >, MuonVal::VectorBranch< char >, MuonVal::VectorBranch< bool >, MuonVal::VectorBranch< std::vector< unsigned > >, MuonVal::VectorBranch< uint >, MuonVal::VectorBranch< std::vector< int16_t > >, MuonVal::VectorBranch< std::vector< short > >, MuonVal::VectorBranch< std::vector< uint16_t > >, MuonVal::ScalarBranch< T >, MuonVal::ScalarBranch< uint32_t >, MuonVal::ScalarBranch< double >, MuonVal::ScalarBranch< unsigned long long >, MuonVal::ScalarBranch< std::string >, MuonVal::ScalarBranch< float >, MuonVal::ScalarBranch< Identifier >, MuonVal::ScalarBranch< int >, MuonVal::ScalarBranch< unsigned int >, MuonVal::ScalarBranch< uint8_t >, MuonVal::ScalarBranch< unsigned short >, MuonVal::ScalarBranch< short >, MuonVal::ScalarBranch< unsigned >, MuonVal::ScalarBranch< uint16_t >, MuonVal::ScalarBranch< bool >, MuonVal::ScalarBranch< uint >, and MuonVal::SetBranch< T >.

◆ name()

virtual std::string MuonVal::IMuonTesterBranch::name ( ) const

pure virtual

Returns the name of the branch.

Implemented in MuonVal::MuonTesterBranch, MuonVal::EventHashBranch, and MuonVal::IParticleFourMomBranch.

◆ tree() [1/2]

virtual const TTree* MuonVal::IMuonTesterBranch::tree ( ) const

pure virtual

Implemented in MuonVal::MuonTesterBranch, MuonVal::EventHashBranch, and MuonVal::IParticleFourMomBranch.

◆ tree() [2/2]

virtual TTree* MuonVal::IMuonTesterBranch::tree ( )

pure virtual

Returns the pointer to the underlying TTree object.

Implemented in MuonVal::MuonTesterBranch, MuonVal::EventHashBranch, and MuonVal::IParticleFourMomBranch.

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

IMuonTesterBranch.h