ATLAS Offline Software
SampleMeta.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2002-2017 CERN for the benefit of the ATLAS collaboration
3 */
4 
5 #ifndef SAMPLE_HANDLER__SAMPLE_META_H
6 #define SAMPLE_HANDLER__SAMPLE_META_H
7 
8 //
9 // Distributed under the Boost Software License, Version 1.0.
10 // (See accompanying file LICENSE_1_0.txt or copy at
11 // http://www.boost.org/LICENSE_1_0.txt)
12 
13 // Please feel free to contact me (krumnack@iastate.edu) for bug
14 // reports, feature suggestions, praise and complaints.
15 
16 
17 
18 #include <SampleHandler/Global.h>
19 
20 #include <SampleHandler/Sample.h>
21 
22 namespace SH
23 {
30  class SampleMeta : public Sample
31  {
32  //
33  // public interface
34  //
35 
40  public:
41  void testInvariant () const;
42 
43 
51  public:
53 
54 
62  public:
63  SampleMeta (const std::string& name);
64 
65 
66 
67  //
68  // inherited interface
69  //
70 
72  private:
73  virtual std::size_t getNumFiles () const;
74 
76  private:
77  virtual std::string getFileName (std::size_t index) const;
78 
80  private:
81  virtual SamplePtr doMakeLocal () const;
82 
84  protected:
85  virtual std::vector<std::string> doMakeFileList () const;
86 
87 
88 
89  //
90  // private interface
91  //
92 
94  };
95 }
96 
97 #endif
SH::SampleMeta::getNumFiles
virtual std::size_t getNumFiles() const
the number of files in the sample
index
Definition: index.py:1
SH::SampleMeta::SampleMeta
SampleMeta(const std::string &name)
standard constructor
SH::SampleMeta::testInvariant
void testInvariant() const
test the invariant of this object
SH::SampleMeta::doMakeFileList
virtual std::vector< std::string > doMakeFileList() const
make a list of all files, prestaging them if necessary
SH::SampleMeta::doMakeLocal
virtual SamplePtr doMakeLocal() const
Make this a local sample, i.e.
SH::SampleMeta
A Sample that consists only of Meta-Information.
Definition: SampleMeta.h:31
SH::SampleMeta::SampleMeta
SampleMeta()
standard constructor
SH::Sample::name
const std::string & name() const
the name of the sample we are using
SH::Sample
a base class that manages a set of files belonging to a particular data set and the associated meta-d...
Definition: Sample.h:54
SH::SampleMeta::getFileName
virtual std::string getFileName(std::size_t index) const
the name of the file with the given index
SH::SamplePtr
A smart pointer class that holds a single Sample object.
Definition: SamplePtr.h:35
SH::SampleMeta::ClassDef
ClassDef(SampleMeta, 1)
SH
This module provides a lot of global definitions, forward declarations and includes that are used by ...
Definition: PrunDriver.h:15
Global.h
Sample.h