The Gaudi Framework  v29r0 (ff2e7097)
IFileAccess Class Referenceabstract

Abstract interface for a service or tool implementing a read access to files. More...

#include <GaudiKernel/IFileAccess.h>

Inheritance diagram for IFileAccess:
Collaboration diagram for IFileAccess:

Public Member Functions

 DeclareInterfaceID (IFileAccess, 3, 0)
 InterfaceID. More...
 
virtual std::unique_ptr< std::istreamopen (const std::string &url)=0
 Find the URL and returns a unique_ptr to an input stream interface of an object that can be used to read from the file the URL is pointing to. More...
 
virtual const std::vector< std::string > & protocols () const =0
 Protocols supported by the instance. More...
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function More...
 
virtual std::vector< std::stringgetInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces. More...
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance. More...
 
virtual unsigned long release ()=0
 Release Interface instance. More...
 
virtual unsigned long refCount () const =0
 Current reference count. More...
 
virtual StatusCode queryInterface (const InterfaceID &ti, void **pp)=0
 Set the void** to the pointer to the requested interface of the instance. More...
 
virtual ~IInterface ()=default
 Virtual destructor. More...
 

Additional Inherited Members

- Public Types inherited from IInterface
enum  Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
 Return status. More...
 
using iid = Gaudi::InterfaceId< IInterface, 0, 0 >
 Interface ID. More...
 
using ext_iids = Gaudi::interface_list< iid >
 Extra interfaces. More...
 
- Static Public Member Functions inherited from IInterface
static const InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface. More...
 

Detailed Description

Abstract interface for a service or tool implementing a read access to files.

Author
Marco Clemencic
Date
2008-01-18

Definition at line 18 of file IFileAccess.h.

Member Function Documentation

IFileAccess::DeclareInterfaceID ( IFileAccess  ,
,
 
)
virtual std::unique_ptr<std::istream> IFileAccess::open ( const std::string url)
pure virtual

Find the URL and returns a unique_ptr to an input stream interface of an object that can be used to read from the file the URL is pointing to.

Returns an empty pointer if the URL cannot be resolved.

virtual const std::vector<std::string>& IFileAccess::protocols ( ) const
pure virtual

Protocols supported by the instance.


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