Gaudi Framework, version v24r2

Home   Generated: Wed Dec 4 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for IFileAccess:
Collaboration graph
[legend]

Public Member Functions

 DeclareInterfaceID (IFileAccess, 2, 0)
 InterfaceID.
 
virtual ~IFileAccess ()
 
virtual std::auto_ptr
< std::istream
open (const std::string &url)=0
 Find the URL and returns an auto_ptr to an input stream interface of an object that can be used to read from the file the URL is pointing to.
 
virtual const std::vector
< std::string > & 
protocols () const =0
 Protocols supported by the instance.
 
- Public Member Functions inherited from IInterface
virtual void * i_cast (const InterfaceID &) const =0
 main cast function
 
virtual std::vector< std::stringgetInterfaceNames () const =0
 Returns a vector of strings containing the names of all the implemented interfaces.
 
virtual unsigned long addRef ()=0
 Increment the reference count of Interface instance.
 
virtual unsigned long release ()=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 ()
 Virtual destructor.
 

Additional Inherited Members

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

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 19 of file IFileAccess.h.

Constructor & Destructor Documentation

IFileAccess::~IFileAccess ( )
virtual

Definition at line 11 of file VirtualDestructors.cpp.

{}

Member Function Documentation

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

Find the URL and returns an auto_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.

Implemented in VFSSvc, and FileReadTool.

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

Protocols supported by the instance.

Implemented in VFSSvc, and FileReadTool.


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

Generated at Wed Dec 4 2013 14:33:17 for Gaudi Framework, version v24r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004