Loading [MathJax]/extensions/tex2jax.js
The Gaudi Framework  master (d98a2936)
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
IFileAccess.h
Go to the documentation of this file.
1 /***********************************************************************************\
2 * (c) Copyright 1998-2025 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 #pragma once
12 
13 #include <GaudiKernel/IInterface.h>
14 #include <istream>
15 #include <memory>
16 #include <optional>
17 #include <string>
18 #include <vector>
19 
27 class GAUDI_API IFileAccess : virtual public IInterface {
28 public:
31 
35  virtual std::unique_ptr<std::istream> open( std::string const& url ) = 0;
36 
40  virtual std::optional<std::string> read( std::string const& url ) {
41  auto is = open( url );
42  if ( !is || !is->good() ) return std::nullopt;
43  return std::string{ std::istreambuf_iterator<char>{ *is }, std::istreambuf_iterator<char>{} };
44  }
45 
47  virtual const std::vector<std::string>& protocols() const = 0;
48 };
IFileAccess
Definition: IFileAccess.h:27
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:40
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:225
GAUDI_API
#define GAUDI_API
Definition: Kernel.h:49
IFileAccess::protocols
virtual const std::vector< std::string > & protocols() const =0
Protocols supported by the instance.