ATLAS Offline Software
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
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< DataDependencydata_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...
 
MuonTesterTreeparent ()
 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 {}
 
m_default {}
 
bool m_hasDefault {false}
 
bool m_updated {false}
 
TTree * m_tree {nullptr}
 
MuonTesterTreem_parent {nullptr}
 
std::string m_name {}
 
bool m_init {false}
 
std::vector< DataDependencym_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]

Definition at line 39 of file IMuonTesterBranch.h.

◆ DataDependency [2/2]

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.

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.

56  {
57  std::string out = In;
58  out.erase(std::remove_if(out.begin(), out.end(), isspace), out.end());
59  return out;
60 }

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

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

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

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.

40 {
42  m_lvl = m_imsg ?
43  static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
44  MSG::INFO;
45 }

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

165 {
166  MsgStream* ms = m_msg_tls.get();
167  if (!ms) {
168  if (!m_initialized.test_and_set()) initMessaging();
169  ms = new MsgStream(m_imsg,m_nm);
170  m_msg_tls.reset( ms );
171  }
172 
173  ms->setLevel (m_lvl);
174  return *ms;
175 }

◆ 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
lvlThe message level to test against
Returns
boolean Indicating if messages at given level will be printed
Return values
trueMessages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

152 {
153  if (!m_initialized.test_and_set()) initMessaging();
154  if (m_lvl <= lvl) {
155  msg() << lvl;
156  return true;
157  } else {
158  return false;
159  }
160 }

◆ 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+=()

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.

38  {
39  if (!m_parent) {
40  ATH_MSG_WARNING("The parent of " << name() << " is null.");
41  }
42  return *m_parent;
43 }

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

29 {
30  m_lvl = lvl;
31 }

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

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_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:
AthMessaging::m_lvl
std::atomic< MSG::Level > m_lvl
Current logging level.
Definition: AthMessaging.h:138
MuonVal::MuonTesterBranch::m_dependencies
std::vector< DataDependency > m_dependencies
Definition: MuonTesterBranch.h:62
MuonVal::MuonTesterBranch::m_tree
TTree * m_tree
Definition: MuonTesterBranch.h:58
python.AthDsoLogger.out
out
Definition: AthDsoLogger.py:71
THROW_EXCEPTION
#define THROW_EXCEPTION(MSG)
Definition: MMReadoutElement.cxx:48
AthMessaging::m_imsg
std::atomic< IMessageSvc * > m_imsg
MessageSvc pointer.
Definition: AthMessaging.h:135
python.SystemOfUnits.ms
int ms
Definition: SystemOfUnits.py:132
Athena::getMessageSvc
IMessageSvc * getMessageSvc(bool quiet=false)
Definition: getMessageSvc.cxx:20
MuonVal::MuonTesterBranch::m_parent
MuonTesterTree * m_parent
Definition: MuonTesterBranch.h:59
TrigConf::MSGTC::Level
Level
Definition: Trigger/TrigConfiguration/TrigConfBase/TrigConfBase/MsgStream.h:21
MuonVal::MuonTesterBranch::m_init
bool m_init
Definition: MuonTesterBranch.h:61
AthMessaging::msg
MsgStream & msg() const
The standard message stream.
Definition: AthMessaging.h:164
MuonVal::MuonTesterBranch::name
std::string name() const override final
Returns the name of the branch.
Definition: MuonTesterBranch.cxx:51
MuonVal::VectorBranch::m_default
T m_default
Definition: VectorBranch.h:53
MuonVal::MuonTesterBranch::m_name
std::string m_name
Definition: MuonTesterBranch.h:60
ATH_MSG_WARNING
#define ATH_MSG_WARNING(x)
Definition: AthMsgStreamMacros.h:32
AthMessaging::m_nm
std::string m_nm
Message source name.
Definition: AthMessaging.h:129
AthMessaging::initMessaging
void initMessaging() const
Initialize our message level and MessageSvc.
Definition: AthMessaging.cxx:39
AthMessaging::m_msg_tls
boost::thread_specific_ptr< MsgStream > m_msg_tls
MsgStream instance (a std::cout like with print-out levels)
Definition: AthMessaging.h:132