Helper branch class to dump a pick a single hit summary value from the overall summary & to dump it in the tree. More...

#include <TrackSummaryModule.h>

Inheritance diagram for MuonValR4::TrackSummaryValueBranch:

Collaboration diagram for MuonValR4::TrackSummaryValueBranch:

Public Types
using	Category = MuonR4::HitSummary::HitCategory

using	Status = MuonR4::HitSummary::Status

using	LayerIndex = MuonR4::HitSummary::LayerIndex

using	DataDependency = SG::VarHandleKey *

using	DataDependency = SG::VarHandleKey *

Public Member Functions
	TrackSummaryValueBranch (TTree *tree, const std::string &collName, Category cat, Status status, LayerIndex layer, bool isSmall)
	Constructor taking the reference to the tree & the summary values together with an overall collection name. More...

void	push_back (const MuonR4::HitSummary &summary)
	push back the assigned hit summary value More...

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. More...

bool	init () override
	Initialized the Branch. More...

size_t	size () const
	Returns the number of actual saved elements. More...

void	push_back (const std::uint8_t &value)
	Adds a new element at the end of the vector. More...

void	operator+= (const std::uint8_t &value)

std::uint8_t &	operator[] (size_t idx)
	Accesses the idx-th element. More...

std::uint8_t &	get (size_t idx)

bool &	get (size_t idx)

bool &	get (size_t)

const std::uint8_t &	getDefault () const

void	setDefault (const std::uint8_t &def)

bool	isUpdated () const

bool	hasDefault () const

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...

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
Category	m_cat {Category::nCategories}

Status	m_status {Status::MaxValue}

LayerIndex	m_layer {LayerIndex::LayerIndexMax}

bool	m_isSmall {false}

std::vector< std::uint8_t >	m_variable

std::uint8_t	m_default

bool	m_hasDefault

bool	m_updated

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

Helper branch class to dump a pick a single hit summary value from the overall summary & to dump it in the tree.

Definition at line 16 of file TrackSummaryModule.h.

Member Typedef Documentation

◆ Category

using MuonValR4::TrackSummaryValueBranch::Category = MuonR4::HitSummary::HitCategory

Definition at line 18 of file TrackSummaryModule.h.

◆ DataDependency [1/2]

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

◆ DataDependency [2/2]

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

◆ LayerIndex

using MuonValR4::TrackSummaryValueBranch::LayerIndex = MuonR4::HitSummary::LayerIndex

Definition at line 20 of file TrackSummaryModule.h.

◆ Status

using MuonValR4::TrackSummaryValueBranch::Status = MuonR4::HitSummary::Status

Definition at line 19 of file TrackSummaryModule.h.

Constructor & Destructor Documentation

◆ TrackSummaryValueBranch()

MuonValR4::TrackSummaryValueBranch::TrackSummaryValueBranch	(	TTree *	tree,
		const std::string &	collName,
		Category	cat,
		Status	status,
		LayerIndex	layer,
		bool	isSmall
	)

Constructor taking the reference to the tree & the summary values together with an overall collection name.

Parameters

tree	TTree to which the branch is appended
collName	Name of the hit summary collection
cat	HitCategory of the summary to be picked by this instance
status	HitStatus of the summary to be picked by this instance
layer	Spectrometer lay to be picked by this instance
isSmall	Pick the summary from the large or the small chambers

Definition at line 25 of file TrackSummaryModule.cxx.

                                                                                     :
         VectorBranch<std::uint8_t>(tree,
                                    std::format("{:}_{:}",
                                         collName, nameBr(cat, status, layer, isSmall))),
         m_cat{cat}, m_status{status}, m_layer{layer}, m_isSmall{isSmall}{}

Member Function Documentation

◆ addToTree()

template<class T >

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

protectedinherited

Connects the Memory buffer with the TTree.

◆ data_dependencies()

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.

61 { return m_dependencies;}

◆ declare_dependency()

template<class Key >

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 56 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< std::uint8_t >::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/3]

std::uint8_t & MuonVal::VectorBranch< std::uint8_t >::get ( size_t idx )

inlineinherited

◆ get() [2/3]

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

inherited

◆ get() [3/3]

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 std::uint8_t & MuonVal::VectorBranch< std::uint8_t >::getDefault

inlineinherited

◆ hasDefault()

bool MuonVal::VectorBranch< std::uint8_t >::hasDefault

