ATLAS Offline Software
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
IAthenaPoolCnvSvc Class Referenceabstract

This class provides the interface between Athena and PoolSvc. More...

#include <IAthenaPoolCnvSvc.h>

Inheritance diagram for IAthenaPoolCnvSvc:
Collaboration diagram for IAthenaPoolCnvSvc:

Public Member Functions

virtual ~IAthenaPoolCnvSvc ()
 
virtual StatusCode disconnectOutput (const std::string &outputConnectionSpec)=0
 Disconnect to the output connection. More...
 
virtual IPoolSvcgetPoolSvc ()=0
 
virtual TokenregisterForWrite (Placement *placement, const void *obj, const RootType &classDesc)=0
 
virtual void setObjPtr (void *&obj, const Token *token)=0
 
virtual bool useDetailChronoStat () const =0
 
virtual StatusCode createAddress (long svcType, const CLID &clid, const std::string *par, const unsigned long *ip, IOpaqueAddress *&refpAddress)=0
 Create a Generic address using explicit arguments to identify a single object. More...
 
virtual StatusCode createAddress (long svcType, const CLID &clid, const std::string &refAddress, IOpaqueAddress *&refpAddress)=0
 Create address from string form. More...
 
virtual StatusCode convertAddress (const IOpaqueAddress *pAddress, std::string &refAddress)=0
 Convert address to string form. More...
 
virtual StatusCode decodeOutputSpec (std::string &connectionSpec, int &outputTech) const =0
 Extract/deduce the DB technology from the connection string/file specification. More...
 
virtual StatusCode registerCleanUp (IAthenaPoolCleanUp *cnv)=0
 Implement registerCleanUp to register a IAthenaPoolCleanUp to be called during cleanUp. More...
 
virtual StatusCode cleanUp (const std::string &connection)=0
 Implement cleanUp to call all registered IAthenaPoolCleanUp cleanUp() function. More...
 
virtual StatusCode setInputAttributes (const std::string &fileName)=0
 Set the input file attributes, if any are requested from jobOpts. More...
 
virtual StatusCode makeServer (int num)=0
 Make this a server. More...
 
virtual StatusCode makeClient (int num)=0
 Make this a client. More...
 
virtual StatusCode readData ()=0
 Read the data. More...
 
virtual StatusCode commitCatalog ()=0
 Commit Catalog. More...
 

Static Public Member Functions

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

Protected Attributes

std::vector< IAthenaPoolCleanUp * > m_cnvs
 

Detailed Description

This class provides the interface between Athena and PoolSvc.

Definition at line 36 of file IAthenaPoolCnvSvc.h.

Constructor & Destructor Documentation

◆ ~IAthenaPoolCnvSvc()

virtual IAthenaPoolCnvSvc::~IAthenaPoolCnvSvc ( )
inlinevirtual

Definition at line 41 of file IAthenaPoolCnvSvc.h.

41 {}

Member Function Documentation

◆ cleanUp()

virtual StatusCode IAthenaPoolCnvSvc::cleanUp ( const std::string &  connection)
pure virtual

Implement cleanUp to call all registered IAthenaPoolCleanUp cleanUp() function.

Implements IAthenaPoolCleanUpSvc.

Implemented in AthenaPoolCnvSvc.

◆ commitCatalog()

virtual StatusCode IDataShare::commitCatalog ( )
pure virtualinherited

Commit Catalog.

Implemented in AthenaPoolCnvSvc.

◆ convertAddress()

virtual StatusCode IAthenaPoolCnvSvc::convertAddress ( const IOpaqueAddress *  pAddress,
std::string &  refAddress 
)
pure virtual

Convert address to string form.

Parameters
pAddress[IN] address to be converted.
refAddress[OUT] converted string form.

Implemented in AthenaPoolCnvSvc.

◆ createAddress() [1/2]

virtual StatusCode IAthenaPoolCnvSvc::createAddress ( long  svcType,
const CLID clid,
const std::string &  refAddress,
IOpaqueAddress *&  refpAddress 
)
pure virtual

Create address from string form.

Parameters
svcType[IN] service type of the address.
clid[IN] class id for the address.
refAddress[IN] string form to be converted.
refpAddress[OUT] converted address.

