#include <ScalarBranch.h>

Inheritance diagram for MuonVal::ScalarBranch< T >:

Collaboration diagram for MuonVal::ScalarBranch< T >:

Public Types
using	DataDependency = SG::VarHandleKey*

Public Member Functions
	ScalarBranch (TTree *tree, const std::string &name)
	Default constructor passing the TTree object and the name of the branch in the tree.
	ScalarBranch (MuonTesterTree &tree, const std::string &name)
	ScalarBranch (TTree *tree, const std::string &name, const T &default_value)
	Constructor providing a default_value which is inserted when the information in the branch is not updated.
	ScalarBranch (MuonTesterTree &tree, const std::string &name, const T &default_value)
virtual	~ScalarBranch ()=default
bool	fill (const EventContext &ctx) override
	The fill method checks if enough information is provided such that the branch is cleared from the information of the prevoius event and in cases of that updates did no happen befure a default value is provided.
bool	init () override
	The init method checks whether the branch name has already registered to the MuonTree and tries then to add the branch to the tree --> return false if the branch has already been defined or the inclusion of the branch to the tree failed or the name of the branch is empty.
const T &	operator= (const T &value)
	Setter methods.
const T &	setValue (const T &value)
bool	isUpdated () const
void	setDefault (const T &def)
void	disableFailing ()
const T &	getDefault () const
const T &	getVariable () const
bool	mustBeUpdated () 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
template<class T>
bool	addToTree (T &variable)
	Connects the Memory buffer with the TTree.
template<class Key>
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
T	m_variable {}
T	m_default {}
bool	m_failIfNotUpdated {true}
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.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

template<class T>
class MuonVal::ScalarBranch< T >

Definition at line 12 of file ScalarBranch.h.

Member Typedef Documentation

◆ DataDependency

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

inherited

Definition at line 39 of file IMuonTesterBranch.h.

Constructor & Destructor Documentation

◆ ScalarBranch() [1/4]

template<class T>

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

Default constructor passing the TTree object and the name of the branch in the tree.

The value of the branch must always be set before the fill call

◆ ScalarBranch() [2/4]

template<class T>

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

◆ ScalarBranch() [3/4]

template<class T>

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

Constructor providing a default_value which is inserted when the information in the branch is not updated.

◆ ScalarBranch() [4/4]

template<class T>

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

◆ ~ScalarBranch()

template<class T>

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

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

MuonVal::MuonTesterBranch::m_dependencies

std::vector< DataDependency > m_dependencies

Definition MuonTesterBranch.h:62

◆ declare_dependency()

template<class Key>

bool MuonVal::MuonTesterBranch::declare_dependency ( Key & key )

protectedinherited

Declares the ReadHandle/ ReadCondHandleKey as data dependency of the algorithm.

◆ disableFailing()

template<class T>

void MuonVal::ScalarBranch< T >::disableFailing ( )

◆ 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::ScalarBranch< T >::fill ( const EventContext & ctx )

overridevirtual

The fill method checks if enough information is provided such that the branch is cleared from the information of the prevoius event and in cases of that updates did no happen befure a default value is provided.

--> returns false if no update is called or the dummy value has not been defined

Implements MuonVal::IMuonTesterBranch.

◆ getDefault()

template<class T>

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

◆ getVariable()

template<class T>

const T & MuonVal::ScalarBranch< T >::getVariable ( ) const

◆ init()

template<class T>

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

overridevirtual

The init method checks whether the branch name has already registered to the MuonTree and tries then to add the branch to the tree --> return false if the branch has already been defined or the inclusion of the branch to the tree failed or the name of the branch is empty.

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

MuonVal::MuonTesterBranch::m_init

bool m_init

Definition MuonTesterBranch.h:61

◆ 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();
  // 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()

template<class T>

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

◆ 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 163 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 178 of file AthMessaging.h.

179{ return msg() << lvl; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:163

◆ 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_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ mustBeUpdated()

template<class T>

bool MuonVal::ScalarBranch< T >::mustBeUpdated ( ) const

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

MuonVal::MuonTesterBranch::m_name

std::string m_name

Definition MuonTesterBranch.h:60

◆ operator=()

template<class T>

const T & MuonVal::ScalarBranch< T >::operator= ( const T & value )

Setter methods.

Either via assignment operator E.g. my_branch = 1. ot by

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

◆ setDefault()

template<class T>

void MuonVal::ScalarBranch< 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;
}

◆ setValue()

template<class T>

const T & MuonVal::ScalarBranch< T >::setValue ( const T & value )

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

MuonVal::MuonTesterBranch::m_tree

TTree * m_tree

Definition MuonTesterBranch.h:58

◆ 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::ScalarBranch< T >::m_default {}

private

Definition at line 46 of file ScalarBranch.h.

46{};

◆ m_dependencies

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

privateinherited

Definition at line 62 of file MuonTesterBranch.h.

62{};

◆ m_failIfNotUpdated

template<class T>

bool MuonVal::ScalarBranch< T >::m_failIfNotUpdated {true}

private

Definition at line 47 of file ScalarBranch.h.

47{true};

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_init

bool MuonVal::MuonTesterBranch::m_init {false}

privateinherited

Definition at line 61 of file MuonTesterBranch.h.

61{false};

◆ m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

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

60{};

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

59{nullptr};

◆ m_tree

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

privateinherited

Definition at line 58 of file MuonTesterBranch.h.

58{nullptr};

◆ m_updated

template<class T>

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

private

Definition at line 48 of file ScalarBranch.h.

48{false};

◆ m_variable

template<class T>

T MuonVal::ScalarBranch< T >::m_variable {}

private

Definition at line 45 of file ScalarBranch.h.

45{};

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

ScalarBranch.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataDependency

Constructor & Destructor Documentation

◆ ScalarBranch() [1/4]

◆ ScalarBranch() [2/4]

◆ ScalarBranch() [3/4]

◆ ScalarBranch() [4/4]

◆ ~ScalarBranch()

Member Function Documentation

◆ addToTree()

◆ data_dependencies()

◆ declare_dependency()

◆ disableFailing()

◆ eraseWhiteSpaces()

◆ fill()

◆ getDefault()

◆ getVariable()

◆ init()

◆ initialized()

◆ initMessaging()

◆ isUpdated()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ mustBeUpdated()

◆ name()

◆ operator=()

◆ parent()

◆ setDefault()

◆ setLevel()

◆ setValue()

◆ tree() [1/2]

◆ tree() [2/2]

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_default

◆ m_dependencies

◆ m_failIfNotUpdated

◆ m_imsg

◆ m_init

◆ m_lvl

◆ m_msg_tls

◆ m_name

◆ m_nm

◆ m_parent

◆ m_tree

◆ m_updated

◆ m_variable