IoDataStreamItr.cxx

Go to the documentation of this file.

// $Id: IoDataStreamItr.cxx,v 1.12 2009/02/28 21:46:13 gmieg Exp $
//
// A class for walking over data streams.
//
// messier@huhepl.harvard.edu
#include <algorithm>

#include "MessageService/MsgService.h"
#include "MessageService/MsgFormat.h"
#include "IoModules/IoDataStreamItr.h"

CVSID("$Id: IoDataStreamItr.cxx,v 1.12 2009/02/28 21:46:13 gmieg Exp $");

//......................................................................

IoDataStreamItr::IoDataStreamItr():
               fSourceName(""),fFileListItr(fFileList.end()),fIsBOF(false) { }

//......................................................................

IoDataStreamItr::IoDataStreamItr(const char* sourceName):
       fSourceName(sourceName),fFileListItr(fFileList.end()),fIsBOF(false) { }

//......................................................................

IoDataStreamItr::~IoDataStreamItr() { }

//......................................................................  

int IoDataStreamItr::GoToEOF() 
{
  static const int BIG_NUMBER = 1000000;
  while (this->Increment(BIG_NUMBER)) { continue; }
  return 1; // AOK
}

//......................................................................  

int IoDataStreamItr::DefineStream(const char* /* streamname */,
                                  const char* /* treename */) { return 0; }

//......................................................................  

int IoDataStreamItr::Streams(const char* /* streamlist */) { return 0; }

//......................................................................  

int IoDataStreamItr::Select(const char* /* stream */,
                            const char* /* selection */,
                            bool /* isRequired */) { return 0; }

//......................................................................  

int IoDataStreamItr::SetSequenceMode(const char* /* stream */,
                              Per::ESequenceMode /* seqmode */) { return 0; }

//......................................................................  

int IoDataStreamItr::SetPerOwnedDisabled(const char* /* stream */,
                                     bool /* perowneddisabled */) { return 0; }

//......................................................................  

int IoDataStreamItr::SetTestMode(const char* /* stream */,
                                 bool /* testmode */) { return 0; }

//......................................................................  

int IoDataStreamItr::SetWindow(const char*, double, double) { return 0; }

//......................................................................  

void IoDataStreamItr::SetPort(unsigned int /* port */) { }

//......................................................................  

void IoDataStreamItr::SetTimeOut(unsigned int /* seconds */) { }

//......................................................................  

int IoDataStreamItr::SetMaxFileRepeat(const char*, int) { return 0; }

//......................................................................  

int IoDataStreamItr::SetMeanMom(const char*, double) { return 0; }

//......................................................................  

int IoDataStreamItr::SetPushRandom(const char*, bool) { return 0; }

//......................................................................  

void IoDataStreamItr::SetRandomSeed(int) {}

//......................................................................  

void IoDataStreamItr::AddFile(const char* fullfilepathname, int at,
                              const char* /* streamlist */) {
//======================================================================
// Add fullfilepathname to the list of input files at the position "at". 
// -1 = end of list.  streamlist is ignored in this def implementation,
// i.e. action is applied to all streams.
//======================================================================
  // Remember the current file so we can come back here
  std::string curf;
  if ( !fIsBOF && fFileList.size()>0) curf = (*fFileListItr);

  // Figure out where to insert the file into the list
  std::string f(fullfilepathname);
  if (at<0)  {
    fFileList.push_back(f); 
  }
  else if (at==0) {
    fFileList.push_front(f);
  }
  else {
    std::list<std::string>::iterator itr(fFileList.begin());
    std::list<std::string>::iterator itrEnd(fFileList.end());
    for (int i=0; (i<at && itr!=itrEnd); ++i, ++itr) continue;
    fFileList.insert(itr,f);
  }
  
  // Put the position back to the orginal file (or start of list)
  if ( fIsBOF || fFileList.size()==1) {
    fIsBOF = true;  // NextFile will move to first file
  }
  else {
    // Find original file in new list
    fFileListItr = std::find(fFileList.begin(),fFileList.end(),curf);
    fIsBOF = false;
  }

  return;

}

//......................................................................

void IoDataStreamItr::RemoveFile(const char* fullfilepathname, 
                                 const char* /* streamlist */) {
//======================================================================
// Remove the fullfilepathname from the list of input data files. If == "*", 
// remove all files.  streamlist is ignored in this def implementation,
// i.e. action is applied to all streams.
//======================================================================
  
  std::string curf; bool isBegin = false;
  if ( !fIsBOF && fFileListItr != fFileList.end() ) 
                                                    curf = *fFileListItr;
  else if ( fIsBOF ) isBegin = true;

  std::string f(fullfilepathname);

  std::list<std::string>::iterator itr(fFileList.end());
  while ( !fFileList.empty() && itr != fFileList.begin() ) {
    itr--;  // Move backwards to undisturbed list as files erased off end
    if ( f == "*" || f == (*itr) ) {
      if ( fFileListItr == itr ) {
        MSG("Io",Msg::kWarning)
          << "Attempt to remove currently opened file\n" << (*itr) 
          << " ignored." << endl;
      }
      else {
        fFileList.erase(itr);
      }
    }
  }

  // Reset file iterator in revised list
  if ( isBegin && !fFileList.empty() ) fIsBOF = true;
  else {
    fFileListItr = std::find(fFileList.begin(),fFileList.end(),curf);
    fIsBOF = false;
  }
  
  return;

}

//......................................................................

const char* IoDataStreamItr::GetCurrentFile(const char* /* streamname */)const{
//======================================================================
// Return current fullfilepathname.
//======================================================================
  std::string currentfilename;
  if ( !fIsBOF && fFileListItr != fFileList.end() ) 
    currentfilename = *fFileListItr;
  return currentfilename.c_str();
}
 
