/cvmfs/atlas.cern.ch/repo/sw/ASG/AnalysisBase/2.4.31/SampleHandler/SampleHandler/Sample.h

#ifndef SAMPLE_HANDLER_SAMPLE_HH
#define SAMPLE_HANDLER_SAMPLE_HH

//          Copyright Nils Krumnack 2011.
// 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 <string>
#include <vector>
#include <TObject.h>
#include <RootCoreUtils/Deprecated.h>
#include <SampleHandler/TagList.h>

class TChain;
class TCollection;
class TDSet;

namespace SH
{
  std::string dbg (const Sample& obj, unsigned verbosity = 0);



  class Sample : public TObject
  {
    //
    // public interface
    //

  public:
    void testInvariant () const;


  public:
    virtual ~Sample ();


    const std::string& name () const;

  public:
    void name (std::string val_name);


  public:
    std::size_t numFiles () const;


  public:
    std::string fileName (std::size_t index) const;


  public:
    SamplePtr makeLocal () const;


  public:
    const TagList& tags () const;


  public:
    void tags (const TagList& tags);


  public:
    void addTag (const std::string& tag);


  public:
    void updateLocation (const std::string& from, const std::string& to);


  public:
    MetaObject *meta ();


  public:
    const MetaObject *meta () const;


  public:
    std::vector<std::string> makeFileList () const;


  public:
    TChain *makeTChain () const;


  public:
    TDSet *makeTDSet () const;


  public:
    TObject *readHist (const std::string& name) const;


  public:
    bool contains (const std::string& name) const;


  public:
    void addSamples (SampleHandler& result);


  public:
    void print () const;


  public:
    void printContent () const;


  public:
    Long64_t getNumEntries () const;



    //
    // legacy interface
    //

  public:
    RCU_DEPRECATED ("use meta() instead, or (preferably) access of meta-data by name")
    TCollection *metaDataList ();


  public:
    RCU_DEPRECATED ("use meta() instead, or (preferably) access of meta-data by name")
    const TCollection *metaDataList () const;


  public:
    RCU_DEPRECATED ("use meta() instead")
    void removeMeta (const std::string& name);


  public:
    RCU_DEPRECATED ("use meta() instead")
    void addReplaceMeta (TNamed *meta_swallow);


  public:
    RCU_DEPRECATED ("use meta() instead")
    TObject *getMeta (const std::string& name);


  public:
    RCU_DEPRECATED ("use meta() instead")
    const TObject *getMeta (const std::string& name) const;


  public:
    RCU_DEPRECATED ("use meta() instead")
    double getMetaDouble (const std::string& name, double def_val = 0) const;


  public:
    RCU_DEPRECATED ("use meta() instead")
    std::string getMetaString (const std::string& name, const std::string& def_val = "") const;


  public:
    RCU_DEPRECATED ("use meta() instead")
    void setMetaDouble (const std::string& name, double value);


  public:
    RCU_DEPRECATED ("use meta() instead")
    void setMetaString (const std::string& name, const std::string& value);


  public:
    RCU_DEPRECATED ("use meta() instead")
    void fetchMeta (const Sample& source);



    //
    // protected interface
    //

  protected:
    Sample (const std::string& name);



    //
    // virtual interface
    //

  protected:
    virtual std::size_t getNumFiles () const = 0;


  protected:
    virtual std::string getFileName (std::size_t index) const = 0;


  protected:
    virtual SamplePtr doMakeLocal () const = 0;


  protected:
    virtual std::vector<std::string> doMakeFileList () const = 0;


  protected:
    virtual void
    doUpdateLocation (const std::string& from, const std::string& to);


  protected:
    virtual TObject *doReadHist (const std::string& name) const;


  protected:
    virtual bool getContains (const std::string& name) const;


  protected:
    virtual void doAddSamples (SampleHandler& result);



    //
    // friend interface for SamplePtr
    //

    friend class SamplePtr;
  private:

    void alloc () const;


    void release () const;



    //
    // private interface
    //

  private:
    std::string m_name;

  private:
    TagList m_tags;

  private:
    MetaObject *m_meta;

  private:
    mutable unsigned m_references; 

  private:
    Sample (const Sample& that);

  private:
    Sample& operator = (const Sample& that);

    ClassDef(Sample, 2);
  };
}

#endif

---