MuonVal::MuonTesterBranch Class Reference

#include <MuonTesterBranch.h>

Inherits AthMessaging, and MuonVal::IMuonTesterBranch.

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

Collaboration diagram for MuonVal::MuonTesterBranch:

Public Types
using	DataDependency = SG::VarHandleKey *

Public Member Functions
	MuonTesterBranch (MuonTesterTree &tree, const std::string &br_name)
	MuonTesterBranch (TTree *tree, const std::string &br_name)
	Standard constructor taking the TTree object and the name of the branch to be added to the TTree. More...
	MuonTesterBranch (const MuonTesterBranch &)=delete
void	operator= (const MuonTesterBranch &)=delete
virtual	~MuonTesterBranch ()
std::string	name () const override final
	Returns the name of the branch. More...
bool	initialized () const
	Returns whether the object has been initialized or not The outcome of the variable is bound to a successful call of the addToTree method. More...
TTree *	tree () override final
	Returns the underlying TTree object. More...
const TTree *	tree () const override final
std::vector< DataDependency >	data_dependencies () override final
	Returns the data dependencies needed by the MuonTesterBranch. More...
bool	msgLvl (const MSG::Level lvl) const
	Test the output level. More...
MsgStream &	msg () const
	The standard message stream. More...
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...
void	setLevel (MSG::Level lvl)
	Change the current logging level. More...
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...

Static Public Member Functions
static std::string	eraseWhiteSpaces (const std::string &In)

Protected Member Functions
template<class T >
bool	addToTree (T &variable)
	Connects the Memory buffer with the TTree. More...
template<class Key >
bool	declare_dependency (Key &key)
	Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm. More...
MuonTesterTree &	parent ()
	Returns the reference to the MuonTesterTree parent. More...

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc. More...

Private Attributes
TTree *	m_tree {nullptr}
MuonTesterTree *	m_parent {nullptr}
std::string	m_name {}
bool	m_init {false}
std::vector< DataDependency >	m_dependencies {}
std::string	m_nm
	Message source name. More...
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels) More...
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer. More...
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level. More...
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging) More...

Detailed Description

Definition at line 21 of file MuonTesterBranch.h.

Member Typedef Documentation

DataDependency

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

Constructor & Destructor Documentation

MuonTesterBranch() [1/3]

MuonVal::MuonTesterBranch::MuonTesterBranch	(	MuonTesterTree &	tree,
		const std::string &	br_name
	)

Definition at line 33 of file MuonTesterBranch.cxx.

                                                                                 : 
    MuonTesterBranch(tree.tree(), br_name) {
    m_parent = &tree;
    m_parent->addBranch(this);
}

MuonTesterBranch() [2/3]

MuonVal::MuonTesterBranch::MuonTesterBranch	(	TTree *	tree,
		const std::string &	br_name
	)

Standard constructor taking the TTree object and the name of the branch to be added to the TTree.

Definition at line 49 of file MuonTesterBranch.cxx.

                                                                        :
    AthMessaging{"MuonTesterBranch"}, m_tree(tree), m_name(br_name) {}

MuonTesterBranch() [3/3]

MuonVal::MuonTesterBranch::MuonTesterBranch ( const MuonTesterBranch &  )

delete

~MuonTesterBranch()

MuonVal::MuonTesterBranch::~MuonTesterBranch ( )

virtual

Definition at line 44 of file MuonTesterBranch.cxx.

                                    {
    if (m_parent) {
        m_parent->removeBranch(this);
    }
}

Member Function Documentation

addToTree()

template<class T >

bool MuonVal::MuonTesterBranch::addToTree ( T &  variable )

protected

Connects the Memory buffer with the TTree.

data_dependencies()

std::vector< MuonTesterBranch::DataDependency > MuonVal::MuonTesterBranch::data_dependencies ( )

finaloverridevirtual

Returns the data dependencies needed by the MuonTesterBranch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 61 of file MuonTesterBranch.cxx.

{ return m_dependencies;}

declare_dependency()

template<class Key >

bool MuonVal::MuonTesterBranch::declare_dependency ( Key &  key )

protected

Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm.

eraseWhiteSpaces()

std::string MuonVal::MuonTesterBranch::eraseWhiteSpaces ( const std::string &  In )

static

Definition at line 56 of file MuonTesterBranch.cxx.

                                                                {
    std::string out = In;
    out.erase(std::remove_if(out.begin(), out.end(), isspace), out.end());
    return out;
}

fill()

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