//......................................................................

JobCResult IoDataStreamItr::NextFile(int n, const char* /* streamlist */) {
//======================================================================
// Move to the next file in the list (move by n positions)
// Return JobCResult::kAOK if advance successful and file opened okay, or
//        JobCResult::kEndOfInputStream, if at end of file list, or
//        JobCResult error code returned from OpenFile() if file open failed.
//======================================================================

  // If we've hit the end of the input stream, don't allow the user to
  // step further
  if ( fFileList.empty() || (!fIsBOF && fFileListItr == fFileList.end()) ) {
    return JobCResult::kEndOfInputStream;
  }

  this -> CloseFile();
  for ( int i = 0; i < n; i++ ) {
    if ( fIsBOF ) {
      fFileListItr = fFileList.begin();
      fIsBOF = false;
    }
    else fFileListItr++;
    
    // Flag attempts to read past the end of the file list
    if (fFileListItr == fFileList.end()) {
      // Flag that we've reached the end of the input stream
      return JobCResult::kEndOfInputStream;
    }
  }

  return this -> OpenFile(); // returns JobCResult::kAOK or error code
 
}

//......................................................................

JobCResult IoDataStreamItr::GoToFile(int n, const char* /* streamlist */) {
//======================================================================
// Move the stream to the nth file in the list ( n = 0 is first )
// Return JobCResult::kAOK if advance successful and file opened okay, or
//        JobCResult::kWarning, if requested file number out of range, or
//        JobCResult error code returned from OpenFile() if file open failed.
//======================================================================

  std::list<std::string>::iterator itr(fFileList.begin());
  std::list<std::string>::iterator itrEnd(fFileList.end());
  int i = 0;
  for ( ; i < n && itr != itrEnd; ++i,++itr) { continue; }

  if ( i != n || itr == itrEnd ) {
    // Did not find file -- warn and take no action
    MSG("Io",Msg::kWarning) << 
      "Request to goto file ["<< n <<"]. Only " << i <<" files loaded."<< endl;
    return JobCResult::kWarning;
  }

  this -> CloseFile(); // Close the current file
  fFileListItr = itr; // Reset the current file pointer
  fIsBOF = false;
  
  return this -> OpenFile(); // returns JobCResult::kAOK or error code
 
}

//......................................................................

JobCResult IoDataStreamItr::GoToFile(const char* fullfilepathname, 
                                     const char* /* streamlist */) {
//======================================================================
// Move the stream to file fullfilepathname in the list. If "", go to
// first file in the list.
// Return JobCResult::kAOK if advance successful and file opened okay, or
//        JobCResult::kWarning, if requested file name not in list or
//        JobCResult error code returned from OpenFile() if file open failed.
//======================================================================

  std::string f(fullfilepathname);

  if (f == "") return this->GoToFile(0); // w/o argument reset to start of list

  std::list<std::string>::iterator itr = 
          std::find(fFileList.begin(), fFileList.end(), f);

  if ( itr != fFileList.end() ) {
    MSG("Io",Msg::kDebug) << "Go to file '" << f << "'." << endl;
    this -> CloseFile();
    fFileListItr = itr;
    fIsBOF = false;
    return this -> OpenFile(); // returns JobCResult::kAOK or error code   
  }

  MSG("Io",Msg::kWarning) << "File '" << f << "' not found in list." << endl;
  return JobCResult::kWarning;  // requested file not found 

}

//......................................................................

JobCResult IoDataStreamItr::PrevFile(int n, const char* /* streamlist */) {
//======================================================================
// Rewind to the previous file in the list (move by n positions). 
// Return JobCResult::kAOK if rewind successful and file opened okay, or
//        JobCResult::kBeginOfInputStream, if at begin of file list, or
//        JobCResult error code returned from OpenFile() if file open failed.
//======================================================================

  // If we've hit the beginning of the input stream, don't allow the user 
  // to step further
  if ( fIsBOF ) {
    return JobCResult::kBeginOfInputStream;
  }

  this -> CloseFile();
  for ( int i = 0; i < n; i++ ) {
    if ( fFileListItr == fFileList.begin() ) fIsBOF = true;
    else fFileListItr--;
  
    // Flag attempts to read past the begin of the file list
    if ( fIsBOF ) {
      // Flag that we've reached the end of the input stream
      return JobCResult::kBeginOfInputStream;
    }
  }

  return this -> OpenFile(); // returns JobCResult::kAOK or error code   

}

std::ostream& IoDataStreamItr::ListFile(std::ostream& os, 
                                        const char* /* streamlist */) const {
//======================================================================
// Print the file list on ostream
//======================================================================

  int indx = 0;
  MsgFormat ifmt("%3i");

  std::string s;
  s = "index  file name";
  os << s << endl;
  int len = s.size();
  s = "=====  ";
  os << s;
  for ( int i = s.size()+1; i < len; i++ ) os << "=";
  os << endl;
  
  std::list<std::string>::const_iterator itr(fFileList.begin());
  std::list<std::string>::const_iterator itrEnd(fFileList.end());
  for (; itr!=itrEnd; itr++) {
    os << "[" << ifmt(indx++) << "] ";
    if (itr == fFileListItr) os << "*";
    else os << " ";
    os << (*itr) << endl;
  }

  return os;

}


//......................................................................

JobCResult IoDataStreamItr::OpenFile() {
//======================================================================
// Open current file. User must override this dummy def implementation. 
// Return JobCResult::kAOK if success, else error message
//======================================================================

  return JobCResult::kWarning;

}

//......................................................................

void IoDataStreamItr::CloseFile() {
//======================================================================
// Close current file 
// Return: none.
//======================================================================

  return;

}

---