SampleHandler.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef SAMPLE_HANDLER_SAMPLE_HANDLER_HH
#define SAMPLE_HANDLER_SAMPLE_HANDLER_HH
 
//
// Distributed under the Boost Software License, Version 1.0.
//    (See accompanying file LICENSE_1_0.txt or copy at
//          http://www.boost.org/LICENSE_1_0.txt)
 
// Please feel free to contact me (krumnack@iastate.edu) for bug
// reports, feature suggestions, praise and complaints.
 
 
 
#include <SampleHandler/Global.h>
#include <SampleHandler/SamplePtr.h>
 
#include <memory>
#include <iosfwd>
#include <map>
#include <vector>
#include <TObject.h>
 
namespace SH
{
  std::string dbg (const SampleHandler& obj, unsigned verbosity = 0);
 
 
  void swap (SampleHandler& a, SampleHandler& b);
 
 
 
  class SampleHandler : public TObject
  {
    //
    // public interface
    //
 
  public:
    void testInvariant () const;
 
 
  public:
    SampleHandler ();
 
 
  public:
    SampleHandler (const SampleHandler& that);
 
 
  public:
    ~SampleHandler ();
 
 
  public:
    SampleHandler& operator = (const SampleHandler& that);
 
 
  public:
    void add (Sample *sample);
 
 
  public:
    void add (std::unique_ptr<Sample> sample);
 
 
  public:
    void add (SamplePtr& sample);
 
 
  public:
    void add (SamplePtr&& sample);
 
 
  public:
    void add (const SampleHandler& sh);
 
 
  public:
    void addWithPrefix (const SampleHandler& sh, const std::string& prefix);
 
 
  public:
    void remove (const std::string& name);
 
 
  public:
    void remove (const Sample *sample);
 
 
  public:
    Sample *get (const std::string& name);
 
 
  public:
    const Sample *get (const std::string& name) const;
 
 
  public:
    SampleHandler find (const TagList& tags) const;
 
 
  public:
    SampleHandler find (const std::string& tags) const;
 
 
  public:
    Sample *findBySource (const std::string& name) const;
 
 
  public:
    SampleHandler findByName (const std::string& pattern) const;
 
 
  public:
    void print () const;
 
 
  public:
    void printContent () const;
 
 
  public:
    void save (const std::string& directory) const;
 
 
  public:
    void load (const std::string& directory);
 
 
  public:
    void updateLocation (const std::string& from, const std::string& to);
 
 
  public:
    void fetch (const SampleHandler& source);
 
 
  public:
    void fetchDefaults (const SampleHandler& source);
 
 
  public:
    bool check_complete (const SampleHandler& source) const;
 
 
  public:
    void setMetaDouble (const std::string& name, double value);
 
 
  public:
    void setMetaString (const std::string& name, const std::string& value);
 
 
  public:
    void setMetaDouble (const std::string& pattern, const std::string& name,
            double value);
 
 
  public:
    void setMetaString (const std::string& pattern, const std::string& name,
            const std::string& value);
 
 
  public:
    typedef std::vector<Sample*>::const_iterator iterator;
 
 
  public:
    iterator begin () const;
 
 
  public:
    iterator end () const;
 
 
  public:
    std::size_t size () const;
 
 
  public:
    Sample *operator [] (std::size_t index) const;
 
 
  public:
    Sample *at (std::size_t index) const;
 
 
 
    //
    // private interface
    //
 
    friend void swap (SampleHandler& a, SampleHandler& b);
 
  private:
    std::vector<SH::Sample*> m_samples;
 
  private:
    typedef std::vector<SH::Sample*>::const_iterator SamplesIter;
 
  private:
    typedef std::vector<SH::Sample*>::iterator SamplesMIter;
 
  private:
    std::map<std::string,SH::SamplePtr> m_named;
 
  private:
    typedef std::map<std::string,SH::SamplePtr>::iterator NamedIter;
 
  private:
    typedef std::map<std::string,SH::SamplePtr>::iterator NamedMIter;
 
    ClassDef (SampleHandler, 1)
  };
}
 
#endif