#include <GenericDecorBranch.h>

Inheritance diagram for MuonVal::GenericAuxEleBranch< AuxType, dType >:

Collaboration diagram for MuonVal::GenericAuxEleBranch< AuxType, dType >:

Public Types
using	Filler_t = std::function<dType(const AuxType& )>
	Defined the function signature to extract the information from the AuxElement.
using	DataDependency

Public Member Functions
	GenericAuxEleBranch (TTree *t, const std::string &branchName, Filler_t fillFunc)
	Constructor taking the raw pointer to the underlying TTree object.
	GenericAuxEleBranch (MuonTesterTree &t, const std::string &var_name, Filler_t fillFunc)
	Constructor taking the raw pointer to the underlying TTree object.
void	push_back (const SG::AuxElement *p) override
	Reads out a generic auxillary element and add its information to the output vector.
void	push_back (const SG::AuxElement &p) override
void	operator+= (const SG::AuxElement *p) override
void	operator+= (const SG::AuxElement &p) override
virtual	~GenericAuxEleBranch ()=default
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 dType &value)
	Adds a new element at the end of the vector.
void	operator+= (const dType &value)
dType &	operator[] (size_t idx)
	Accesses the idx-th element.
const dType &	getDefault () const
void	setDefault (const dType &def)
bool	isUpdated () const
bool	hasDefault () const
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.
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.
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.
void	setLevel (MSG::Level lvl)
	Change the current logging level.

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

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

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

Private Attributes
Filler_t	m_fillFunc
std::vector< dType >	m_variable
dType	m_default
bool	m_hasDefault
bool	m_updated
TTree *	m_tree
MuonTesterTree *	m_parent
std::string	m_name
bool	m_init
std::vector< DataDependency >	m_dependencies
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)
std::atomic< IMessageSvc * >	m_imsg
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE
	Messaging initialized (initMessaging)

Detailed Description

template<class AuxType, class dType>
class MuonVal::GenericAuxEleBranch< AuxType, dType >

Definition at line 11 of file GenericDecorBranch.h.

Member Typedef Documentation

◆ DataDependency

using MuonVal::IMuonTesterBranch::DataDependency

inherited

Definition at line 39 of file IMuonTesterBranch.h.

◆ Filler_t

template<class AuxType, class dType>

using MuonVal::GenericAuxEleBranch< AuxType, dType >::Filler_t = std::function<dType(const AuxType& )>

Defined the function signature to extract the information from the AuxElement.

Definition at line 15 of file GenericDecorBranch.h.

Constructor & Destructor Documentation

◆ GenericAuxEleBranch() [1/2]

template<class AuxType, class dType>

MuonVal::GenericAuxEleBranch< AuxType, dType >::GenericAuxEleBranch	(	TTree *	t,
		const std::string &	branchName,
		Filler_t	fillFunc )

Constructor taking the raw pointer to the underlying TTree object.

Parameters

t	Pointer to the TTree
branchName	Name of the output branch inside the TTree
fillFunc	Function to extract the information from the parsed object

◆ GenericAuxEleBranch() [2/2]

template<class AuxType, class dType>

MuonVal::GenericAuxEleBranch< AuxType, dType >::GenericAuxEleBranch	(	MuonTesterTree &	t,
		const std::string &	var_name,
		Filler_t	fillFunc )

Constructor taking the raw pointer to the underlying TTree object.

Parameters

t	Pointer to the TTree
branchName	Name of the output branch inside the TTree
fillFunc	Function to extract the information from the parsed object

◆ ~GenericAuxEleBranch()

template<class AuxType, class dType>

virtual MuonVal::GenericAuxEleBranch< AuxType, dType >::~GenericAuxEleBranch ( )

virtualdefault

Member Function Documentation

◆ addToTree()

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

protectedinherited

Connects the Memory buffer with the TTree.

◆ data_dependencies()

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.

61{ return m_dependencies;}

MuonVal::VectorBranch

Definition VectorBranch.h:14

◆ declare_dependency()

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

protectedinherited

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

◆ eraseWhiteSpaces()

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< dType >::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 dType & MuonVal::VectorBranch< dType >::getDefault ( ) const

inlineinherited

◆ hasDefault()

bool MuonVal::VectorBranch< dType >::hasDefault ( ) const

inlineinherited

◆ init()

bool MuonVal::VectorBranch< dType >::init ( )

overridevirtualinherited

Initialized the Branch.

Implements MuonVal::IMuonTesterBranch.

◆ initialized()

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.

