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::ArrayBranch< T > Class Template Reference

#include <ArrayBranch.h>

Inheritance diagram for MuonVal::ArrayBranch< T >:
Collaboration diagram for MuonVal::ArrayBranch< T >:

Public Types

using DataDependency = SG::VarHandleKey *
 
using DataDependency = SG::VarHandleKey *
 

Public Member Functions

 ArrayBranch (TTree *tree, const std::string &name, size_t size)
 Constructor. More...
 
 ArrayBranch (MuonTesterTree &tree, const std::string &name, size_t size)
 
 ArrayBranch (TTree *tree, const std::string &name, size_t size, const T &def_val)
 Constructor with default value to be set in case an element is not updated. More...
 
 ArrayBranch (MuonTesterTree &tree, const std::string &name, size_t size, const T &def_val)
 
virtual ~ArrayBranch ()=default
 
bool fill (const EventContext &) override final
 Returns false if one of the array values is not updated. More...
 
bool init () override final
 Connects the branch with the tree. More...
 
bool initialized () const
 Is the branch initialized. More...
 
size_t size () const
 How large is the array. More...
 
void set (size_t s, const T &val)
 Set's the i-th entry of the array to val. More...
 
const T & get (size_t s) const
 Returns the i-th value. More...
 
const T & operator[] (size_t s) const
 Operator implementation of get. More...
 
T & operator[] (size_t s)
 Operator implementation of set() More...
 
const T & getDefault () const
 default value in cases the branch is not updated More...
 
void setDefault (const T &val)
 
std::string name () const override final
 Returns the name of the branch. 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

std::string tree_data_type () const
 Data type of the branch in the tree. More...
 
void reset ()
 Resets the check mask. More...
 
std::string tree_data_type () const
 Specification of the branch data_type for the TTree initialize routine. More...
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
std::string tree_data_type () const
 
void initMessaging () const
 Initialize our message level and MessageSvc. More...
 

Private Attributes

size_t m_size {0}
 
std::vector< T > m_data {}
 
std::vector< bool > m_updated {}
 
bool m_init {false}
 
m_default {}
 Default value in cases where the part are not updated. More...
 
bool m_failIfNotUpdated {true}
 
TTree * m_tree {nullptr}
 
MuonTesterTreem_parent {nullptr}
 
std::string m_name {}
 
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::ArrayBranch< T >

Definition at line 14 of file ArrayBranch.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

◆ ArrayBranch() [1/4]

template<class T >
MuonVal::ArrayBranch< T >::ArrayBranch ( TTree *  tree,
const std::string &  name,
size_t  size 
)

Constructor.

◆ ArrayBranch() [2/4]

template<class T >
MuonVal::ArrayBranch< T >::ArrayBranch ( MuonTesterTree tree,
const std::string &  name,
size_t  size 
)

◆ ArrayBranch() [3/4]

template<class T >
MuonVal::ArrayBranch< T >::ArrayBranch ( TTree *  tree,
const std::string &  name,
size_t  size,
const T &  def_val 
)

Constructor with default value to be set in case an element is not updated.

◆ ArrayBranch() [4/4]

template<class T >
MuonVal::ArrayBranch< T >::ArrayBranch ( MuonTesterTree tree,
const std::string &  name,
size_t  size,
const T &  def_val 
)

◆ ~ArrayBranch()

template<class T >
virtual MuonVal::ArrayBranch< T >::~ArrayBranch ( )
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::ArrayBranch< T >::fill ( const EventContext &  )
finaloverridevirtual

Returns false if one of the array values is not updated.

Implements MuonVal::IMuonTesterBranch.

◆ get()

template<class T >
const T& MuonVal::ArrayBranch< T >::get ( size_t  s) const

Returns the i-th value.

◆ getDefault()

template<class T >
const T& MuonVal::ArrayBranch< T >::getDefault ( ) const

default value in cases the branch is not updated

◆ init()

template<class T >
bool MuonVal::ArrayBranch< T >::init ( )
finaloverridevirtual

Connects the branch with the tree.

Implements MuonVal::IMuonTesterBranch.

◆ initialized()

