a data handle for reading systematics varied input data More...

#include <SysWriteDecorHandle.h>

Inheritance diagram for CP::SysWriteDecorHandle< T >:

Collaboration diagram for CP::SysWriteDecorHandle< T >:

Public Member Functions
template<typename T2>
	SysWriteDecorHandle (T2 *owner, const std::string &propertyName, const std::string &propertyValue, const std::string &propertyDescription)
	Standard constructor.
template<typename T2>
	SysWriteDecorHandle (const std::string &decorName, T2 *owner)
	Construct the handle directly without declaring a property.
virtual bool	empty () const noexcept override
	whether we have a name configured
	operator bool () const noexcept
	!empty()
const std::string &	getName (const CP::SystematicSet &sys) const
	get the name we retrieve from the event store
const std::string &	getDecorName () const noexcept
	get the decoration name we use
void	set (const SG::AuxElement &object, const T &value, const CP::SystematicSet &sys) const
	set the object decoration for the given systematic
void	lock (const SG::AuxElement &object, const CP::SystematicSet &sys) const
	lock the object decoration for the given systematic You should call this after all set() calls for a given object.
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

StatusCode	initialize (SysListHandle &sysListHandle, ISysObjectHandleBase &objectHandle)
	initialize this handle
StatusCode	initialize (SysListHandle &sysListHandle, ISysObjectHandleBase &objectHandle, SG::AllowEmptyEnum)

Private Member Functions
virtual CP::SystematicSet	getInputAffecting (const ISystematicsSvc &svc) const override
	get the affecting systematics if this is an input handle
virtual StatusCode	fillSystematics (const ISystematicsSvc &svc, const CP::SystematicSet &fullAffecting, const std::vector< CP::SystematicSet > &sysList) override
	register and cache the systematics
const auto &	getData (const CP::SystematicSet &sys) const
	get the data for the given systematics

Private Attributes
std::string	m_decorName
	the input name we use
ISysObjectHandleBase *	m_objectHandle {nullptr}
	the object handle we use
std::unordered_map< CP::SystematicSet, std::tuple< std::string, SG::Decorator< T > > >	m_dataCache
	the cache of names we use
std::function< MsgStream &()>	m_msg
	the message stream we use

Detailed Description

template<typename T>
class CP::SysWriteDecorHandle< T >

a data handle for reading systematics varied input data

Definition at line 40 of file SysWriteDecorHandle.h.

Constructor & Destructor Documentation

◆ SysWriteDecorHandle() [1/2]

template<typename T>

template<typename T2>

CP::SysWriteDecorHandle< T >::SysWriteDecorHandle	(	T2 *	owner,
		const std::string &	propertyName,
		const std::string &	propertyValue,
		const std::string &	propertyDescription )

Standard constructor.

Template Parameters

T2	The type of the owner

Parameters

owner	Used to declare the property and for its messaging
propertyName	The name of the property to declare
propertyValue	The default value for the property
propertyDescription	The description of the property

This version of the constructor declares a property on the parent object and should usually be preferred when the decoration to be written should be configurable

◆ SysWriteDecorHandle() [2/2]

template<typename T>

template<typename T2>

CP::SysWriteDecorHandle< T >::SysWriteDecorHandle	(	const std::string &	decorName,
		T2 *	owner )

Construct the handle directly without declaring a property.

Member Function Documentation

◆ empty()

template<typename T>

virtual bool CP::SysWriteDecorHandle< T >::empty ( ) const

overridevirtualnoexcept

whether we have a name configured

Implements CP::ISysHandleBase.

◆ fillSystematics()

template<typename T>

virtual StatusCode CP::SysWriteDecorHandle< T >::fillSystematics	(	const ISystematicsSvc &	svc,
		const CP::SystematicSet &	fullAffecting,
		const std::vector< CP::SystematicSet > &	sysList )

overrideprivatevirtual

register and cache the systematics

Implements CP::ISysHandleBase.

◆ getData()

template<typename T>

const auto & CP::SysWriteDecorHandle< T >::getData ( const CP::SystematicSet & sys ) const

private

get the data for the given systematics

◆ getDecorName()

template<typename T>

const std::string & CP::SysWriteDecorHandle< T >::getDecorName ( ) const

noexcept