52{ 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 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< dType >::isUpdated ( ) const

inlineinherited

◆ 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 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() [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 99 of file AthMessaging.h.

179{ return msg() << lvl; }

MuonVal::VectorBranch< dType >::msg

MsgStream & msg() const

Definition AthMessaging.h:163

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

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

◆ name()

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

finaloverrideinherited

Returns the name of the branch.

Definition at line 31 of file MuonTesterBranch.cxx.

51{ return m_name; }

◆ operator+=() [1/3]

template<class AuxType, class dType>

void MuonVal::GenericAuxEleBranch< AuxType, dType >::operator+= ( const SG::AuxElement & p )

overridevirtual

Implements MuonVal::IAuxElementDecorationBranch.

◆ operator+=() [2/3]

template<class AuxType, class dType>

void MuonVal::GenericAuxEleBranch< AuxType, dType >::operator+= ( const SG::AuxElement * p )

overridevirtual

Implements MuonVal::IAuxElementDecorationBranch.

◆ operator+=() [3/3]

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

inlineinherited

◆ operator[]()

dType & MuonVal::VectorBranch< dType >::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()

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]

template<class AuxType, class dType>

void MuonVal::GenericAuxEleBranch< AuxType, dType >::push_back ( const SG::AuxElement & p )

overridevirtual

Implements MuonVal::IAuxElementDecorationBranch.

◆ push_back() [2/3]

template<class AuxType, class dType>

void MuonVal::GenericAuxEleBranch< AuxType, dType >::push_back ( const SG::AuxElement * ele )

overridevirtual

Reads out a generic auxillary element and add its information to the output vector.

The interface takes internally care of deleting data from previous fill calls

Implements MuonVal::IAuxElementDecorationBranch.

◆ push_back() [3/3]

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

inlineinherited

Adds a new element at the end of the vector.

◆ setDefault()

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

inherited

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

{
  m_lvl = lvl;
}

◆ size()

size_t MuonVal::VectorBranch< dType >::size ( ) const

inlineinherited

Returns the number of actual saved elements.

◆ tree() [1/2]

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

finaloverrideinherited

Definition at line 38 of file MuonTesterBranch.cxx.

54{ return m_tree; }

◆ tree() [2/2]

TTree * MuonVal::MuonTesterBranch::tree ( )

finaloverrideinherited

Returns the underlying TTree object.

Definition at line 37 of file MuonTesterBranch.cxx.

53{ return m_tree; }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_default

dType MuonVal::VectorBranch< dType >::m_default

privateinherited

Definition at line 55 of file VectorBranch.h.

55{};

◆ m_dependencies

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

62{};

◆ m_fillFunc

template<class AuxType, class dType>

Filler_t MuonVal::GenericAuxEleBranch< AuxType, dType >::m_fillFunc

private

Definition at line 38 of file GenericDecorBranch.h.

◆ m_hasDefault

bool MuonVal::VectorBranch< dType >::m_hasDefault

privateinherited

Definition at line 56 of file VectorBranch.h.

56{false};

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_init

bool MuonVal::MuonTesterBranch::m_init

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

61{false};

◆ m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ 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

privateinherited

Definition at line 60 of file MuonTesterBranch.h.

60{};

◆ 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

privateinherited

Definition at line 59 of file MuonTesterBranch.h.

59{nullptr};

◆ m_tree

TTree* MuonVal::MuonTesterBranch::m_tree

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

58{nullptr};

◆ m_updated

bool MuonVal::VectorBranch< dType >::m_updated

privateinherited

Definition at line 57 of file VectorBranch.h.

57{false};

◆ m_variable

std::vector<dType> MuonVal::VectorBranch< dType >::m_variable

privateinherited

Definition at line 54 of file VectorBranch.h.

54{};

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

GenericDecorBranch.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataDependency

◆ Filler_t

Constructor & Destructor Documentation

◆ GenericAuxEleBranch() [1/2]

◆ GenericAuxEleBranch() [2/2]

◆ ~GenericAuxEleBranch()

Member Function Documentation

◆ addToTree()

◆ data_dependencies()

◆ declare_dependency()

◆ eraseWhiteSpaces()

◆ fill()

◆ get() [1/2]

◆ get() [2/2]

◆ getDefault()

◆ hasDefault()

◆ init()

◆ initialized()

◆ initMessaging()

◆ isUpdated()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator[]()

◆ parent()

◆ push_back() [1/3]

◆ push_back() [2/3]

◆ push_back() [3/3]

◆ setDefault()

◆ setLevel()

◆ size()

◆ tree() [1/2]

◆ tree() [2/2]

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_default

◆ m_dependencies

◆ m_fillFunc

◆ m_hasDefault

◆ m_imsg

◆ m_init

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_parent

◆ m_tree

◆ m_updated

◆ m_variable