The Gaudi Framework
master (d98a2936)
DataObjectHandleBase.h
Go to the documentation of this file.
1
/***********************************************************************************\
2
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
3
* *
4
* This software is distributed under the terms of the Apache version 2 licence, *
5
* copied verbatim in the file "LICENSE". *
6
* *
7
* In applying this licence, CERN does not waive the privileges and immunities *
8
* granted to it by virtue of its status as an Intergovernmental Organization *
9
* or submit itself to any jurisdiction. *
10
\***********************************************************************************/
11
#pragma once
12
13
#include <mutex>
14
15
#include <
GaudiKernel/DataHandle.h
>
16
#include <
GaudiKernel/IDataProviderSvc.h
>
17
#include <
GaudiKernel/IMessageSvc.h
>
18
#include <
GaudiKernel/IProperty.h
>
19
#include <
GaudiKernel/SmartIF.h
>
20
21
//---------------------------------------------------------------------------
22
32
//---------------------------------------------------------------------------
33
34
class
DataObjectHandleBase
:
public
Gaudi::DataHandle
{
35
36
public
:
37
DataObjectHandleBase
(
DataObjID
k,
Gaudi::DataHandle::Mode
a,
IDataHandleHolder
*
owner
);
38
DataObjectHandleBase
( std::string k,
Gaudi::DataHandle::Mode
a,
IDataHandleHolder
*
owner
);
39
40
~DataObjectHandleBase
()
override
;
41
DataObjectHandleBase
(
const
DataObjectHandleBase
& ) =
delete
;
42
DataObjectHandleBase
(
DataObjectHandleBase
&& );
43
DataObjectHandleBase
&
operator=
(
const
DataObjectHandleBase
& );
44
47
template
<std::derived_from<IProperty> OWNER,
class
K>
48
inline
DataObjectHandleBase
( OWNER*
owner
,
Gaudi::DataHandle::Mode
m
, std::string
name
, K
key
= {},
49
std::string doc =
""
)
50
:
DataObjectHandleBase
( std::move(
key
),
m
,
owner
) {
51
auto
p =
owner
->declareProperty( std::move(
name
), *
this
, std::move( doc ) );
52
p->template setOwnerType<OWNER>();
53
}
54
55
friend
std::ostream&
operator<<
( std::ostream& str,
const
DataObjectHandleBase
& d );
56
58
bool
isOptional
()
const
{
return
m_optional
; }
59
void
setOptional
(
bool
optional =
true
) {
m_optional
= optional; }
60
61
bool
isValid
()
const
;
62
63
protected
:
64
bool
init
()
override
;
65
66
DataObject
*
fetch
()
const
;
67
68
protected
:
69
SmartIF<IDataProviderSvc>
m_EDS
;
70
SmartIF<IMessageSvc>
m_MS
;
71
72
bool
m_init
=
false
;
73
bool
m_optional
=
false
;
74
};
IDataHandleHolder
Definition:
IDataHandleHolder.h:23
DataObjectHandleBase::m_EDS
SmartIF< IDataProviderSvc > m_EDS
Definition:
DataObjectHandleBase.h:69
DataObjectHandleBase::m_MS
SmartIF< IMessageSvc > m_MS
Definition:
DataObjectHandleBase.h:70
DataObjectHandleBase::setOptional
void setOptional(bool optional=true)
Definition:
DataObjectHandleBase.h:59
DataObjectHandleBase::m_optional
bool m_optional
Definition:
DataObjectHandleBase.h:73
Gaudi::DataHandle
Definition:
DataHandle.h:37
DataObjectHandleBase::operator=
DataObjectHandleBase & operator=(const DataObjectHandleBase &)
Definition:
DataObjectHandleBase.cpp:36
IMessageSvc.h
IDataProviderSvc.h
DataObjectHandleBase::isOptional
bool isOptional() const
Check if the data object declared is optional for the algorithm.
Definition:
DataObjectHandleBase.h:58
SmartIF.h
Gaudi::DataHandle::owner
virtual IDataHandleHolder * owner() const
Definition:
DataHandle.h:52
DataObjectHandleBase::m_init
bool m_init
Definition:
DataObjectHandleBase.h:72
Gaudi::Units::m
constexpr double m
Definition:
SystemOfUnits.h:107
DataObjectHandleBase::DataObjectHandleBase
DataObjectHandleBase(const DataObjectHandleBase &)=delete
DataObjectHandleBase
DataObjectHandleBase GaudiKernel/DataObjectHandleBase.h.
Definition:
DataObjectHandleBase.h:34
SmartIF< IDataProviderSvc >
DataObjID
Definition:
DataObjID.h:47
DataObjectHandleBase::fetch
DataObject * fetch() const
Definition:
DataObjectHandleBase.cpp:61
Gaudi::DataHandle::Mode
Mode
Definition:
DataHandle.h:39
ConditionsStallTest.name
name
Definition:
ConditionsStallTest.py:77
DataObjectHandleBase::operator<<
friend std::ostream & operator<<(std::ostream &str, const DataObjectHandleBase &d)
Definition:
DataObjectHandleBase.cpp:104
DataObject
Definition:
DataObject.h:37
DataHandle.h
DataObjectHandleBase::~DataObjectHandleBase
~DataObjectHandleBase() override
Definition:
DataObjectHandleBase.cpp:58
DataObjectHandleBase::DataObjectHandleBase
DataObjectHandleBase(DataObjID k, Gaudi::DataHandle::Mode a, IDataHandleHolder *owner)
Definition:
DataObjectHandleBase.cpp:47
IProperty.h
DataObjectHandleBase::isValid
bool isValid() const
Definition:
DataObjectHandleBase.cpp:100
ProduceConsume.key
key
Definition:
ProduceConsume.py:84
DataObjectHandleBase::DataObjectHandleBase
DataObjectHandleBase(OWNER *owner, Gaudi::DataHandle::Mode m, std::string name, K key={}, std::string doc="")
Autodeclaring constructor with property name, mode, key and documentation.
Definition:
DataObjectHandleBase.h:48
DataObjectHandleBase::init
bool init() override
Definition:
DataObjectHandleBase.cpp:75
GaudiKernel
include
GaudiKernel
DataObjectHandleBase.h
Generated on Wed Aug 13 2025 09:05:03 for The Gaudi Framework by
1.8.18