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

#include <SysWriteHandle.h>

Inheritance diagram for CP::SysWriteHandle< T, Aux >:

Collaboration diagram for CP::SysWriteHandle< T, Aux >:

Public Member Functions
template<typename T2>
	SysWriteHandle (T2 *owner, const std::string &propertyName, const std::string &propertyValue, const std::string &propertyDescription)
	Standard constructor.
template<typename T2>
	SysWriteHandle (const std::string &outputName, T2 *owner)
	Direct constructor which doesn't declare a property.
virtual bool	empty () const noexcept override
	whether we have a name configured
	operator bool () const noexcept
	!empty()
virtual std::string	getNamePattern () const override
	get the name pattern before substitution
const std::string &	getName (const CP::SystematicSet &sys) const
	get the name we record to the event store
template<typename X = Aux, typename = std::enable_if_t<std::is_same_v<X,void>>>
::StatusCode	record (std::unique_ptr< T > object, const CP::SystematicSet &sys) const
	record the object for the given systematic
template<typename X = Aux, typename = std::enable_if_t<!std::is_same_v<X,void>>>
::StatusCode	record (std::unique_ptr< T > object, std::unique_ptr< Aux > aux, const CP::SystematicSet &sys) const
	retrieve the object for the given name
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)
	initialize this handle
StatusCode	initialize (SysListHandle &sysListHandle, SG::AllowEmptyEnum)

Private Types
typedef std::decay< decltype(*(std::declval< EL::AnaAlgorithm >().evtStore()))>::type	StoreType
	the type of the event store we use

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

Private Attributes
std::string	m_outputName
	the output name we use
std::unordered_map< CP::SystematicSet, std::string >	m_outputNameCache
	the cache of names we use
StoreType *	m_evtStore = nullptr
	the event store we use
std::function< StoreType *()>	m_evtStoreGetter
	the function to retrieve the event store
std::function< MsgStream &()>	m_msg
	the message stream we use

Detailed Description

template<typename T, typename Aux = void>
class CP::SysWriteHandle< T, Aux >

a data handle for writing systematics varied input data

Definition at line 29 of file SysWriteHandle.h.

Member Typedef Documentation

◆ StoreType

template<typename T, typename Aux = void>

typedef std::decay<decltype(*(std::declval<EL::AnaAlgorithm>().evtStore()))>::type CP::SysWriteHandle< T, Aux >::StoreType

private

the type of the event store we use

Definition at line 131 of file SysWriteHandle.h.

Constructor & Destructor Documentation

◆ SysWriteHandle() [1/2]

template<typename T, typename Aux = void>

template<typename T2>

CP::SysWriteHandle< T, Aux >::SysWriteHandle	(	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 container to be written should be configurable

◆ SysWriteHandle() [2/2]

template<typename T, typename Aux = void>

template<typename T2>

CP::SysWriteHandle< T, Aux >::SysWriteHandle	(	const std::string &	outputName,
		T2 *	owner )

Direct constructor which doesn't declare a property.

Member Function Documentation

◆ empty()

template<typename T, typename Aux = void>

virtual bool CP::SysWriteHandle< T, Aux >::empty ( ) const

overridevirtualnoexcept

whether we have a name configured

Implements CP::ISysHandleBase.

◆ fillSystematics()

template<typename T, typename Aux = void>

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

overrideprivatevirtual

register and cache the systematics

Implements CP::ISysHandleBase.

◆ getInputAffecting()

template<typename T, typename Aux = void>

virtual CP::SystematicSet CP::SysWriteHandle< T, Aux >::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, typename Aux = void>

const std::string & CP::SysWriteHandle< T, Aux >::getName ( const CP::SystematicSet & sys ) const

get the name we record to the event store

◆ getNamePattern()

template<typename T, typename Aux = void>

virtual std::string CP::SysWriteHandle< T, Aux >::getNamePattern ( ) const

overridevirtual

get the name pattern before substitution

Implements CP::ISysHandleBase.

◆ initialize() [1/2]

template<typename T, typename Aux = void>

StatusCode CP::SysWriteHandle< T, Aux >::initialize ( SysListHandle & sysListHandle )

initialize this handle

◆ initialize() [2/2]

template<typename T, typename Aux = void>

StatusCode CP::SysWriteHandle< T, Aux >::initialize	(	SysListHandle &	sysListHandle,
		SG::AllowEmptyEnum	)

◆ 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, typename Aux = void>

CP::SysWriteHandle< T, Aux >::operator bool ( ) const

explicitnoexcept

!empty()

◆ record() [1/2]

template<typename T, typename Aux = void>

template<typename X = Aux, typename = std::enable_if_t<std::is_same_v<X,void>>>

::StatusCode CP::SysWriteHandle< T, Aux >::record	(	std::unique_ptr< T >	object,
		const CP::SystematicSet &	sys ) const

record the object for the given systematic

◆ record() [2/2]

template<typename T, typename Aux = void>

template<typename X = Aux, typename = std::enable_if_t<!std::is_same_v<X,void>>>

::StatusCode CP::SysWriteHandle< T, Aux >::record	(	std::unique_ptr< T >	object,
		std::unique_ptr< Aux >	aux,
		const CP::SystematicSet &	sys ) const

retrieve the object for the given name

Member Data Documentation

◆ m_evtStore

template<typename T, typename Aux = void>

StoreType* CP::SysWriteHandle< T, Aux >::m_evtStore = nullptr

private

the event store we use

Definition at line 135 of file SysWriteHandle.h.

◆ m_evtStoreGetter

template<typename T, typename Aux = void>

std::function<StoreType*()> CP::SysWriteHandle< T, Aux >::m_evtStoreGetter

private

the function to retrieve the event store

This is an std::function to allow the parent to be either a tool or an algorithm. Though we are not really supporting tools as parents when using SysListHandle, so in principle this could be replaced with a pointer to the algorithm instead.

Definition at line 145 of file SysWriteHandle.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_outputName

template<typename T, typename Aux = void>

std::string CP::SysWriteHandle< T, Aux >::m_outputName

private

the output name we use

Definition at line 121 of file SysWriteHandle.h.

◆ m_outputNameCache

template<typename T, typename Aux = void>

std::unordered_map<CP::SystematicSet,std::string> CP::SysWriteHandle< T, Aux >::m_outputNameCache

private

the cache of names we use

Definition at line 125 of file SysWriteHandle.h.

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

SysWriteHandle.h

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreType

Constructor & Destructor Documentation

◆ SysWriteHandle() [1/2]

◆ SysWriteHandle() [2/2]

Member Function Documentation

◆ empty()

◆ fillSystematics()

◆ getInputAffecting()

◆ getName()

◆ getNamePattern()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator bool()

◆ record() [1/2]

◆ record() [2/2]

Member Data Documentation

◆ m_evtStore

◆ m_evtStoreGetter

◆ m_msg

◆ m_outputName

◆ m_outputNameCache