IoDataStreamItr.h

Go to the documentation of this file.

// $Id: IoDataStreamItr.h,v 1.12 2009/01/05 05:55:13 schubert Exp $
//
// Abstract base class for a iterator for an input data stream. This
// base class is subclassed for different data sources.
//
// All IoDataStreamItr's should have the following behavior:
//
// * Upon creation the IoDataStreamItr should be placed on a "begin
// file" marker. Ie. to get to the first valid record set in the
// stream one should do an Increment().
//
// * Increment() should return the number of record sets the position
// in the data stream was advanced by. In the case where the Next
// request would advance past the EOF marker Increment should place
// the position in the input stream at the EOF marker and return the
// number of records sets actually advanced to reach the last record
// set.
//
// * If the position in the data stream is at the EOF or the BOF
// marker, LoadRecords() should return 0.
//
// * Decrement() should return the number of record sets the position
// in the data stream was backed up by. In the case where the Prev
// request would advance past the BOF marker Decrement should the
// position in the input stream at the BOF marker and return the
// number of record sets actually traversed to reach the first record
// set.
//
// Here's an example for a stream with 5 record sets in it:
//
//      Next's:    1-> 2-> 3-> 4-> 5-> 6-> (7th Next returns 0, stays at EOF)
// Record Sets: BOF   0   1   2   3   4   5   EOF(6)
//      Prev's:    <-6 <-5 <-4 <-3 <-2 <-1
//              |
//              (7th Prev returns 0, leaving the position at BOF)
//
// messier@huhepl.harvard.edu
#ifndef IODATASTREAMITR_H
#define IODATASTREAMITR_H

#ifndef JOBCRESULT_H
#include "JobControl/JobCResult.h"
#endif
#ifndef STRING
#include <string>
#define STRING
#endif
#ifndef LIST
#include <list>
#define LIST
#endif
#ifndef PER_H
#include "Persistency/Per.h"
#endif

class MomNavigator;
class VldContext;

class IoDataStreamItr {

public:
  IoDataStreamItr();
  IoDataStreamItr(const char* sourceName);
  virtual ~IoDataStreamItr();
  
  const char* GetSourceName() const { return fSourceName.c_str(); }
  void        SetSourceName(const char* name) { fSourceName = name; }

  // Sub-classes must implement these for themselves
  virtual bool        IsValid() const                                = 0;
  virtual const char* GetFormat() const                              = 0;
  virtual int         LoadRecords(MomNavigator* mom)                 = 0;
  virtual int         Increment(int n=1, MomNavigator* m=0)          = 0;
  virtual int         Decrement(int n=1, MomNavigator* m=0)          = 0;
  virtual JobCResult  GoTo(const VldContext& vld, MomNavigator* m=0) = 0;

  // Default implementation provided for these (most are dummy)
  virtual int  GoToEOF();
  virtual int  DefineStream(const char* streamname, const char* treename);
  virtual int  Streams(const char* streamlist);
  virtual int  Select(const char* stream, const char* selection, bool isRequired = false);
  virtual int  SetSequenceMode(const char* stream, Per::ESequenceMode seqmode);
  virtual int  SetPerOwnedDisabled(const char* stream, 
                                   bool perowneddisabled = true);    
  virtual int  SetWindow(const char* stream, double lower, double upper);
  virtual void SetPort(unsigned int port);
  virtual void SetTimeOut(unsigned int seconds);

  virtual int  SetMaxFileRepeat(const char* stream,int numRepeat);
  virtual int  SetMeanMom(const char* stream, double mean);
  virtual int  SetPushRandom(const char* stream, bool setRandom);
  virtual void SetRandomSeed(int rSeed);
  virtual int  SetTestMode(const char* stream,bool testmode);
  
  // File list manipulation default implementation
  virtual void AddFile(const char* fullfilepathname, int at = -1,
                       const char* streamlist = "*");
  virtual const char* GetCurrentFile(const char* streamname = "*") const;
  virtual JobCResult GoToFile(int i, const char* streamlist = "*");
  virtual JobCResult GoToFile(const char* fullfilepathname, 
                              const char* streamlist = "*");
  virtual JobCResult NextFile(int n = 1, const char* streamlist = "*");
  virtual JobCResult PrevFile(int n = 1, const char* streamlist = "*");
  virtual void RemoveFile(const char* fullfilepathname="*",
                          const char* streamlist="*");
  virtual std::ostream& ListFile(std::ostream& os, 
                                 const char* streamlist = "*") const;
  
 private:
  // File manipulation default implementation, these are dummy methods
  virtual JobCResult OpenFile();
  virtual void       CloseFile();

  std::string fSourceName;  // The source of data records
  std::list<std::string> fFileList; // file list used for def implementation
  std::list<std::string>::iterator fFileListItr; // current file ptr def imp
  bool fIsBOF; // at beginning of file list if true

};

#endif

---