YODA::ReaderH5 Class Reference

Persistency reader from YODA text data format. More...

#include <ReaderH5.h>

Inheritance diagram for YODA::ReaderH5:

Public Member Functions
	ReaderH5 (const ReaderH5 &)=delete
	Disable copy and move constructors.
	ReaderH5 (ReaderH5 &&)=delete
void	operator= (const ReaderH5 &)=delete
	Disable copy and move assignments.
void	operator= (ReaderH5 &&)=delete
void	read (const YODA_H5::File &file, std::vector< AnalysisObject * > &aos, const std::string &match="", const std::string &unmatch="")
	Read in a collection of objects objs from an HDF5 file.
Public Member Functions inherited from YODA::Reader
virtual	~Reader ()
	Virtual destructor.
template<typename CONT >
std::enable_if_t< YODA::Pushable< CONT, AnalysisObject * >::value >	read (std::istream &stream, CONT &aos, const std::string &match="", const std::string &unmatch="")
	Read in a collection of objects objs from output stream stream.
std::vector< AnalysisObject * >	read (std::istream &stream, const std::string &match="", const std::string &unmatch="")
	Read in a collection of objects from output stream stream.
std::vector< AnalysisObject * >	read (const YODA_H5::File &file, const std::string &match="", const std::string &unmatch="")
	Read in a collection of objects from an H5 file.
template<typename CONT >
std::enable_if_t< YODA::Pushable< CONT, AnalysisObject * >::value >	read (const std::string &filename, CONT &aos, const std::string &match="", const std::string &unmatch="")
	Read in a collection of objects objs from file filename.
void	read (const std::string &filename, std::vector< AnalysisObject * > &aos, const std::string &match="", const std::string &unmatch="")
	Read in a collection of objects objs from file filename.
std::vector< AnalysisObject * >	read (const std::string &filename, const std::string &match="", const std::string &unmatch="")
	Read in a collection of objects from output stream stream.
template<typename T >
void	registerType ()
	AO type registration.
bool	patternCheck (const std::string &path, const std::vector< std::regex > &patterns, const std::vector< std::regex > &unpatterns)
	Check if a string matches any of the given patterns, and that it doesn't match any unpatterns (for path filtering)

Static Public Member Functions
static Reader &	create ()
	Singleton creation function.

Additional Inherited Members
Public Types inherited from YODA::Reader
using	TypeRegisterItr = typename std::unordered_map< std::string, std::unique_ptr< AOReaderBase > >::const_iterator
	Convenience alias for AO Reader.

Detailed Description

Persistency reader from YODA text data format.

Definition at line 15 of file ReaderH5.h.

Constructor & Destructor Documentation

ReaderH5() [1/2]

YODA::ReaderH5::ReaderH5 ( const ReaderH5 &  )

delete

Disable copy and move constructors.

ReaderH5() [2/2]

YODA::ReaderH5::ReaderH5 ( ReaderH5 &&  )

delete

Member Function Documentation

create()

Reader & YODA::ReaderH5::create ( )

static

Singleton creation function.

Definition at line 28 of file ReaderH5.cc.

                           {
    static ReaderH5 _instance;
    _instance.registerDefaultTypes<double,int,string>();
    return _instance;
  }

Referenced by YODA::mkReader().

operator=() [1/2]

void YODA::ReaderH5::operator= ( const ReaderH5 &  )

delete

Disable copy and move assignments.

operator=() [2/2]

void YODA::ReaderH5::operator= ( ReaderH5 &&  )

delete

read()

void YODA::ReaderH5::read ( const YODA_H5::File &  file, std::vector< AnalysisObject * > &  aos, const std::string &  match = "", const std::string &  unmatch = ""  )

virtual

Read in a collection of objects objs from an HDF5 file.

This version fills (actually, appends to) a supplied vector, avoiding copying, and is hence CPU efficient.

Implements YODA::Reader.

Definition at line 78 of file ReaderH5.cc.

                                                                  {
 
    vector<regex> patterns, unpatterns;
    for (const string& pat : Utils::split(match,   ",")) { patterns.push_back(regex(pat)); }
    for (const string& pat : Utils::split(unmatch, ",")) { unpatterns.push_back(regex(pat)); }
 
    // Load edge information
    H5FileManager reader(file);
 
    // Prepare registry
    TypeRegisterItr thisAOR = _register.cend();
    const TypeRegisterItr endAOR = _register.cend();
 
    while (reader.next()) {
 
      // Check that type has been loaded
      thisAOR = _register.find(reader.type());
      if (thisAOR == endAOR) {
        throw ReadError("Unexpected context found: " + reader.type());
      }
 
      // Check if path is being (un-)matched
      //
      // Since the edge types are not known until run time,
      // (empty) objects still need to be instantiated
      // from the type registry in order to be able to
      // choose the correct set of edges to skip.
      const bool pattern_pass = patternCheck(reader.path(), patterns, unpatterns);
      if (!pattern_pass) {
        thisAOR->second->skip(reader);
        continue;
      }
 
      // Construct AO
      aos.push_back(thisAOR->second->mkFromH5(reader));
    }
  }

References YODA::H5FileManager::next(), YODA::H5FileManager::path(), YODA::Reader::patternCheck(), and YODA::H5FileManager::type().

---

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

• include/YODA/ReaderH5.h
• src/ReaderH5.cc