inlineinherited

◆ init()

bool MuonVal::VectorBranch< std::uint8_t >::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 52 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 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;
 }

◆ isUpdated()

bool MuonVal::VectorBranch< std::uint8_t >::isUpdated

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 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.

180 { 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

finaloverridevirtualinherited

Returns the name of the branch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 51 of file MuonTesterBranch.cxx.

51 { return m_name; }

◆ operator+=()

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

inlineinherited

◆ operator[]()

std::uint8_t & MuonVal::VectorBranch< std::uint8_t >::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 38 of file MuonTesterBranch.cxx.

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

◆ push_back() [1/2]

void MuonValR4::TrackSummaryValueBranch::push_back ( const MuonR4::HitSummary & summary )

push back the assigned hit summary value

Definition at line 33 of file TrackSummaryModule.cxx.

                                                                           {
         push_back(summary.value(m_cat, m_status, m_layer, m_isSmall));
     }

◆ push_back() [2/2]

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

inlineinherited

Adds a new element at the end of the vector.

◆ setDefault()

void MuonVal::VectorBranch< std::uint8_t >::setDefault ( const std::uint8_t & 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 28 of file AthMessaging.cxx.

 {
   m_lvl = lvl;
 }

◆ size()

size_t MuonVal::VectorBranch< std::uint8_t >::size

inlineinherited

Returns the number of actual saved elements.

◆ tree() [1/2]

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

finaloverridevirtualinherited

Implements MuonVal::IMuonTesterBranch.

Definition at line 54 of file MuonTesterBranch.cxx.

54 { return m_tree; }

◆ tree() [2/2]

TTree * MuonVal::MuonTesterBranch::tree ( )

finaloverridevirtualinherited

Returns the underlying TTree object.

Implements MuonVal::IMuonTesterBranch.

Definition at line 53 of file MuonTesterBranch.cxx.

53 { 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_cat

Category MuonValR4::TrackSummaryValueBranch::m_cat {Category::nCategories}

private

Definition at line 39 of file TrackSummaryModule.h.

◆ m_default

std::uint8_t MuonVal::VectorBranch< std::uint8_t >::m_default

privateinherited

Definition at line 55 of file VectorBranch.h.

◆ m_dependencies

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

◆ m_hasDefault

bool MuonVal::VectorBranch< std::uint8_t >::m_hasDefault

privateinherited

Definition at line 56 of file VectorBranch.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}

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

◆ m_isSmall

bool MuonValR4::TrackSummaryValueBranch::m_isSmall {false}

private

Definition at line 42 of file TrackSummaryModule.h.

◆ m_layer

LayerIndex MuonValR4::TrackSummaryValueBranch::m_layer {LayerIndex::LayerIndexMax}

private

Definition at line 41 of file TrackSummaryModule.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 {}

privateinherited

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}

privateinherited

Definition at line 59 of file MuonTesterBranch.h.

◆ m_status

Status MuonValR4::TrackSummaryValueBranch::m_status {Status::MaxValue}

private

Definition at line 40 of file TrackSummaryModule.h.

◆ m_tree

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

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

◆ m_updated

bool MuonVal::VectorBranch< std::uint8_t >::m_updated

privateinherited

Definition at line 57 of file VectorBranch.h.

◆ m_variable

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

privateinherited

Definition at line 54 of file VectorBranch.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Category

◆ DataDependency [1/2]

◆ DataDependency [2/2]

◆ LayerIndex

◆ Status

Constructor & Destructor Documentation

◆ TrackSummaryValueBranch()

Member Function Documentation

◆ addToTree()

◆ data_dependencies()

◆ declare_dependency()

◆ eraseWhiteSpaces()

◆ fill()

◆ get() [1/3]

◆ get() [2/3]

◆ get() [3/3]

◆ getDefault()

◆ hasDefault()

◆ init()

◆ initialized()

◆ initMessaging()

◆ isUpdated()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ name()

◆ operator+=()

◆ operator[]()

◆ parent()

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ setDefault()

◆ setLevel()

◆ size()

◆ tree() [1/2]

◆ tree() [2/2]

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_cat

◆ m_default

◆ m_dependencies

◆ m_hasDefault

◆ m_imsg

◆ m_init

◆ m_isSmall

◆ m_layer

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_parent

◆ m_status

◆ m_tree

◆ m_updated

◆ m_variable