| The Gaudi Framework v32r1 (f65d50dc)

KeyedTraits.h
Go to the documentation of this file.
1 #ifndef GAUDIKERNEL_KEYEDTRAITS_H
2 #define GAUDIKERNEL_KEYEDTRAITS_H
3
4 #define CHECK_KEYED_CONTAINER
5
6 // Include files
7 #include "GaudiKernel/Kernel.h" // GAUDI_API
8 #include <vector>
9
10 // Forward declarations
11 template <class K>
12 class KeyedObject;
13 template <class T, class M>
14 class KeyedContainer;
15
16 /*
17 Namespace for Key classes used by the Keyed Container
18 */
19 namespace Containers {
20
21 // Status enumeration
22 enum {
23 OBJ_NOT_FOUND,
24 OBJ_DELETED,
25 OBJ_ERASED,
26 OBJ_INSERTED,
27 OBJ_CANNOT_INSERT
28 };
29
30 // Forward declarations
31
33 template <class CONTAINER, class DATATYPE>
34 struct traits;
36 template <class KEY>
37 struct key_traits;
39 template <class SETUP>
40 class KeyedObjectManager;
41
44 GAUDI_API void cannotInsertToContainer();
45
48 GAUDI_API void containerIsInconsistent();
49
53 GAUDI_API void invalidContainerOperation();
54
56 GAUDI_API void cannotAssignObjectKey();
57
69 template <class KEY>
70 struct key_traits {
72 typedef KEY key_type;
74 typedef KeyedObject<key_type> obj_type;
79 static key_type makeKey( long k ) { return key_type( k ); }
80 static key_type makeKey( int k ) { return key_type( k ); }
82 static long identifier( const key_type& k ) { return k; }
84 static long hash( const key_type& key_value ) { return key_value; }
86 static void setKey( obj_type* v, const key_type& k ) {
87 if ( v ) v->setKey( k );
88 }
93 static bool checkKey( obj_type* v, const key_type& k ) {
94 #ifdef CHECK_KEYED_CONTAINER
95 return ( v ) ? ( hash( v->key() ) == hash( k ) ) : false;
96 #else
97 return true;
98 #endif
99 }
101 static long addRef( obj_type* v ) { return ( v ) ? v->addRef() : 0; }
103 static long release( obj_type* v ) { return ( v ) ? v->release() : 0; }
104 };
105
114 template <class CONTAINER, class DATATYPE>
115 struct traits : public key_traits<typename DATATYPE::key_type> {
117 static bool checkBounds( const std::vector<DATATYPE*>* cnt, const typename DATATYPE::key_type& k ) {
118 #ifdef CHECK_KEYED_CONTAINER
119 return size_t( cnt->size() ) > size_t( traits::hash( k ) );
120 #else
121 return true;
122 #endif
123 }
124 };
125 } // namespace Containers
126 #endif // GAUDIKERNEL_KEYEDTRAITS_H
Kernel.h
Containers::key_traits::addRef
static long addRef(obj_type *v)
Add reference counter to object when inserted into the container.
Definition: KeyedTraits.h:101
Containers::traits
Container traits class.
Definition: KeyedTraits.h:34
Containers::key_traits::makeKey
static key_type makeKey(int k)
Definition: KeyedTraits.h:80
Containers::traits::checkBounds
static bool checkBounds(const std::vector< DATATYPE * > *cnt, const typename DATATYPE::key_type &k)
Allow to check the access to container elements for consistency.
Definition: KeyedTraits.h:117
KeyedObject
Definition of the templated KeyedObject class.
Definition: KeyedObject.h:29
Containers::containerIsInconsistent
GAUDI_API void containerIsInconsistent()
Function to be called to indicate that the container is found to be inconsistent.
Definition: KeyedObjectManager.cpp:77
Containers::OBJ_NOT_FOUND
Object not present in the container.
Definition: KeyedTraits.h:23
KeyedContainer
template class KeyedContainer, KeyedContainer.h
Definition: KeyedContainer.h:64
Containers::key_traits::checkKey
static bool checkKey(obj_type *v, const key_type &k)
Check the validity of the object's key.
Definition: KeyedTraits.h:93
Containers::key_traits::makeKey
static key_type makeKey(long k)
Create key from its full integer representation.
Definition: KeyedTraits.h:79
Containers::key_traits
Key traits class.
Definition: KeyedTraits.h:37
Containers
Containers namespace.
Definition: KeyedObjectManager.h:18
Containers::OBJ_INSERTED
Object was inserted into the container.
Definition: KeyedTraits.h:26
Containers::key_traits::obj_type
KeyedObject< key_type > obj_type
Declaration of keyed object type.
Definition: KeyedTraits.h:74
Containers::cannotInsertToContainer
GAUDI_API void cannotInsertToContainer()
Function to be called to indicate that an object cannot be inserted to the container.
Definition: KeyedObjectManager.cpp:73
KeyedObject::setKey
void setKey(const key_type &key)
Set object key.
Definition: KeyedObject.h:122
Containers::key_traits::key_type
KEY key_type
Declaration of key-type.
Definition: KeyedTraits.h:72
Containers::key_traits::hash
static long hash(const key_type &key_value)
Hash function for this key.
Definition: KeyedTraits.h:84
Containers::invalidContainerOperation
GAUDI_API void invalidContainerOperation()
Function to be called to indicate that an operation should be performed on the container or it's cont...
Definition: KeyedObjectManager.cpp:82
KeyedObject::addRef
unsigned long addRef()
Add reference to object (Increase reference counter).
Definition: KeyedObject.h:105
Containers::OBJ_ERASED
Object was removed, but not deleted.
Definition: KeyedTraits.h:25
KeyedObject::release
unsigned long release()
Release reference. If the reference count is ZERO, delete the object.
Definition: KeyedObject.h:111
Containers::key_traits::identifier
static long identifier(const key_type &k)
Full unhashed key identifier.
Definition: KeyedTraits.h:82
std::vector::size
T size(T... args)
std::vector
STL class.
Containers::cannotAssignObjectKey
GAUDI_API void cannotAssignObjectKey()
Function to be called when an object key cannot be assigned.
Definition: KeyedObjectManager.cpp:69
Containers::OBJ_CANNOT_INSERT
Cannot insert object into container.
Definition: KeyedTraits.h:27
Containers::KeyedObjectManager
KeyedObjectManager Class to manage keyed objects.
Definition: KeyedObjectManager.h:45
Containers::key_traits::release
static long release(obj_type *v)
Release reference to object.
Definition: KeyedTraits.h:103
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:71
KeyedObject::key
const key_type & key() const
Retrieve Key of the object.
Definition: KeyedObject.h:72
Containers::OBJ_DELETED
Object was removed from the container and deleted.
Definition: KeyedTraits.h:24
Containers::key_traits::setKey
static void setKey(obj_type *v, const key_type &k)
Set object key when inserted into the container.
Definition: KeyedTraits.h:86