MuonVal::LinkerBranch Class Reference

The linker branch is a helper class to establish linking indices between dumped particle collections. More...

#include <LinkerBranch.h>

Inheritance diagram for MuonVal::LinkerBranch:

Collaboration diagram for MuonVal::LinkerBranch:

Public Types
using	ParticleBranch_ptr = std::shared_ptr<IParticleFourMomBranch>
	Abreviation of the pointer to the particle branch.
using	Linker_t = std::function<const xAOD::IParticle*(const xAOD::IParticle*)>
	Typedef of the linker function.
using	DataDependency

Public Member Functions
	LinkerBranch (IParticleFourMomBranch &parent, ParticleBranch_ptr linkColl, Linker_t linker, const std::string &altName="")
	Standard constructor fo the LinkerBranch.
void	push_back (const xAOD::IParticle *p) override
	Interface methods to handle the particle.
void	push_back (const xAOD::IParticle &p) override
void	operator+= (const xAOD::IParticle *p) override
void	operator+= (const xAOD::IParticle &p) override
bool &	get (size_t idx)
bool &	get (size_t)
bool	fill (const EventContext &ctx) override
	Clears vector in cases that it has not been updated in this event Retursn falls if the vector has not been initialized yet.
bool	init () override
	Initialized the Branch.
size_t	size () const
	Returns the number of actual saved elements.
void	push_back (const unsigned short &value)
	Adds a new element at the end of the vector.
void	operator+= (const unsigned short &value)
unsigned short &	operator[] (size_t idx)
	Accesses the idx-th element.
const unsigned short &	getDefault () const
void	setDefault (const unsigned short &def)
bool	isUpdated () const
bool	hasDefault () const
std::string	name () const override final
	Returns the name of the branch.
std::string	name () const override final
	Returns the name of the branch.
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.
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.
TTree *	tree () override final
	Returns the underlying TTree object.
const TTree *	tree () const override final
TTree *	tree () override final
	Returns the underlying TTree object.
const TTree *	tree () const override final
std::vector< DataDependency >	data_dependencies () override final
	Returns the data dependencies needed by the MuonTesterBranch.
std::vector< DataDependency >	data_dependencies () override final
	Returns the data dependencies needed by the MuonTesterBranch.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.
void	setLevel (MSG::Level lvl)
	Change the current logging level.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

Static Public Member Functions
static std::string	eraseWhiteSpaces (const std::string &In)
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.
bool	addToTree (unsigned short &variable)
	Connects the Memory buffer with the TTree.
template<class Key>
bool	declare_dependency (Key &key)
	Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm.
bool	declare_dependency (Key &key)
	Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm.
MuonTesterTree &	parent ()
	Returns the reference to the MuonTesterTree parent.
MuonTesterTree &	parent ()
	Returns the reference to the MuonTesterTree parent.

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

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

Detailed Description

The linker branch is a helper class to establish linking indices between dumped particle collections.

Once the primary particle is added to the collection, the linker branch calls the linker function to find the related particle and to add it into it's forseen collection. The position where the related particle is saved in the tree, is then saved by the linker branch

Definition at line 17 of file LinkerBranch.h.

Member Typedef Documentation

DataDependency

using MuonVal::IMuonTesterBranch::DataDependency

inherited

Definition at line 39 of file IMuonTesterBranch.h.

Linker_t

using MuonVal::LinkerBranch::Linker_t = std::function<const xAOD::IParticle*(const xAOD::IParticle*)>

Typedef of the linker function.

The function takes as argument the primary particle of interest and shall then return the particle to associate with

Definition at line 25 of file LinkerBranch.h.

ParticleBranch_ptr

using MuonVal::LinkerBranch::ParticleBranch_ptr = std::shared_ptr<IParticleFourMomBranch>

Abreviation of the pointer to the particle branch.

Definition at line 21 of file LinkerBranch.h.

Constructor & Destructor Documentation

LinkerBranch()

MuonVal::LinkerBranch::LinkerBranch	(	IParticleFourMomBranch &	parent,
		ParticleBranch_ptr	linkColl,
		Linker_t	linker,
		const std::string &	altName = "" )

Standard constructor fo the LinkerBranch.

Parameters

parent	Particle branch collection where the linker branch is appended to. The primary particle of interest is provided by this collection.
linkColl	Particle branch collection where the linked particle shall be appended
linker	Function to find the linked particle from the primary particle
altName	by default the name is <primaryColl>_linked<Secondary>. Parse an alternative name

Definition at line 7 of file LinkerBranch.cxx.

                                                        :
        VectorBranch<unsigned short>{parent.tree(), 
                                     std::format("{:}_{:}Link", parent.name(), altName.empty() ? linkColl->name() : altName)},
        m_linkColl{linkColl},
        m_linkerFunc{std::move(linker)} {}