pure virtualinherited

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, MuonPRDTest::MMPRDVariables, MuonPRDTest::sTGCPRDVariables, MuonPRDTest::RpcSDOVariables, MuonValR4::SimHitTester, MuonPRDTest::CSCRDOVariables, 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::VectorBranch< T >, MuonVal::VectorBranch< int8_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< uint8_t >, MuonVal::VectorBranch< short >, MuonVal::VectorBranch< unsigned >, MuonVal::VectorBranch< uint16_t >, MuonVal::VectorBranch< bool >, MuonVal::VectorBranch< uint >, 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< int >, MuonVal::ScalarBranch< unsigned int >, MuonVal::ScalarBranch< uint8_t >, MuonVal::ScalarBranch< unsigned short >, MuonVal::ScalarBranch< short >, 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 >, and MuonVal::CoordTransformBranch.

init()

virtual bool MuonVal::IMuonTesterBranch::init ( )

pure virtualinherited

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::MuonIdentifierBranch, MuonValR4::TesterModuleBase, MuonVal::CoordTransformBranch, MuonPRDTest::PrdTesterModule, MuonVal::EventHashBranch, TestMuonSF::MuonReplicaBranches, MuonVal::VectorBranch< T >, MuonVal::VectorBranch< int8_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< uint8_t >, MuonVal::VectorBranch< short >, MuonVal::VectorBranch< unsigned >, MuonVal::VectorBranch< uint16_t >, MuonVal::VectorBranch< bool >, MuonVal::VectorBranch< uint >, 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< int >, MuonVal::ScalarBranch< unsigned int >, MuonVal::ScalarBranch< uint8_t >, MuonVal::ScalarBranch< unsigned short >, MuonVal::ScalarBranch< short >, MuonVal::ScalarBranch< bool >, MuonVal::ScalarBranch< uint >, and MuonVal::SetBranch< T >.

initialized()

bool MuonVal::MuonTesterBranch::initialized

(

)

const

Returns whether the object has been initialized or not The outcome of the variable is bound to a successful call of the addToTree method.

Definition at line 52 of file MuonTesterBranch.cxx.

{ return m_init; }

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  m_lvl = m_imsg ?
    static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
    MSG::INFO;
}

msg() [1/2]

MsgStream & AthMessaging::msg ( ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 164 of file AthMessaging.h.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level  lvl ) const

inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 179 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns

boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  if (!m_initialized.test_and_set()) initMessaging();
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

name()

std::string MuonVal::MuonTesterBranch::name ( ) const

finaloverridevirtual

Returns the name of the branch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 51 of file MuonTesterBranch.cxx.

{ return m_name; }

operator=()

void MuonVal::MuonTesterBranch::operator= ( const MuonTesterBranch &  )

delete

parent()

MuonTesterTree & MuonVal::MuonTesterBranch::parent ( )

protected

Returns the reference to the MuonTesterTree parent.

Definition at line 38 of file MuonTesterBranch.cxx.

                                         {
    if (!m_parent) {
        ATH_MSG_WARNING("The parent of  " << name() << " is null.");
    }
    return *m_parent;
}

setLevel()

void AthMessaging::setLevel ( MSG::Level  lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

tree() [1/2]

const TTree * MuonVal::MuonTesterBranch::tree ( ) const

finaloverridevirtual

Implements MuonVal::IMuonTesterBranch.

Definition at line 54 of file MuonTesterBranch.cxx.

{ return m_tree; }

tree() [2/2]

TTree * MuonVal::MuonTesterBranch::tree ( )

finaloverridevirtual

Returns the underlying TTree object.

Implements MuonVal::IMuonTesterBranch.

Definition at line 53 of file MuonTesterBranch.cxx.

{ return m_tree; }

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_dependencies

std::vector<DataDependency> MuonVal::MuonTesterBranch::m_dependencies {}

private

Definition at line 62 of file MuonTesterBranch.h.

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

m_init

bool MuonVal::MuonTesterBranch::m_init {false}

private

Definition at line 61 of file MuonTesterBranch.h.

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_name

std::string MuonVal::MuonTesterBranch::m_name {}

private

Definition at line 60 of file MuonTesterBranch.h.

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_parent

MuonTesterTree* MuonVal::MuonTesterBranch::m_parent {nullptr}

private

Definition at line 59 of file MuonTesterBranch.h.

m_tree

TTree* MuonVal::MuonTesterBranch::m_tree {nullptr}

private

Definition at line 58 of file MuonTesterBranch.h.

---

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

• MuonTesterBranch.h
• MuonTesterBranch.cxx