IoDummyStreamItr.h

Go to the documentation of this file.

//
// IoDummyStreamItr
//
// Iterator for a dummy data stream to allow job control cycling with
// no input file.
//
// Author: S. Kasahara 11/05
//
#ifndef IODUMMYSTREAMITR_H
#define IODUMMYSTREAMITR_H
#ifndef IODATASTREAMITR_H
#include "IoModules/IoDataStreamItr.h"
#endif

class MomNavigator;

class IoDummyStreamItr : public IoDataStreamItr {

public:
  IoDummyStreamItr();
  ~IoDummyStreamItr();

  // Must provide these, no default implementation given
  bool IsValid() const { return fIsValid; }
  const char* GetFormat() const { return "dummy"; }
  int LoadRecords(MomNavigator* m);
  int Increment(int n=1, MomNavigator* m=0);
  int Decrement(int n=1, MomNavigator* m=0);
  JobCResult GoTo(const VldContext& vld, MomNavigator* m=0);

  // Override default to print error messages when user tries to
  // invoke methods that aren't supported in dummy mode 
  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  SetWindow(const char* stream, double lower, double upper);
  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:

  bool fIsValid;  // valid input stream iterator

};

#endif

---