KeyedTraits.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#ifndef GAUDIKERNEL_KEYEDTRAITS_H
#define GAUDIKERNEL_KEYEDTRAITS_H
 
#define CHECK_KEYED_CONTAINER
 
// Include files
#include <GaudiKernel/Kernel.h> // GAUDI_API
#include <vector>
 
// Forward declarations
template <class K>
class KeyedObject;
template <class T, class M>
class KeyedContainer;
 
/*
  Namespace for Key classes used by the Keyed Container
*/
namespace Containers {
 
  // Status enumeration
  enum {
    OBJ_NOT_FOUND,    
    OBJ_DELETED,      
    OBJ_ERASED,       
    OBJ_INSERTED,     
    OBJ_CANNOT_INSERT 
  };
 
  // Forward declarations
 
  template <class CONTAINER, class DATATYPE>
  struct traits;
  template <class KEY>
  struct key_traits;
  template <class SETUP>
  class KeyedObjectManager;
 
  GAUDI_API void cannotInsertToContainer();
 
  GAUDI_API void containerIsInconsistent();
 
  GAUDI_API void invalidContainerOperation();
 
  GAUDI_API void cannotAssignObjectKey();
 
  template <class KEY>
  struct key_traits {
    typedef KEY key_type;
    typedef KeyedObject<key_type> obj_type;
    static key_type makeKey( long k ) { return key_type( k ); }
    static key_type makeKey( int k ) { return key_type( k ); }
    static long identifier( const key_type& k ) { return k; }
    static long hash( const key_type& key_value ) { return key_value; }
    static void setKey( obj_type* v, const key_type& k ) {
      if ( v ) v->setKey( k );
    }
    static bool checkKey( obj_type* v, const key_type& k ) {
#ifdef CHECK_KEYED_CONTAINER
      return ( v ) ? ( hash( v->key() ) == hash( k ) ) : false;
#else
      return true;
#endif
    }
    static long addRef( obj_type* v ) { return ( v ) ? v->addRef() : 0; }
    static long release( obj_type* v ) { return ( v ) ? v->release() : 0; }
  };
 
  template <class CONTAINER, class DATATYPE>
  struct traits : public key_traits<typename DATATYPE::key_type> {
    static bool checkBounds( const std::vector<DATATYPE*>* cnt, const typename DATATYPE::key_type& k ) {
#ifdef CHECK_KEYED_CONTAINER
      return size_t( cnt->size() ) > size_t( traits::hash( k ) );
#else
      return true;
#endif
    }
  };
} // namespace Containers
#endif // GAUDIKERNEL_KEYEDTRAITS_H