The Gaudi Framework  master (ff829712)
Loading...
Searching...
No Matches
Gaudi::IFileCatalogMgr Class Referenceabstract

File catalog manager. More...

#include <GaudiUtils/IFileCatalogMgr.h>

Inheritance diagram for Gaudi::IFileCatalogMgr:
Collaboration diagram for Gaudi::IFileCatalogMgr:

Public Types

typedef std::vector< IFileCatalog * > Catalogs
 Public type definitions.
 
- Public Types inherited from IInterface
enum class  Status : StatusCode::code_t {
  FAILURE = 0 , SUCCESS = 1 , NO_INTERFACE , VERSMISMATCH ,
  LAST_ERROR
}
 Return status. More...
 
using iid = Gaudi::InterfaceId<IInterface, 0, 0>
 Interface ID.
 
using ext_iids = Gaudi::interface_list<iid>
 Extra interfaces.
 

Public Member Functions

 DeclareInterfaceID (IFileCatalogMgr, 2, 0)
 InterfaceID.
 
virtual IFileCatalogfindCatalog (const std::string &connect, bool must_be_writable) const =0
 Catalog management.
 
virtual void addCatalog (const std::string &connect)=0
 Add new catalog identified by name to the existing ones.
 
virtual void addCatalog (IFileCatalog *cat)=0
 Add new catalog identified by reference to the existing ones.
 
virtual void removeCatalog (const std::string &connect)=0
 Remove catalog identified by name from the existing ones.
 
virtual void removeCatalog (const IFileCatalog *cat)=0
 Remove catalog identified by reference from the existing ones.
 
virtual Catalogscatalogs ()=0
 Access catalog container.
 
virtual const Catalogscatalogs () const =0
 Access catalog container (CONST)
 
virtual IFileCatalogwriteCatalog (const std::string &fid="") const =0
 Access to the (first) writable file catalog.
 
virtual void setWriteCatalog (IFileCatalog *cat)=0
 Define the writable catalog identified by reference.
 
virtual void setWriteCatalog (const std::string &connect)=0
 Define the writable catalog identified by name.
 
- Public Member Functions inherited from IInterface
template<Gaudi::IsInterface TARGET>
TARGET * cast ()
 
template<Gaudi::IsInterface TARGET>
TARGET const * cast () const
 
template<typename TARGET>
requires ( !Gaudi::IsInterface<TARGET> )
TARGET * cast ()
 
template<typename TARGET>
requires ( !Gaudi::IsInterface<TARGET> )
TARGET const * cast () const
 
virtual std::vector< std::string > getInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
 
virtual unsigned long addRef () const =0
 Increment the reference count of Interface instance.
 
virtual unsigned long release () const =0
 Release Interface instance.
 
virtual unsigned long refCount () const =0
 Current reference count.
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance.
 
virtual ~IInterface ()=default
 Virtual destructor.
 
virtual void const * i_cast (const InterfaceID &) const =0
 
void * i_cast (const InterfaceID &iid)
 

Additional Inherited Members

- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
 
- Protected Member Functions inherited from IInterface
virtual unsigned long decRef () const =0
 Decrement reference count and return the new reference count.
 

Detailed Description

File catalog manager.

Interface to add/remove file catalogs from the multi catalog.

Author
M.Frank
Version
1.0
Date
20/10/2007

Definition at line 34 of file IFileCatalogMgr.h.

Member Typedef Documentation

◆ Catalogs

Public type definitions.

Definition at line 40 of file IFileCatalogMgr.h.

Member Function Documentation

◆ addCatalog() [1/2]

virtual void Gaudi::IFileCatalogMgr::addCatalog ( const std::string & connect)
pure virtual

Add new catalog identified by name to the existing ones.

◆ addCatalog() [2/2]

virtual void Gaudi::IFileCatalogMgr::addCatalog ( IFileCatalog * cat)
pure virtual

Add new catalog identified by reference to the existing ones.

◆ catalogs() [1/2]

virtual const Catalogs & Gaudi::IFileCatalogMgr::catalogs ( ) const
pure virtual

Access catalog container (CONST)

◆ catalogs() [2/2]

virtual Catalogs & Gaudi::IFileCatalogMgr::catalogs ( )
pure virtual

Access catalog container.

◆ DeclareInterfaceID()

Gaudi::IFileCatalogMgr::DeclareInterfaceID ( IFileCatalogMgr ,
2 ,
0  )

◆ findCatalog()

virtual IFileCatalog * Gaudi::IFileCatalogMgr::findCatalog ( const std::string & connect,
bool must_be_writable ) const
pure virtual

Catalog management.

Find catalog by connect string

◆ removeCatalog() [1/2]

virtual void Gaudi::IFileCatalogMgr::removeCatalog ( const IFileCatalog * cat)
pure virtual

Remove catalog identified by reference from the existing ones.

◆ removeCatalog() [2/2]

virtual void Gaudi::IFileCatalogMgr::removeCatalog ( const std::string & connect)
pure virtual

Remove catalog identified by name from the existing ones.

◆ setWriteCatalog() [1/2]

virtual void Gaudi::IFileCatalogMgr::setWriteCatalog ( const std::string & connect)
pure virtual

Define the writable catalog identified by name.

◆ setWriteCatalog() [2/2]

virtual void Gaudi::IFileCatalogMgr::setWriteCatalog ( IFileCatalog * cat)
pure virtual

Define the writable catalog identified by reference.

◆ writeCatalog()

virtual IFileCatalog * Gaudi::IFileCatalogMgr::writeCatalog ( const std::string & fid = "") const
pure virtual

Access to the (first) writable file catalog.


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