Member Function Documentation

addToTree() [1/2]

template<class T>

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

protectedinherited

Connects the Memory buffer with the TTree.

addToTree() [2/2]

bool MuonVal::MuonTesterBranch::addToTree ( unsigned short & variable )

protectedinherited

Connects the Memory buffer with the TTree.

data_dependencies() [1/2]

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

finaloverridevirtualinherited

Returns the data dependencies needed by the MuonTesterBranch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 61 of file MuonTesterBranch.cxx.

{ return m_dependencies;}

data_dependencies() [2/2]

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

finaloverrideinherited

Returns the data dependencies needed by the MuonTesterBranch.

Definition at line 40 of file MuonTesterBranch.cxx.

{ return m_dependencies;}

declare_dependency() [1/2]

template<class Key>

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

protectedinherited

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

declare_dependency() [2/2]

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

protectedinherited

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

eraseWhiteSpaces() [1/2]

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

staticinherited

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;
}

eraseWhiteSpaces() [2/2]

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

staticinherited

Definition at line 42 of file MuonTesterBranch.cxx.

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

fill()

bool MuonVal::VectorBranch< unsigned short >::fill ( const EventContext & ctx )

overridevirtualinherited

Clears vector in cases that it has not been updated in this event Retursn falls if the vector has not been initialized yet.

Implements MuonVal::IMuonTesterBranch.

get() [1/2]

bool & MuonVal::VectorBranch< bool >::get ( size_t idx )

inherited

get() [2/2]

bool & MuonVal::VectorBranch< bool >::get ( size_t )

inherited

Definition at line 63 of file MuonTesterBranch.cxx.

                                                {
    THROW_EXCEPTION("For boolean branches the get() operator is cumbersome");
    return m_default;
}

getDefault()

const unsigned short & MuonVal::VectorBranch< unsigned short >::getDefault ( ) const

inlineinherited

hasDefault()

bool MuonVal::VectorBranch< unsigned short >::hasDefault ( ) const

inlineinherited

init()

bool MuonVal::VectorBranch< unsigned short >::init ( )

overridevirtualinherited

Initialized the Branch.

Implements MuonVal::IMuonTesterBranch.

initialized() [1/2]

bool MuonVal::MuonTesterBranch::initialized ( ) const

inherited

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; }

initialized() [2/2]

bool MuonVal::MuonTesterBranch::initialized ( ) const

inherited

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 35 of file MuonTesterBranch.cxx.

{ return m_init; }

initMessaging() [1/2]

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();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

initMessaging() [2/2]

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 121 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

isUpdated()

bool MuonVal::VectorBranch< unsigned short >::isUpdated ( ) const

inlineinherited

msg() [1/4]

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 163 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/4]

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 178 of file AthMessaging.h.

{ return msg() << lvl; }

msg() [3/4]

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 92 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() [4/4]

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 99 of file AthMessaging.h.

{ return msg() << lvl; }

msgLvl() [1/2]

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_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

msgLvl() [2/2]

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 86 of file AthMessaging.h.

{
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

name() [1/2]

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

finaloverridevirtualinherited

Returns the name of the branch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 51 of file MuonTesterBranch.cxx.

{ return m_name; }

name() [2/2]

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

finaloverrideinherited

Returns the name of the branch.

Definition at line 31 of file MuonTesterBranch.cxx.

{ return m_name; }

operator+=() [1/3]

void MuonVal::LinkerBranch::operator+= ( const xAOD::IParticle & p )

overridevirtual

Implements MuonVal::IParticleDecorationBranch.

Definition at line 19 of file LinkerBranch.cxx.

                                                        {
        push_back(p);
    }

operator+=() [2/3]

void MuonVal::LinkerBranch::operator+= ( const xAOD::IParticle * p )

overridevirtual

Implements MuonVal::IParticleDecorationBranch.

Definition at line 16 of file LinkerBranch.cxx.

                                                        {
        push_back(p);
    }

operator+=() [3/3]

void MuonVal::VectorBranch< unsigned short >::operator+= ( const unsigned short & value )

inlineinherited

operator[]()

unsigned short & MuonVal::VectorBranch< unsigned short >::operator[] ( size_t idx )

inlineinherited

Accesses the idx-th element.

If the index is larger than the size of the vector it is then enlarged with the default_value

parent() [1/2]

MuonTesterTree & MuonVal::MuonTesterBranch::parent ( )

protectedinherited

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;
}

parent() [2/2]

MuonTesterTree & MuonVal::MuonTesterBranch::parent ( )

protectedinherited

Returns the reference to the MuonTesterTree parent.

Definition at line 52 of file MuonTesterBranch.cxx.

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

push_back() [1/3]