get the decoration name we use

◆ getInputAffecting()

template<typename T>

virtual CP::SystematicSet CP::SysWriteDecorHandle< T >::getInputAffecting ( const ISystematicsSvc & svc ) const

overrideprivatevirtual

get the affecting systematics if this is an input handle

This returns the empty set if this is either not an input handle, or if the input handle is not affected by systematics.

Implements CP::ISysHandleBase.

◆ getName()

template<typename T>

const std::string & CP::SysWriteDecorHandle< T >::getName ( const CP::SystematicSet & sys ) const

get the name we retrieve from the event store

◆ initialize() [1/2]

template<typename T>

StatusCode CP::SysWriteDecorHandle< T >::initialize	(	SysListHandle &	sysListHandle,
		ISysObjectHandleBase &	objectHandle )

initialize this handle

◆ initialize() [2/2]

template<typename T>

StatusCode CP::SysWriteDecorHandle< T >::initialize	(	SysListHandle &	sysListHandle,
		ISysObjectHandleBase &	objectHandle,
		SG::AllowEmptyEnum	)

◆ lock()

template<typename T>

void CP::SysWriteDecorHandle< T >::lock	(	const SG::AuxElement &	object,
		const CP::SystematicSet &	sys ) const

lock the object decoration for the given systematic You should call this after all set() calls for a given object.

◆ msg() [1/2]

MsgStream & asg::AsgMessagingForward::msg ( ) const

inherited

The standard message stream.

Returns: A reference to the default message stream of this object.

Definition at line 24 of file AsgMessagingForward.cxx.

  {
    return m_msg();
  }

◆ msg() [2/2]

MsgStream & asg::AsgMessagingForward::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns: A reference to the default message stream, set to level "lvl"

Definition at line 29 of file AsgMessagingForward.cxx.

  {
    MsgStream& msg = m_msg ();
    msg << lvl;
    return msg;
  }

◆ msgLvl()

bool asg::AsgMessagingForward::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns: boolean Indicting if messages at given level will be printed; true If messages at level "lvl" will be printed

Definition at line 11 of file AsgMessagingForward.cxx.

  {
    MsgStream& msg = m_msg();
    if (msg.level() <= lvl)
    {
      msg << lvl;
      return true;
    } else
    {
      return false;
    }
  }

◆ operator bool()

template<typename T>

CP::SysWriteDecorHandle< T >::operator bool ( ) const

explicitnoexcept

!empty()

◆ set()

template<typename T>

void CP::SysWriteDecorHandle< T >::set	(	const SG::AuxElement &	object,
		const T &	value,
		const CP::SystematicSet &	sys ) const

set the object decoration for the given systematic

Member Data Documentation

◆ m_dataCache

template<typename T>

std::unordered_map<CP::SystematicSet,std::tuple<std::string,SG::Decorator<T> > > CP::SysWriteDecorHandle< T >::m_dataCache

private

the cache of names we use

Definition at line 136 of file SysWriteDecorHandle.h.

◆ m_decorName

template<typename T>

std::string CP::SysWriteDecorHandle< T >::m_decorName

private

the input name we use

Definition at line 128 of file SysWriteDecorHandle.h.

◆ m_msg

std::function<MsgStream& ()> asg::AsgMessagingForward::m_msg

privateinherited

the message stream we use

This used to be a simple pointer to the MsgStream itself, but in AthenaMT the actual object used is local to the thread. So instead of pointing to it directly we are now using a function to look it up, which will get the thread-local object.

Definition at line 77 of file AsgMessagingForward.h.

◆ m_objectHandle

template<typename T>

ISysObjectHandleBase* CP::SysWriteDecorHandle< T >::m_objectHandle {nullptr}

private

the object handle we use

Definition at line 132 of file SysWriteDecorHandle.h.

132{nullptr};

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

SysWriteDecorHandle.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SysWriteDecorHandle() [1/2]

◆ SysWriteDecorHandle() [2/2]

Member Function Documentation

◆ empty()

◆ fillSystematics()

◆ getData()

◆ getDecorName()

◆ getInputAffecting()

◆ getName()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ lock()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator bool()

◆ set()

Member Data Documentation

◆ m_dataCache

◆ m_decorName

◆ m_msg

◆ m_objectHandle