Skip to content

Commit

Permalink
Add docstrings for get and set of the MetaDataHandle
Browse files Browse the repository at this point in the history
  • Loading branch information
tmadlener committed May 28, 2024
1 parent 976edef commit 16e7c35
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions k4FWCore/include/k4FWCore/MetaDataHandle.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,22 @@ template <typename T> class MetaDataHandle {
MetaDataHandle(const Gaudi::DataHandle& handle, const std::string& descriptor, Gaudi::DataHandle::Mode a);
~MetaDataHandle();

/// Get the (optional) value that is stored in this MetaDataHandle
///
/// @returns A std::optional that is engaged if the value was available as
/// metadata
const auto get() const;
void put(T);

/// Set the value for this MetaDataHandle
///
/// @note This can only be called during initalize and/or finalize but not
/// during execute for algorithms that use it
void put(T);

private:
std::string fullDescriptor() const;
void checkPodioDataSvc();

void checkPodioDataSvc();

private:
ServiceHandle<IDataProviderSvc> m_eds;
Expand Down

0 comments on commit 16e7c35

Please sign in to comment.