o2::framework::AODInputFile Struct Reference

#include <AODInputFile.h>

Inherited by o2::framework::NativeAODInputFile, and o2::framework::RootAODInputFile.

Classes
struct	Key

Public Member Functions
virtual	~AODInputFile ()=default
virtual std::string	name () const =0
virtual uint64_t	size () const =0
virtual uint64_t	bytesRead () const =0
virtual uint64_t	readCalls () const =0
virtual std::vector< Key >	topLevelKeys ()=0
	Top-level keys, in the order the file lists them, all cycles.
virtual std::vector< std::string >	keysIn (std::string const &dir)=0
	Names of the keys inside the top-level directory dir, empty if there is none.
virtual std::map< std::string, std::string >	parentFiles ()=0
	DF_<n> to parent file path. Empty if the file has no parentFiles.
virtual std::map< std::string, std::string >	metaData ()=0
virtual std::shared_ptr< VirtualRootFileSystemBase >	filesystem ()=0
virtual std::string	monitoringDetails () const
	Extra key=value pairs for the file monitoring metrics, starting with a comma.
virtual void	setReadOrder (std::vector< std::string > const &dfs)
	The DF_<n> names in the order they will be read, for readers which read ahead.

Detailed Description

An AO2D file opened for reading, as DataInputDirector needs it: the list of top-level keys, the file-level maps and an arrow filesystem to read the tables from. This hides which library actually reads the file.

Definition at line 31 of file AODInputFile.h.

Constructor & Destructor Documentation

~AODInputFile()

virtual o2::framework::AODInputFile::~AODInputFile ( )

virtualdefault

Member Function Documentation

bytesRead()

virtual uint64_t o2::framework::AODInputFile::bytesRead ( ) const

pure virtual

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

filesystem()

virtual std::shared_ptr< VirtualRootFileSystemBase > o2::framework::AODInputFile::filesystem ( )

pure virtual

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

keysIn()

virtual std::vector< std::string > o2::framework::AODInputFile::keysIn ( std::string const &  dir )

pure virtual

Names of the keys inside the top-level directory dir, empty if there is none.

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

metaData()

virtual std::map< std::string, std::string > o2::framework::AODInputFile::metaData ( )

pure virtual

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

monitoringDetails()

virtual std::string o2::framework::AODInputFile::monitoringDetails ( ) const

inlinevirtual

Extra key=value pairs for the file monitoring metrics, starting with a comma.

Reimplemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

Definition at line 51 of file AODInputFile.h.

name()

virtual std::string o2::framework::AODInputFile::name ( ) const

pure virtual

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

parentFiles()

virtual std::map< std::string, std::string > o2::framework::AODInputFile::parentFiles ( )

pure virtual

DF_<n> to parent file path. Empty if the file has no parentFiles.

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

readCalls()

virtual uint64_t o2::framework::AODInputFile::readCalls ( ) const

pure virtual

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

setReadOrder()

virtual void o2::framework::AODInputFile::setReadOrder ( std::vector< std::string > const &  dfs )

inlinevirtual

The DF_<n> names in the order they will be read, for readers which read ahead.

Reimplemented in o2::framework::NativeAODInputFile.

Definition at line 53 of file AODInputFile.h.

size()

virtual uint64_t o2::framework::AODInputFile::size ( ) const

pure virtual

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

topLevelKeys()

virtual std::vector< Key > o2::framework::AODInputFile::topLevelKeys ( )

pure virtual

Top-level keys, in the order the file lists them, all cycles.

Implemented in o2::framework::RootAODInputFile, and o2::framework::NativeAODInputFile.

---

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

• /home/runner/work/AliceO2/AliceO2/Framework/AnalysisSupport/src/AODInputFile.h