The Gaudi Framework
master (37c0b60a)
IFileAccess.h
Go to the documentation of this file.
1
/***********************************************************************************\
2
* (c) Copyright 1998-2024 CERN for the benefit of the LHCb and ATLAS collaborations *
3
* *
4
* This software is distributed under the terms of the Apache version 2 licence, *
5
* copied verbatim in the file "LICENSE". *
6
* *
7
* In applying this licence, CERN does not waive the privileges and immunities *
8
* granted to it by virtue of its status as an Intergovernmental Organization *
9
* or submit itself to any jurisdiction. *
10
\***********************************************************************************/
11
#ifndef GaudiKernel_IFileAccess_H
12
#define GaudiKernel_IFileAccess_H
13
14
// Include Files
15
#include <
GaudiKernel/IInterface.h
>
16
#include <istream>
17
#include <memory>
18
#include <optional>
19
#include <string>
20
#include <vector>
21
29
class
GAUDI_API
IFileAccess
:
virtual
public
IInterface
{
30
public
:
32
DeclareInterfaceID
(
IFileAccess
, 3, 1 );
33
37
virtual
std::unique_ptr<std::istream>
open
(
std::string
const
& url ) = 0;
38
42
virtual
std::optional<std::string>
read
(
std::string
const
& url ) {
43
auto
is = open( url );
44
if
( !is || !is->good() )
return
std::nullopt;
45
return
std::string
{
std::istreambuf_iterator<char>
{ *is },
std::istreambuf_iterator<char>
{} };
46
}
47
49
virtual
const
std::vector<std::string>
&
protocols
()
const
= 0;
50
};
51
52
#endif // GaudiKernel_IFileAccess_H
std::string
STL class.
std::vector< std::string >
IFileAccess
Definition:
IFileAccess.h:29
IInterface.h
IFileAccess::read
virtual std::optional< std::string > read(std::string const &url)
Find the URL and returns an optional<string> to the content of the file the URL is pointing to.
Definition:
IFileAccess.h:42
std::istreambuf_iterator
IFileAccess::open
virtual std::unique_ptr< std::istream > open(std::string const &url)=0
Find the URL and returns a unique_ptr to an input stream interface of an object that can be used to r...
IFileAccess::DeclareInterfaceID
DeclareInterfaceID(IFileAccess, 3, 1)
InterfaceID.
IInterface
Definition:
IInterface.h:239
std::unique_ptr
STL class.
GAUDI_API
#define GAUDI_API
Definition:
Kernel.h:81
IFileAccess::protocols
virtual const std::vector< std::string > & protocols() const =0
Protocols supported by the instance.
GaudiKernel
include
GaudiKernel
IFileAccess.h
Generated on Thu Dec 19 2024 15:35:01 for The Gaudi Framework by
1.8.18