ATLAS Offline Software
Toggle main menu visibility
Loading...
Searching...
No Matches
Control
AthenaBaseComps
AthenaBaseComps
AthCommonAlgorithm.h
Go to the documentation of this file.
1
2
3
/*
4
Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
5
*/
6
7
// AthCommonAlgorithm.h
8
// Header file for class AthCommonAlgorithm
9
// Author: Charles Leggett
11
#ifndef ATHENABASECOMPS_ATHCOMMONALGORITHM_H
12
#define ATHENABASECOMPS_ATHCOMMONALGORITHM_H
13
14
15
// STL includes
16
#include <string>
17
#include <type_traits>
18
19
#include "
AthenaBaseComps/AthCommonDataStore.h
"
20
#include "
AthenaBaseComps/AthCommonMsg.h
"
21
#include "
AthenaBaseComps/AthCheckMacros.h
"
22
#include "
AthenaBaseComps/AthMemMacros.h
"
23
24
25
#include "Gaudi/Algorithm.h"
26
27
35
template
<
class
BaseAlg>
36
class
AthCommonAlgorithm
37
:
public
AthCommonDataStore
<AthCommonMsg<BaseAlg>>
38
{
40
// Public methods:
42
public
:
43
using
BaseAlg::execState;
44
using
BaseAlg::name;
45
using
BaseAlg::m_updateDataHandles;
46
using
BaseAlg::outputHandles;
47
49
AthCommonAlgorithm
(
const
std::string& name, ISvcLocator* pSvcLocator);
50
52
virtual
~AthCommonAlgorithm
()
override
=
default
;
53
54
60
virtual
StatusCode
sysInitialize
()
override
;
61
62
68
virtual
bool
isClonable
()
const override
{
69
return
true
;
70
}
71
72
80
virtual
StatusCode
sysExecute
(
const
EventContext& ctx)
override
;
81
82
89
virtual
const
DataObjIDColl&
extraOutputDeps
()
const override
;
90
91
93
virtual
bool
filterPassed
(
const
EventContext& ctx)
const
{
94
return
execState( ctx ).filterPassed();
95
}
96
97
99
virtual
void
setFilterPassed
(
bool
state,
const
EventContext& ctx )
const
{
100
execState( ctx ).setFilterPassed( state );
101
}
102
103
104
private
:
105
108
DataObjIDColl
m_extendedExtraObjects
;
109
110
};
111
112
#endif
AthCheckMacros.h
AthCommonDataStore.h
Templated class that provides access to Athena event stores and ability to set data dependencies via ...
AthCommonMsg.h
Templated class that provides backwards compatibility for legacy MsgService manipulation methods.
AthMemMacros.h
AthCommonAlgorithm::filterPassed
virtual bool filterPassed(const EventContext &ctx) const
Get filter decision:
Definition
AthCommonAlgorithm.h:93
AthCommonAlgorithm::setFilterPassed
virtual void setFilterPassed(bool state, const EventContext &ctx) const
Set filter decision:
Definition
AthCommonAlgorithm.h:99
AthCommonAlgorithm::isClonable
virtual bool isClonable() const override
Specify if the algorithm is clonable.
Definition
AthCommonAlgorithm.h:68
AthCommonAlgorithm::AthCommonAlgorithm
AthCommonAlgorithm(const std::string &name, ISvcLocator *pSvcLocator)
Constructor with parameters:
Definition
AthCommonAlgorithm.cxx:17
AthCommonAlgorithm::extraOutputDeps
virtual const DataObjIDColl & extraOutputDeps() const override
Return the list of extra output dependencies.
Definition
AthCommonAlgorithm.cxx:53
AthCommonAlgorithm::sysExecute
virtual StatusCode sysExecute(const EventContext &ctx) override
Execute an algorithm.
Definition
AthCommonAlgorithm.cxx:40
AthCommonAlgorithm::~AthCommonAlgorithm
virtual ~AthCommonAlgorithm() override=default
Destructor:
AthCommonAlgorithm::m_extendedExtraObjects
DataObjIDColl m_extendedExtraObjects
Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
Definition
AthCommonAlgorithm.h:108
AthCommonAlgorithm::sysInitialize
virtual StatusCode sysInitialize() override
Override sysInitialize.
Definition
AthCommonAlgorithm.cxx:71
AthCommonDataStore< AthCommonMsg< BaseAlg > >::AthCommonDataStore
AthCommonDataStore(const std::string &name, T... args)
Definition
AthCommonDataStore.h:55
Generated on
for ATLAS Offline Software by
1.17.0