Skip to content

Commit

Permalink
Update include/podio/detail/OrderKey.h
Browse files Browse the repository at this point in the history
Co-authored-by: Thomas Madlener <[email protected]>
  • Loading branch information
m-fila and tmadlener authored Dec 3, 2024
1 parent 50036ea commit d41f022
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions include/podio/detail/OrderKey.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
#define PODIO_DETAIL_ORDERKEY_H
#include <functional>
namespace podio::detail {
// Internal class allowing datatype objects to be placed in data structures like maps and sets by providing a way to
// compare them. The comparison is based on addresses of their internal data objects.
//
// This class is intended to be used as the return value of internal `podio::detail::getOrderKey` free functions. These
// functions are friends of each datatype, allowing them to access the internal data objects and define less-than
// comparison operators for both datatypes and interface types.
//
// The friend free function design is used in order to reduce the coupling between interfaces and datatypes. Interfaces
// do not need to be friends of datatypes to define the less-than comparison operator, which allows using datatypes from
// different datamodels in an interface type.
/// Internal class allowing datatype objects to be placed in data structures like maps and sets by providing a way to
/// compare them. The comparison is based on addresses of their internal data objects.
///
/// This class is intended to be used as the return value of internal `podio::detail::getOrderKey` free functions. These
/// functions are friends of each datatype, allowing them to access the internal data objects and define less-than
/// comparison operators for both datatypes and interface types.
///
/// The friend free function design is used in order to reduce the coupling between interfaces and datatypes. Interfaces
/// do not need to be friends of datatypes to define the less-than comparison operator, which allows using datatypes from
/// different datamodels in an interface type.
class OrderKey {
public:
OrderKey(void* orderKey) noexcept : m_orderKey(orderKey) {
Expand Down

0 comments on commit d41f022

Please sign in to comment.