ATLAS Offline Software
Public Member Functions | Static Public Member Functions | List of all members
IIOVDbMetaDataTool Class Referenceabstract

This is an interface to a tool used to manage the IOV Meta Data for a given object in the MetaData Store. More...

#include <IIOVDbMetaDataTool.h>

Inheritance diagram for IIOVDbMetaDataTool:
Collaboration diagram for IIOVDbMetaDataTool:

Public Member Functions

virtual StatusCode registerFolder (const std::string &folderName, const std::string &folderDescription) const =0
 Register folder in the IOV Db MetaData. More...
 
virtual StatusCode registerFolder (const std::string &folderName) const =0
 Register folder in the IOV Db MetaData without folder description - uses default folder description for CondAttrListCollection. More...
 
virtual StatusCode addPayload (const std::string &folderName, CondAttrListCollection *payload) const =0
 Add an IOV and Payload for a particular folder - replaces payloads if there is an IOV overlap. More...
 
virtual StatusCode processInputFileMetaData (const std::string &fileName)=0
 Explicit call to process IOV meta data from the input meta data store, transferring it to the main meta data store. More...
 
virtual IOVMetaDataContainerfindMetaDataContainer (const std::string &folderName) const =0
 
virtual StatusCode beginInputFile (const SG::SourceID &sid="Serial")=0
 Function called when a new input file is opened. More...
 
virtual StatusCode endInputFile (const SG::SourceID &sid="Serial")=0
 Function called when the currently open input file got completely processed. More...
 
virtual StatusCode metaDataStop ()=0
 Function called when the tool should prepare to write its metadata. More...
 
virtual void lock_shared () const =0
 Lock the tool. More...
 
virtual void unlock_shared () const =0
 Unlock the tool. More...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 Retrieve interface ID. More...
 

Detailed Description

This is an interface to a tool used to manage the IOV Meta Data for a given object in the MetaData Store.

Properties:

Definition at line 42 of file IIOVDbMetaDataTool.h.

Member Function Documentation

◆ addPayload()

virtual StatusCode IIOVDbMetaDataTool::addPayload ( const std::string &  folderName,
CondAttrListCollection payload 
) const
pure virtual

Add an IOV and Payload for a particular folder - replaces payloads if there is an IOV overlap.

Implemented in IOVDbMetaDataTool.

◆ beginInputFile()

virtual StatusCode IMetaDataTool::beginInputFile ( const SG::SourceID sid = "Serial")
pure virtualinherited

◆ endInputFile()

virtual StatusCode IMetaDataTool::endInputFile ( const SG::SourceID sid = "Serial")
pure virtualinherited

◆ findMetaDataContainer()

virtual IOVMetaDataContainer* IIOVDbMetaDataTool::findMetaDataContainer ( const std::string &  folderName) const
pure virtual

Implemented in IOVDbMetaDataTool.

◆ interfaceID()

static const InterfaceID& IIOVDbMetaDataTool::interfaceID ( )
inlinestatic

Retrieve interface ID.

Definition at line 49 of file IIOVDbMetaDataTool.h.

49  {
50  static const InterfaceID IID_IIOVDbMetaDataTool("IIOVDbMetadataTool", 1 , 0);
51  return IID_IIOVDbMetaDataTool; }

◆ lock_shared()

virtual void ILockableTool::lock_shared ( ) const
pure virtualinherited

Lock the tool.

Implemented in IOVDbMetaDataTool.

◆ metaDataStop()

virtual StatusCode IMetaDataTool::metaDataStop ( )
pure virtualinherited

◆ processInputFileMetaData()

virtual StatusCode IIOVDbMetaDataTool::processInputFileMetaData ( const std::string &  fileName)
pure virtual

Explicit call to process IOV meta data from the input meta data store, transferring it to the main meta data store.

Normally, this method is called at the BeginInputFile incident. However, this explicit call allows the transfer to occur during the initialization phase, which occurs before BeginInputFile incident.

Implemented in IOVDbMetaDataTool.

◆ registerFolder() [1/2]

virtual StatusCode IIOVDbMetaDataTool::registerFolder ( const std::string &  folderName) const
pure virtual

Register folder in the IOV Db MetaData without folder description - uses default folder description for CondAttrListCollection.

Implemented in IOVDbMetaDataTool.

◆ registerFolder() [2/2]

virtual StatusCode IIOVDbMetaDataTool::registerFolder ( const std::string &  folderName,
const std::string &  folderDescription 
) const
pure virtual

Register folder in the IOV Db MetaData.

Implemented in IOVDbMetaDataTool.

◆ unlock_shared()

virtual void ILockableTool::unlock_shared ( ) const
pure virtualinherited

Unlock the tool.

Implemented in IOVDbMetaDataTool.


The documentation for this class was generated from the following file: