MuonVal::VectorBranch< T > Class Template Reference

#include <VectorBranch.h>

Inheritance diagram for MuonVal::VectorBranch< T >:

Collaboration diagram for MuonVal::VectorBranch< T >:

Public Types
using	DataDependency = SG::VarHandleKey *
using	DataDependency = SG::VarHandleKey *

Public Member Functions
	VectorBranch (TTree *tree, const std::string &name)
	Standard constructor. More...
	VectorBranch (MuonTesterTree &tree, const std::string &name)
	VectorBranch (TTree *tree, const std::string &name, const T &def)
	Constructor with assigned default value. More...
	VectorBranch (MuonTesterTree &tree, const std::string &name, const T &def)
virtual	~VectorBranch ()=default
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 T &value)
	Adds a new element at the end of the vector. More...
void	operator+= (const T &value)
T &	operator[] (size_t idx)
	Accesses the idx-th element. More...
T &	get (size_t idx)
const T &	getDefault () const
void	setDefault (const T &def)
bool	isUpdated () const
bool	hasDefault () const
bool &	get (size_t idx)
bool &	get (size_t)
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
std::vector< T >	m_variable {}
T	m_default {}
bool	m_hasDefault {false}
bool	m_updated {false}
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

template<class T>
class MuonVal::VectorBranch< T >

Definition at line 14 of file VectorBranch.h.

Member Typedef Documentation

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.

Constructor & Destructor Documentation

VectorBranch() [1/4]

template<class T >

MuonVal::VectorBranch< T >::VectorBranch	(	TTree *	tree,
		const std::string &	name
	)

Standard constructor.

VectorBranch() [2/4]

template<class T >

MuonVal::VectorBranch< T >::VectorBranch	(	MuonTesterTree &	tree,
		const std::string &	name
	)

VectorBranch() [3/4]

template<class T >

MuonVal::VectorBranch< T >::VectorBranch	(	TTree *	tree,
		const std::string &	name,
		const T &	def
	)

Constructor with assigned default value.

VectorBranch() [4/4]

template<class T >

MuonVal::VectorBranch< T >::VectorBranch	(	MuonTesterTree &	tree,
		const std::string &	name,
		const T &	def
	)

~VectorBranch()

template<class T >

virtual MuonVal::VectorBranch< T >::~VectorBranch ( )

virtualdefault

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.

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

template<class T >

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

overridevirtual

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]

template<class T >

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

inline

get() [2/3]

bool & MuonVal::VectorBranch< bool >::get

(

size_t

idx

)

get() [3/3]

bool & MuonVal::VectorBranch< bool >::get

(

size_t

)

Definition at line 63 of file MuonTesterBranch.cxx.

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

getDefault()

template<class T >

const T& MuonVal::VectorBranch< T >::getDefault ( ) const

inline

hasDefault()

template<class T >

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

inline

init()

template<class T >

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

overridevirtual

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.

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

template<class T >

bool MuonVal::VectorBranch< T >::isUpdated ( ) const

inline

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

finaloverridevirtualinherited

Returns the name of the branch.

Implements MuonVal::IMuonTesterBranch.

Definition at line 51 of file MuonTesterBranch.cxx.

{ return m_name; }

operator+=()

template<class T >

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

inline

operator[]()

template<class T >

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

inline

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

template<class T >

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

inline

Adds a new element at the end of the vector.

setDefault()

template<class T >

void MuonVal::VectorBranch< T >::setDefault

(

const T &

def

)

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

template<class T >

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

inline

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.

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

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

template<class T >

T MuonVal::VectorBranch< T >::m_default {}

private

Definition at line 53 of file VectorBranch.h.

m_dependencies

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

m_hasDefault

template<class T >

bool MuonVal::VectorBranch< T >::m_hasDefault {false}

private

Definition at line 54 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_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_tree

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

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

m_updated

template<class T >

bool MuonVal::VectorBranch< T >::m_updated {false}

private

Definition at line 55 of file VectorBranch.h.

m_variable

template<class T >

std::vector<T> MuonVal::VectorBranch< T >::m_variable {}

private

Definition at line 52 of file VectorBranch.h.

---

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

• VectorBranch.h