Skip to content

Commit

Permalink
Add note about podio versoin dependency for return type
Browse files Browse the repository at this point in the history
  • Loading branch information
tmadlener committed May 28, 2024
1 parent 16e7c35 commit 6160986
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions k4FWCore/include/k4FWCore/MetaDataHandle.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,14 @@ template <typename T> class 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
/// @note The return type of this changes depending on the podio version that
/// has been used to build k4FWCore. For pre 1.0 versions of podio this will
/// return a default initialized (empty) value in case the underlying
/// parameter could not obtained be. For later podio versions this will return
/// a std::optional.
///
/// @returns Either the (potentially default initialized) value or a
/// std::optional that is engaged in case the value is available as metadata
const auto get() const;

/// Set the value for this MetaDataHandle
Expand Down

0 comments on commit 6160986

Please sign in to comment.