MuonValR4::TrackSummaryValueBranch Class Reference

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

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.
void	push_back (const MuonR4::HitSummary &summary)
	push back the assigned hit summary value
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 std::uint8_t &value)
	Adds a new element at the end of the vector.
void	operator+= (const std::uint8_t &value)
std::uint8_t &	operator[] (size_t idx)
	Accesses the idx-th element.
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.
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 (std::uint8_t &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
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
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

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

using MuonVal::IMuonTesterBranch::DataDependency

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 26 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()

bool MuonVal::MuonTesterBranch::addToTree ( std::uint8_t & 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.

{ return m_dependencies;}

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

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

inherited

get() [2/2]

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

inherited

Definition at line 64 of file MuonTesterBranch.cxx.

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

getDefault()

const std::uint8_t & MuonVal::VectorBranch< std::uint8_t >::getDefault ( ) const

inlineinherited

hasDefault()

bool MuonVal::VectorBranch< std::uint8_t >::hasDefault ( ) const

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 35 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 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< std::uint8_t >::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.

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

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  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.

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

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

push_back() [1/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.

push_back() [2/2]

void MuonValR4::TrackSummaryValueBranch::push_back

(

const MuonR4::HitSummary &

summary

)

push back the assigned hit summary value

Definition at line 34 of file TrackSummaryModule.cxx.

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

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

{
  m_lvl = lvl;
}

size()

size_t MuonVal::VectorBranch< std::uint8_t >::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.

{ return m_tree; }

tree() [2/2]

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

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE

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.

{Category::nCategories};

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.

{false};

m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_init

bool MuonVal::MuonTesterBranch::m_init

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

{false};

m_isSmall

bool MuonValR4::TrackSummaryValueBranch::m_isSmall {false}

private

Definition at line 42 of file TrackSummaryModule.h.

{false};

m_layer

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

private

Definition at line 41 of file TrackSummaryModule.h.

{LayerIndex::LayerIndexMax};

m_lvl

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

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

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

{};

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.

{nullptr};

m_status

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

private

Definition at line 40 of file TrackSummaryModule.h.

{Status::MaxValue};

m_tree

TTree* MuonVal::MuonTesterBranch::m_tree

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

{nullptr};

m_updated

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

privateinherited

Definition at line 57 of file VectorBranch.h.

{false};

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:

• TrackSummaryModule.h
• TrackSummaryModule.cxx