The Gaudi Framework  master (37c0b60a)
IHiveWhiteBoard.h
Go to the documentation of this file.
1 /***********************************************************************************\
2 * (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
3 * *
4 * This software is distributed under the terms of the Apache version 2 licence, *
5 * copied verbatim in the file "LICENSE". *
6 * *
7 * In applying this licence, CERN does not waive the privileges and immunities *
8 * granted to it by virtue of its status as an Intergovernmental Organization *
9 * or submit itself to any jurisdiction. *
10 \***********************************************************************************/
11 #ifndef GAUDIKERNEL_IHIVEWHITEBOARD_H
12 #define GAUDIKERNEL_IHIVEWHITEBOARD_H
13 
14 // Framework include files
15 #include <GaudiKernel/DataObjID.h>
16 #include <GaudiKernel/IInterface.h>
17 
18 // C++ include files
19 #include <string>
20 
27 class GAUDI_API IHiveWhiteBoard : public extend_interfaces<IInterface> {
28 public:
31 
38  virtual StatusCode selectStore( size_t partitionIndex ) = 0;
39 
45  virtual StatusCode clearStore( size_t partitionIndex ) = 0;
46 
52  virtual StatusCode setNumberOfStores( size_t slots ) = 0;
53 
58  virtual size_t getNumberOfStores() const = 0;
59 
66  virtual bool exists( const DataObjID& ) = 0;
67 
73  virtual size_t allocateStore( int evtnumber ) = 0;
74 
80  virtual StatusCode freeStore( size_t partitionIndex ) = 0;
81 
87  virtual size_t getPartitionNumber( int eventnumber ) const = 0;
88 
90  virtual size_t freeSlots() = 0;
91 };
92 #endif // GAUDIKERNEL_IHIVEWHITEBOARD_H
IHiveWhiteBoard::allocateStore
virtual size_t allocateStore(int evtnumber)=0
Allocate a store partition for new event.
IHiveWhiteBoard::getPartitionNumber
virtual size_t getPartitionNumber(int eventnumber) const =0
Get the partition number corresponding to a given event.
IHiveWhiteBoard::clearStore
virtual StatusCode clearStore(size_t partitionIndex)=0
Clear an given 'slot'.
IHiveWhiteBoard::freeSlots
virtual size_t freeSlots()=0
Get free slots number.
IHiveWhiteBoard::selectStore
virtual StatusCode selectStore(size_t partitionIndex)=0
Activate an given 'slot' for all subsequent calls within the same thread id.
IHiveWhiteBoard
Definition: IHiveWhiteBoard.h:27
DataObjID.h
extend_interfaces
Base class to be used to extend an interface.
Definition: extend_interfaces.h:15
IHiveWhiteBoard::exists
virtual bool exists(const DataObjID &)=0
Check if a data object exists in store.
StatusCode
Definition: StatusCode.h:65
IInterface.h
IHiveWhiteBoard::DeclareInterfaceID
DeclareInterfaceID(IHiveWhiteBoard, 2, 0)
InterfaceID.
IHiveWhiteBoard::freeStore
virtual StatusCode freeStore(size_t partitionIndex)=0
Free a store partition.
DataObjID
Definition: DataObjID.h:47
IHiveWhiteBoard::getNumberOfStores
virtual size_t getNumberOfStores() const =0
Get the number of 'slots'.
IHiveWhiteBoard::setNumberOfStores
virtual StatusCode setNumberOfStores(size_t slots)=0
Set the number of 'slots'.
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:81