ana::FileListSource Class Reference

Simple file source based on an explicit list provided by the user. More...

#include <FileListSource.h>

Inheritance diagram for ana::FileListSource:

Public Member Functions
	FileListSource (const std::vector< std::string > &files, int stride=-1, int offset=-1)
	default offset and stride mean obey cmd-line options More...
virtual	~FileListSource ()
virtual TFile *	GetNextFile () override
	Returns the next file in sequence, ready for reading. More...
int	NFiles () const override
	May return -1 indicating the number of files is not known. More...
Public Member Functions inherited from ana::IFileSource
virtual	~IFileSource ()

Protected Attributes
std::vector< std::string >	fFileNames
	The list of files. More...
std::vector< std::string > ::iterator	fIt
	Iterator into fFileNames. More...
int	fStride
int	fN
	Number of files that will actually be returned. More...
TFile *	fFile
	The most-recently-returned file. More...

Static Protected Attributes
static bool	fgGotTickets = false
	Have we renewed our tickets? More...

Detailed Description

Simple file source based on an explicit list provided by the user.

Definition at line 11 of file FileListSource.h.

Constructor & Destructor Documentation

ana::FileListSource::FileListSource	(	const std::vector< std::string > &	files,
		int	stride = -1,
		int	offset = -1
	)

default offset and stride mean obey cmd-line options

Definition at line 15 of file FileListSource.cxx.

    : fFileNames(files.begin(), files.end()),
      fIt(fFileNames.begin()),
      fStride(stride),
      fFile(0)
  {
    if(fFileNames.empty()){
      fN = 0;
      return;
    }

    if(offset < 0){
      if(getenv("CAFANA_OFFSET"))
        offset = atoi(getenv("CAFANA_OFFSET"));

      offset = std::max(offset, 0);
    }

    if(fStride < 0){
      if(getenv("CAFANA_STRIDE"))
        fStride = atoi(getenv("CAFANA_STRIDE"));

      fStride = std::max(fStride, 1);
    }

    if(fStride > int(files.size())){
      std::cerr << "Warning: stride " << fStride
                << " is greater than the number of files: " << files.size()
                << ". This is strange and inefficient." << std::endl;
      // Needs to be nonzero otherwise some callers go off into SAM-query
      // land. Having a slightly misleading progress bar is a small price to
      // pay in this weird case.
      fN = 1;
      return;
    }

    // How many files will we process from the list with this offset and
    // stride?
    fN = (int(files.size())-offset-1)/fStride+1;

    for(const std::string& loc: files){
      if(loc.rfind("/pnfs/", 0) == 0){ // ie begins with
        if(!fgGotTickets){
          // No kerberos ticket means no point trying to voms-proxy-init. It
          // likely also means we're in a grid job, where that would be
          // counterproductive anyway.
          if(system("klist -5 -s || klist -s") != 0) fgGotTickets = true;
        }

        if(!fgGotTickets){
          // This comes from NovaGridUtils, v02.10 onwards.
          //          system("setup_fnal_security -b");

          fgGotTickets = true;
          break;
        }
      }
    }

    for(int i = 0; i < offset; ++i){
      ++fIt;
      if(fIt == fFileNames.end()) break;
    }
  }

ana::FileListSource::~FileListSource ( )

virtual

Definition at line 82 of file FileListSource.cxx.

  {
    delete fFile;
  }

Member Function Documentation

TFile * ana::FileListSource::GetNextFile ( )

overridevirtual

Returns the next file in sequence, ready for reading.

A null return means that the end of the sequence has been reached. DO NOT close or delete the file that is returned.

Implements ana::IFileSource.

Definition at line 88 of file FileListSource.cxx.

  {
    // Tidy up the last file we gave, which the caller no longer needs
    delete fFile;
    fFile = 0;

    if(fIt == fFileNames.end()) return 0; // Ran out of files

    // If the file is on pnfs rewrite it to an xrootd address
    std::string loc = *fIt;
    // loc = pnfs2xrootd(loc); // no-op for non /pnfs locations

    fFile = TFile::Open(loc.c_str()); // This pattern allows xrootd
    assert(fFile);

    for(int i = 0; i < fStride; ++i){
      if(fIt == fFileNames.end()) break;
      ++fIt; // Move on to the next file, for the subsequent call
    }

    return fFile;
  }

int ana::FileListSource::NFiles ( ) const

inlineoverridevirtual

May return -1 indicating the number of files is not known.

Reimplemented from ana::IFileSource.

Definition at line 20 of file FileListSource.h.

{return fN;}

Member Data Documentation

TFile* ana::FileListSource::fFile

protected

The most-recently-returned file.

Definition at line 26 of file FileListSource.h.

std::vector<std::string> ana::FileListSource::fFileNames

protected

The list of files.

Definition at line 22 of file FileListSource.h.

bool ana::FileListSource::fgGotTickets = false

staticprotected

Have we renewed our tickets?

Definition at line 27 of file FileListSource.h.

std::vector<std::string>::iterator ana::FileListSource::fIt

protected

Iterator into fFileNames.

Definition at line 23 of file FileListSource.h.

int ana::FileListSource::fN

protected

Number of files that will actually be returned.

Definition at line 25 of file FileListSource.h.

int ana::FileListSource::fStride

protected

Definition at line 24 of file FileListSource.h.

---

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

• FileListSource.h
• FileListSource.cxx