a data handle for reading systematically varied selection properties from objects More...

#include <SysReadSelectionHandle.h>

Inheritance diagram for CP::SysReadSelectionHandle:

Collaboration diagram for CP::SysReadSelectionHandle:

Public Member Functions
template<typename T2 >
	SysReadSelectionHandle (T2 *owner, const std::string &propertyName, const std::string &propertyValue, const std::string &propertyDescription)
	Standard constructor. More...

template<typename T2 >
	SysReadSelectionHandle (const std::string &selection, T2 *owner)
	Construct the handle directly without declaring a property. More...

	operator bool () const noexcept
	!empty() More...

StatusCode	initialize (SysListHandle &sysListHandle, const ISysHandleBase &objectHandle)
	initialize the accessor More...

StatusCode	initialize (SysListHandle &sysListHandle, const ISysHandleBase &objectHandle, SG::AllowEmptyEnum)

bool	getBool (const SG::AuxElement &element, const CP::SystematicSet &sys) const
	get the selection as a bool More...

const std::string &	getSelectionName () const
	get the name of the selection More...

virtual bool	empty () const noexcept override

virtual std::string	getNamePattern () const override
	get the name pattern before substitution More...

virtual CP::SystematicSet	getInputAffecting (const ISystematicsSvc &svc) const override
	get the affecting systematics if this is an input handle More...

virtual StatusCode	fillSystematics (const ISystematicsSvc &svc, const CP::SystematicSet &fullAffecting, const std::vector< CP::SystematicSet > &sysList) override
	register and cache the systematics More...

bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object. More...

MsgStream &	msg () const
	The standard message stream. More...

MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream. More...

Private Attributes
std::string	m_selection
	the selection we use More...

const ISysHandleBase *	m_objectHandle {nullptr}
	the object handle we use More...

std::unique_ptr< ISelectionReadAccessor >	m_accessor
	the accessor we use More...

std::function< MsgStream &()>	m_msg
	the message stream we use More...

Detailed Description

a data handle for reading systematically varied selection properties from objects

Definition at line 30 of file SysReadSelectionHandle.h.

Constructor & Destructor Documentation

◆ SysReadSelectionHandle() [1/2]

template<typename T2 >

CP::SysReadSelectionHandle::SysReadSelectionHandle	(	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 selection to be read should be configurable

◆ SysReadSelectionHandle() [2/2]

template<typename T2 >

CP::SysReadSelectionHandle::SysReadSelectionHandle	(	const std::string &	selection,
		T2 *	owner
	)

Construct the handle directly without declaring a property.

Member Function Documentation

◆ empty()

bool CP::SysReadSelectionHandle::empty ( ) const

overridevirtualnoexcept

Inherited Members

Implements CP::ISysHandleBase.

Definition at line 67 of file SysReadSelectionHandle.cxx.

   {
     return m_selection.empty();
   }

◆ fillSystematics()

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

overridevirtual

register and cache the systematics

Implements CP::ISysHandleBase.

Definition at line 98 of file SysReadSelectionHandle.cxx.

   {
     ANA_CHECK (m_accessor->fillSystematics (svc, sysList, m_objectHandle->getNamePattern()));
     return StatusCode::SUCCESS;
   }

◆ getBool()

bool CP::SysReadSelectionHandle::getBool	(	const SG::AuxElement &	element,
		const CP::SystematicSet &	sys
	)		const

get the selection as a bool

◆ getInputAffecting()

CP::SystematicSet CP::SysReadSelectionHandle::getInputAffecting ( const ISystematicsSvc & svc ) const

overridevirtual

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.

Definition at line 90 of file SysReadSelectionHandle.cxx.

   {
     return m_accessor->getInputAffecting (svc, m_objectHandle->getNamePattern());
   }

◆ getNamePattern()

std::string CP::SysReadSelectionHandle::getNamePattern ( ) const

overridevirtual

get the name pattern before substitution

Implements CP::ISysHandleBase.

Definition at line 75 of file SysReadSelectionHandle.cxx.

   {
     // So far it is undefined what to return here.  I'll fill this in
     // once there is a reason for it to be one or the other.
     return "";
   }

◆ getSelectionName()

const std::string & CP::SysReadSelectionHandle::getSelectionName ( ) const

get the name of the selection

Definition at line 83 of file SysReadSelectionHandle.cxx.

   {
     return m_selection;
   }

◆ initialize() [1/2]

StatusCode CP::SysReadSelectionHandle::initialize	(	SysListHandle &	sysListHandle,
		const ISysHandleBase &	objectHandle
	)

initialize the accessor

Definition at line 33 of file SysReadSelectionHandle.cxx.

   {
     if (m_selection.empty())
     {
       ANA_MSG_ERROR ("trying to initialize empty handle");
       return StatusCode::FAILURE;
     }
     if (m_objectHandle != nullptr)
     {
       ANA_MSG_ERROR ("trying to initialize handle twice");
       return StatusCode::FAILURE;
     }
     m_objectHandle = &objectHandle;
     ANA_CHECK (makeSelectionReadAccessor (m_selection, m_accessor));
     return sysListHandle.addHandle (*this);
   }

◆ initialize() [2/2]

StatusCode CP::SysReadSelectionHandle::initialize	(	SysListHandle &	sysListHandle,
		const ISysHandleBase &	objectHandle,
		SG::AllowEmptyEnum
	)

Definition at line 53 of file SysReadSelectionHandle.cxx.

   {
     if (!empty())
       return initialize (sysListHandle, objectHandle);
     else
     {
       m_accessor = std::make_unique<SelectionReadAccessorNull>(true);
       return StatusCode::SUCCESS;
     }
   }

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

CP::SysReadSelectionHandle::operator bool ( ) const

explicitnoexcept

!empty()

Definition at line 25 of file SysReadSelectionHandle.cxx.

   {
     return !m_selection.empty();
   }

Member Data Documentation

◆ m_accessor

std::unique_ptr<ISelectionReadAccessor> CP::SysReadSelectionHandle::m_accessor

private

the accessor we use

Definition at line 109 of file SysReadSelectionHandle.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

const ISysHandleBase* CP::SysReadSelectionHandle::m_objectHandle {nullptr}

private

the object handle we use

Definition at line 105 of file SysReadSelectionHandle.h.

◆ m_selection

std::string CP::SysReadSelectionHandle::m_selection

private

the selection we use

Definition at line 101 of file SysReadSelectionHandle.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SysReadSelectionHandle() [1/2]

◆ SysReadSelectionHandle() [2/2]

Member Function Documentation

◆ empty()

Inherited Members

◆ fillSystematics()

◆ getBool()

◆ getInputAffecting()

◆ getNamePattern()

◆ getSelectionName()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator bool()

Member Data Documentation

◆ m_accessor

◆ m_msg

◆ m_objectHandle

◆ m_selection