template<class T >
bool MuonVal::ArrayBranch< T >::initialized ( ) const

Is the branch initialized.

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

◆ 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[]() [1/2]

template<class T >
T& MuonVal::ArrayBranch< T >::operator[] ( size_t  s)

Operator implementation of set()

◆ operator[]() [2/2]

template<class T >
const T& MuonVal::ArrayBranch< T >::operator[] ( size_t  s) const

Operator implementation of get.

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

◆ reset()

template<class T >
void MuonVal::ArrayBranch< T >::reset ( )
private

Resets the check mask.

◆ set()

template<class T >
void MuonVal::ArrayBranch< T >::set ( size_t  s,
const T &  val 
)

Set's the i-th entry of the array to val.

◆ setDefault()

template<class T >
void MuonVal::ArrayBranch< T >::setDefault ( const T &  val)

◆ 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::ArrayBranch< T >::size ( ) const

How large is the array.

◆ 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; }

◆ tree_data_type() [1/14]

template<class T >
std::string MuonVal::ArrayBranch< T >::tree_data_type ( ) const
private

Data type of the branch in the tree.

◆ tree_data_type() [2/14]

std::string MuonVal::ArrayBranch< char * >::tree_data_type ( ) const
private

Specification of the branch data_type for the TTree initialize routine.

◆ tree_data_type() [3/14]

std::string MuonVal::ArrayBranch< std::string >::tree_data_type ( ) const
private

◆ tree_data_type() [4/14]

std::string MuonVal::ArrayBranch< Char_t >::tree_data_type ( ) const
private

◆ tree_data_type() [5/14]

std::string MuonVal::ArrayBranch< UChar_t >::tree_data_type ( ) const
private

◆ tree_data_type() [6/14]

std::string MuonVal::ArrayBranch< Short_t >::tree_data_type ( ) const
private

◆ tree_data_type() [7/14]

std::string MuonVal::ArrayBranch< Int_t >::tree_data_type ( ) const
private

◆ tree_data_type() [8/14]

std::string MuonVal::ArrayBranch< Long64_t >::tree_data_type ( ) const
private

◆ tree_data_type() [9/14]

std::string MuonVal::ArrayBranch< UShort_t >::tree_data_type ( ) const
private

◆ tree_data_type() [10/14]

std::string MuonVal::ArrayBranch< UInt_t >::tree_data_type ( ) const
private

◆ tree_data_type() [11/14]

std::string MuonVal::ArrayBranch< ULong64_t >::tree_data_type ( ) const
private

◆ tree_data_type() [12/14]

std::string MuonVal::ArrayBranch< Float_t >::tree_data_type ( ) const
private

◆ tree_data_type() [13/14]

std::string MuonVal::ArrayBranch< Double_t >::tree_data_type ( ) const
private

◆ tree_data_type() [14/14]

std::string MuonVal::ArrayBranch< Bool_t >::tree_data_type ( ) const
private

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_data

template<class T >
std::vector<T> MuonVal::ArrayBranch< T >::m_data {}
private

Definition at line 58 of file ArrayBranch.h.

◆ m_default

template<class T >
T MuonVal::ArrayBranch< T >::m_default {}
private

Default value in cases where the part are not updated.

Definition at line 64 of file ArrayBranch.h.

◆ m_dependencies

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

Definition at line 62 of file MuonTesterBranch.h.

◆ m_failIfNotUpdated

template<class T >
bool MuonVal::ArrayBranch< T >::m_failIfNotUpdated {true}
private

Definition at line 65 of file ArrayBranch.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }
mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

◆ m_init

template<class T >
bool MuonVal::ArrayBranch< T >::m_init {false}
private

Definition at line 61 of file ArrayBranch.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_size

template<class T >
size_t MuonVal::ArrayBranch< T >::m_size {0}
private

Definition at line 57 of file ArrayBranch.h.

◆ m_tree

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

Definition at line 58 of file MuonTesterBranch.h.

◆ m_updated

template<class T >
std::vector<bool> MuonVal::ArrayBranch< T >::m_updated {}
private

Definition at line 59 of file ArrayBranch.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
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
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::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