include/broker/csvFileRdr.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (c) 2013 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <fstream>

#include <vl/hostStructs.h>
#include <vlutil/vlFilename.h>

#include <broker/csvFileEntry.h>

class DtCsvFileReader;

// class DtCsvFileReader:
// Reads in and parses a csv file. Children classes will hold the parsed entries in sorted lists or
// hash lists.

// to use:
// a.  construct
// b.  open a stream.
// c.  read and parse lines
// d.  close
// e.  destruct

typedef DtCsvFileReader* (*DtCsvFileReaderCreatorFcn)();

class DT_DLL_BROKER DtCsvFileReader
{
public:

   static DtCsvFileReader* creator();

   // default constructor
   DtCsvFileReader();

   // Full-featured constructor
   DtCsvFileReader(const DtString & fileName);

   // destructor
   virtual ~DtCsvFileReader();

   // virtual bool openStream(const DtString & fileName);
   virtual bool openStream();
   virtual bool openStream(const DtString & fileName);
   virtual void closeStream();

   // status
   virtual bool isEOF() const;
   virtual bool isOpen();

   // name
   virtual void setFilename(const DtString& name);
   virtual const DtString& filename() const;

   // Fills up line with a row from the table

   virtual bool readLine( DtString& line );

   // Used to read and parse the rest of the table.
   // Derived Readers should create a derived DtCsvFileEntry
   // and pass that into parseLine.
   // The default simply reads a line and returns a generic
   // DtCsvFileEntry, containing a list of token strings.
   virtual DtCsvFileEntry* readAndParseNextLine(
      DtCsvFileEntryCreatorFcn pEntryCreatorFcn);

   // Parses the line and stores data in the entry
   virtual void parseLine(DtCsvFileEntry* pEntry,DtString& line );

private:

   // copy constructor
   DtCsvFileReader(const DtCsvFileReader& orig);

   // assignment operator
   DtCsvFileReader& operator=(const DtCsvFileReader& orig);

protected:

   DtFilename  myFilename;
   std::ifstream    myInfile;

};