Implemented in AthenaPoolCnvSvc.

◆ createAddress() [2/2]

virtual StatusCode IAthenaPoolCnvSvc::createAddress ( long  svcType,
const CLID clid,
const std::string *  par,
const unsigned long *  ip,
IOpaqueAddress *&  refpAddress 
)
pure virtual

Create a Generic address using explicit arguments to identify a single object.

Parameters
svcType[IN] service type of the address.
clid[IN] class id for the address.
par[IN] string containing the database name.
ip[IN] object identifier.
refpAddress[OUT] converted address.

Implemented in AthenaPoolCnvSvc.

◆ decodeOutputSpec()

virtual StatusCode IAthenaPoolCnvSvc::decodeOutputSpec ( std::string &  connectionSpec,
int &  outputTech 
) const
pure virtual

Extract/deduce the DB technology from the connection string/file specification.

Implemented in AthenaPoolCnvSvc.

◆ disconnectOutput()

virtual StatusCode IAthenaPoolCnvSvc::disconnectOutput ( const std::string &  outputConnectionSpec)
pure virtual

Disconnect to the output connection.

Implemented in AthenaPoolCnvSvc.

◆ getPoolSvc()

virtual IPoolSvc* IAthenaPoolCnvSvc::getPoolSvc ( )
pure virtual
Returns
pointer to PoolSvc instance.

Implemented in AthenaPoolCnvSvc.

◆ interfaceID()

static const InterfaceID& IAthenaPoolCnvSvc::interfaceID ( )
inlinestatic

Retrieve interface ID.

Definition at line 39 of file IAthenaPoolCnvSvc.h.

39 { return(IID_IAthenaPoolCnvSvc); }

◆ makeClient()

virtual StatusCode IDataShare::makeClient ( int  num)
pure virtualinherited

Make this a client.

Parameters
numThe number for the client.

Implemented in AthenaPoolCnvSvc.

◆ makeServer()

virtual StatusCode IDataShare::makeServer ( int  num)
pure virtualinherited

Make this a server.

Parameters
numThe number for the server.

Implemented in AthenaPoolCnvSvc.

◆ readData()

virtual StatusCode IDataShare::readData ( )
pure virtualinherited

Read the data.

Implemented in AthenaPoolCnvSvc.

◆ registerCleanUp()

virtual StatusCode IAthenaPoolCnvSvc::registerCleanUp ( IAthenaPoolCleanUp cnv)
pure virtual

Implement registerCleanUp to register a IAthenaPoolCleanUp to be called during cleanUp.

Implements IAthenaPoolCleanUpSvc.

Implemented in AthenaPoolCnvSvc.

◆ registerForWrite()

virtual Token* IAthenaPoolCnvSvc::registerForWrite ( Placement placement,
const void *  obj,
const RootType classDesc 
)
pure virtual
Returns
a string token to a Data Object written to Pool
Parameters
placement[IN] pointer to the placement hint
obj[IN] pointer to the Data Object to be written to Pool
classDesc[IN] pointer to the Seal class description for the Data Object.

Implemented in AthenaPoolCnvSvc.

◆ setInputAttributes()

virtual StatusCode IAthenaPoolCnvSvc::setInputAttributes ( const std::string &  fileName)
pure virtual

Set the input file attributes, if any are requested from jobOpts.

Parameters
fileName[IN] name of the input file

Implemented in AthenaPoolCnvSvc.

◆ setObjPtr()

virtual void IAthenaPoolCnvSvc::setObjPtr ( void *&  obj,
const Token token 
)
pure virtual
Parameters
obj[OUT] pointer to the Data Object.
token[IN] string token of the Data Object for which a Pool Ref is filled.

Implemented in AthenaPoolCnvSvc.

◆ useDetailChronoStat()

virtual bool IAthenaPoolCnvSvc::useDetailChronoStat ( ) const
pure virtual
Returns
a boolean for using detailed time and size statistics.

Implemented in AthenaPoolCnvSvc.

Member Data Documentation

◆ m_cnvs

std::vector<IAthenaPoolCleanUp*> IAthenaPoolCleanUpSvc::m_cnvs
protectedinherited

Definition at line 35 of file IAthenaPoolCleanUpSvc.h.


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