#include <CutTool.h>

Inheritance diagram for CutTool:

Collaboration diagram for CutTool:

Public Member Functions
	CutTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
virtual	~CutTool ()
	Destructor:
virtual StatusCode	initialize () override
	Athena algtool's initialize.
virtual StatusCode	finalize () override
	Athena algtool's finalize.
virtual bool	eventPassesFilter () const final override
	Implement the method from the ISkimmingTool interface.
StatusCode	initializeParser (ExpressionParsing::SelectionArg< 1 > selection_string)
StatusCode	finalizeParser ()
virtual bool	updateDataNeeds (const std::vector< const DataObjID * > &input_data_in, const std::vector< const DataObjID * > &output_data_in, std::vector< Gaudi::DataHandle * > &new_input_handles, std::vector< Gaudi::DataHandle * > &new_output_handles) override
	Inform a dynamic data consumer about all consumed or produced data.
virtual bool	renounceInput (const DataObjID &output_data_id) override
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
	DeclareInterfaceID (ISkimmingTool, 1, 0)

Protected Member Functions
StatusCode	_initializeParser (const ExpressionParsing::SelectionArg< NUM_PARSER > &selection_string, ExpressionParsing::AppendLoaderFunc pre_xaod_loader=ExpressionParsing::NoLoaderFunc, ExpressionParsing::AppendLoaderFunc post_xaod_loader=ExpressionParsing::NoLoaderFunc)
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
ToolHandle< Trig::TrigDecisionTool >	m_trigDecisionTool
	The trigger decision tool.
ExpressionParsing::SGxAODProxyLoader *	m_xAODProxyLoader
	The expression parser.
std::unique_ptr< ExpressionParsing::IProxyLoader >	m_proxyLoaders
std::conditional< NUM_PARSER==1, std::unique_ptr< ExpressionParsing::ExpressionParser >, std::array< std::unique_ptr< ExpressionParsing::ExpressionParser >, NUM_PARSER > >::type	m_parser
std::vector< std::string >	m_renounce

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StringProperty	m_cut {this, "Cut", "", "The cut expression"}
	The cut string.
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 22 of file CutTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ CutTool()

CutTool::CutTool	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Constructor with parameters:

Definition at line 28 of file CutTool.cxx.

                                             :
  ExpressionParserUserWithTrigSupport<::AthAlgTool>  ( type, name, parent )
{
  declareInterface< DerivationFramework::ISkimmingTool >(this);
}

◆ ~CutTool()

CutTool::~CutTool ( )

virtual

Destructor:

Definition at line 38 of file CutTool.cxx.

39{}

Member Function Documentation

◆ _initializeParser()

StatusCode ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::_initializeParser	(	const ExpressionParsing::SelectionArg< NUM_PARSER > &	selection_string,
		ExpressionParsing::AppendLoaderFunc	pre_xaod_loader = ExpressionParsing::NoLoaderFunc,
		ExpressionParsing::AppendLoaderFunc	post_xaod_loader = ExpressionParsing::NoLoaderFunc )

protectedinherited

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

◆ DeclareInterfaceID()

DerivationFramework::ISkimmingTool::DeclareInterfaceID	(	ISkimmingTool	,
		1	,
		0	)

inherited

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ eventPassesFilter()

bool CutTool::eventPassesFilter ( ) const

finaloverridevirtual

Implement the method from the ISkimmingTool interface.

Implements DerivationFramework::ISkimmingTool.

Definition at line 69 of file CutTool.cxx.

{
  ATH_MSG_DEBUG ( "==> eventPassesFilter() " << name()  );
  ATH_MSG_VERBOSE ( "Dumping event store: " << evtStore()->dump() );
 
  return (m_parser ? m_parser->evaluateAsBool() : true);
}

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode CutTool::finalize ( )

overridevirtual

Athena algtool's finalize.

Definition at line 58 of file CutTool.cxx.

{
  ATH_MSG_DEBUG ("Finalizing " << name() << "...");
 
  ATH_CHECK( finalizeParser() );
  return StatusCode::SUCCESS;
}

◆ finalizeParser()

StatusCode ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::finalizeParser ( )

inherited

◆ initialize()

StatusCode CutTool::initialize ( )

overridevirtual

Athena algtool's initialize.

Definition at line 45 of file CutTool.cxx.

{
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
 
  if (!m_cut.value().empty()) {
     ATH_CHECK( initializeParser(m_cut.value()) );
  }
 
  return StatusCode::SUCCESS;
}

◆ initializeParser()

StatusCode ExpressionParserUserWithTrigSupport< ::AthAlgTool, 1 >::initializeParser ( ExpressionParsing::SelectionArg< 1 > selection_string )

inlineinherited

Definition at line 25 of file ExpressionParserUserWithTrigSupport.h.

                                                                                           {
      return this->_initializeParser(selection_string,
                                     [this](ExpressionParsing::MultipleProxyLoader &proxy_loaders) -> StatusCode {
                                        // initialise TDT explicitly, needed for the tool to properly work with trigger decisions in AthAnalysisBase (until fixed)
                                        if( !this->m_trigDecisionTool.empty() ) {
                                           StatusCode sc = this->m_trigDecisionTool.retrieve();
                                           if (sc.isFailure()) return sc;
                                           proxy_loaders.push_back(std::make_unique<ExpressionParsing::TriggerDecisionProxyLoader>(this->m_trigDecisionTool));
                                        }
                                        else {
                                           this->m_trigDecisionTool.disable();
                                        }
                                        return StatusCode::SUCCESS;
                                     },
                                     [this](ExpressionParsing::MultipleProxyLoader &proxy_loaders) -> StatusCode {
                                       proxy_loaders.push_back(std::make_unique<ExpressionParsing::SGNTUPProxyLoader>(this->evtStore()));
                                        return StatusCode::SUCCESS;
                                     });
   }

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ renounceInput()

virtual bool ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::renounceInput ( const DataObjID & output_data_id )

overridevirtualinherited

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateDataNeeds()

virtual bool ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::updateDataNeeds	(	const std::vector< const DataObjID * > &	input_data_in,
		const std::vector< const DataObjID * > &	output_data_in,
		std::vector< Gaudi::DataHandle * > &	new_input_handles,
		std::vector< Gaudi::DataHandle * > &	new_output_handles )

overridevirtualinherited

Inform a dynamic data consumer about all consumed or produced data.

Parameters

input_data_in	the input data object IDs of all algorithms and tools
output_data_in	the output data object IDs of all algorithms and tools
new_input_handles	the new input data handles added by this call
new_output_handles	the new output data handles added by this call

Returns: true if the consumer did update its handles, false otherwise

Implements IDynamicDataConsumer.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_cut

StringProperty CutTool::m_cut {this, "Cut", "", "The cut expression"}

private

The cut string.

Definition at line 58 of file CutTool.h.

58{this, "Cut", "", "The cut expression"};

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_parser

std::conditional<NUM_PARSER==1,std::unique_ptr<ExpressionParsing::ExpressionParser>,std::array<std::unique_ptr<ExpressionParsing::ExpressionParser>,NUM_PARSER>>::type ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::m_parser

protectedinherited

Definition at line 100 of file ExpressionParserUser.h.

◆ m_proxyLoaders

std::unique_ptr<ExpressionParsing::IProxyLoader> ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::m_proxyLoaders

protectedinherited

Definition at line 97 of file ExpressionParserUser.h.

◆ m_renounce

std::vector<std::string> ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::m_renounce

protectedinherited

Definition at line 102 of file ExpressionParserUser.h.

◆ m_trigDecisionTool

ToolHandle<Trig::TrigDecisionTool> ExpressionParserUserWithTrigSupport< ::AthAlgTool, 1 >::m_trigDecisionTool

protectedinherited

The trigger decision tool.

Definition at line 46 of file ExpressionParserUserWithTrigSupport.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ m_xAODProxyLoader

ExpressionParsing::SGxAODProxyLoader* ExpressionParserUserBase< ::AthAlgTool, NUM_PARSER >::m_xAODProxyLoader

protectedinherited

The expression parser.

Definition at line 96 of file ExpressionParserUser.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CutTool()

◆ ~CutTool()

Member Function Documentation

◆ _initializeParser()

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ eventPassesFilter()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ finalizeParser()

◆ initialize()

◆ initializeParser()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ renounceInput()

◆ sysInitialize()

◆ sysStart()

◆ updateDataNeeds()

◆ updateVHKA()

Member Data Documentation

◆ m_cut

◆ m_detStore

◆ m_evtStore

◆ m_parser

◆ m_proxyLoaders

◆ m_renounce

◆ m_trigDecisionTool

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_xAODProxyLoader