void MuonVal::LinkerBranch::push_back ( const xAOD::IParticle & p )

overridevirtual

Implements MuonVal::IParticleDecorationBranch.

Definition at line 22 of file LinkerBranch.cxx.

                                                       {
        push_back(&p);
    }

push_back() [2/3]

void MuonVal::LinkerBranch::push_back ( const xAOD::IParticle * p )

overridevirtual

Interface methods to handle the particle.

Implements MuonVal::IParticleDecorationBranch.

Definition at line 25 of file LinkerBranch.cxx.

                                                       {
        const xAOD::IParticle* related = m_linkerFunc(p);
        ParticleBranch_ptr linkColl = m_linkColl.lock();
        linkColl->push_back(related);
        VectorBranch<unsigned short>::push_back(linkColl->find(related));
    }

push_back() [3/3]

void MuonVal::VectorBranch< unsigned short >::push_back ( const unsigned short & value )

inlineinherited

Adds a new element at the end of the vector.

setDefault()

void MuonVal::VectorBranch< unsigned short >::setDefault ( const unsigned short & def )

inherited

setLevel() [1/2]

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;
}

setLevel() [2/2]

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 108 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

size()

size_t MuonVal::VectorBranch< unsigned short >::size ( ) const

inlineinherited

Returns the number of actual saved elements.

tree() [1/4]

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

finaloverridevirtualinherited

Implements MuonVal::IMuonTesterBranch.

Definition at line 54 of file MuonTesterBranch.cxx.

{ return m_tree; }

tree() [2/4]

TTree * MuonVal::MuonTesterBranch::tree ( )

finaloverridevirtualinherited

Returns the underlying TTree object.

Implements MuonVal::IMuonTesterBranch.

Definition at line 53 of file MuonTesterBranch.cxx.

{ return m_tree; }

tree() [3/4]

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

finaloverrideinherited

Definition at line 38 of file MuonTesterBranch.cxx.

{ return m_tree; }

tree() [4/4]

TTree * MuonVal::MuonTesterBranch::tree ( )

finaloverrideinherited

Returns the underlying TTree object.

Definition at line 37 of file MuonTesterBranch.cxx.

{ return m_tree; }

Member Data Documentation

ATLAS_THREAD_SAFE [1/2]

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

ATLAS_THREAD_SAFE [2/2]

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_default

unsigned short MuonVal::VectorBranch< unsigned short >::m_default

privateinherited

Definition at line 55 of file VectorBranch.h.

{};

m_dependencies [1/2]

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

{};

m_dependencies [2/2]

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

{};

m_hasDefault

bool MuonVal::VectorBranch< unsigned short >::m_hasDefault

privateinherited

Definition at line 56 of file VectorBranch.h.

{false};

m_imsg [1/2]

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_imsg [2/2]

std::atomic<IMessageSvc*> AthMessaging::m_imsg

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_init [1/2]

bool MuonVal::MuonTesterBranch::m_init {false}

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

{false};

m_init [2/2]

bool MuonVal::MuonTesterBranch::m_init

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

{false};

m_linkColl

std::weak_ptr<IParticleFourMomBranch> MuonVal::LinkerBranch::m_linkColl

private

Definition at line 47 of file LinkerBranch.h.

m_linkerFunc

Linker_t MuonVal::LinkerBranch::m_linkerFunc

private

Definition at line 48 of file LinkerBranch.h.

m_lvl [1/2]

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_lvl [2/2]

std::atomic<MSG::Level> AthMessaging::m_lvl

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls [1/2]

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_msg_tls [2/2]

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 [1/2]

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

privateinherited

Definition at line 60 of file MuonTesterBranch.h.

{};

m_name [2/2]

std::string MuonVal::MuonTesterBranch::m_name

privateinherited

Definition at line 60 of file MuonTesterBranch.h.

{};

m_nm [1/2]

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_nm [2/2]

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

m_parent [1/2]

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

privateinherited

Definition at line 59 of file MuonTesterBranch.h.

{nullptr};

m_parent [2/2]

MuonTesterTree* MuonVal::MuonTesterBranch::m_parent

privateinherited

Definition at line 59 of file MuonTesterBranch.h.

{nullptr};

m_tree [1/2]

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

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

{nullptr};

m_tree [2/2]

TTree* MuonVal::MuonTesterBranch::m_tree

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

{nullptr};

m_updated

bool MuonVal::VectorBranch< unsigned short >::m_updated

privateinherited

Definition at line 57 of file VectorBranch.h.

{false};

m_variable

std::vector<unsigned short> MuonVal::VectorBranch< unsigned short >::m_variable

privateinherited

Definition at line 54 of file VectorBranch.h.

{};

---

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

• LinkerBranch.h
• LinkerBranch.cxx