include/broker/csvFileEntry.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/
#pragma once

#include <vl/hostStructs.h>
#include <vlutil/vlList.h>
#include <broker/dllExport.h>

class DtCsvFileEntry;

typedef DtCsvFileEntry* (*DtCsvFileEntryCreatorFcn)();

// class DtCsvFileEntry:
//
// Is a generic class. It represents the entries that are parsed out of a csv file by the csv
// file reader. Children classes will derive their own entrie from this that their own derived readers
// know how to parse

class DT_DLL_BROKER DtCsvFileEntry
{
   // constructors
public:

   // constructor
   DtCsvFileEntry(const DtString & name);

   // destructor
   virtual ~DtCsvFileEntry();

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

   // operators
public:
   // Clone entry
   virtual DtCsvFileEntry * clone();

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

   // accessors & mutators
public:
   // emptyList()
   // For the default implementation, delete
   // the string fields in the member list.
   virtual void emptyList();

   // length()
   // For the default implementation,
   // return the number of fields available.
   virtual int length() const;

   //Entry's name
   virtual const DtString & name() const;

   // operator[]
   // For the default implementation, return
   // a field in the list of fields.
   // Returns DtString::nullString() for
   // indices that are out of range
   virtual DtString& operator[](int idx);

   virtual const DtString& operator[](int idx) const;

   // parseFrom
   // A generic tokenizer that busts up the line
   // into string fields and stores them into
   // the myFields member.
   virtual void parseFrom(const DtString& sLine);

   // static creator
public:

   static DtCsvFileEntry* creator();

protected:

   // default constructor
   DtCsvFileEntry();

protected:
   DtString    myName;
   DtList      myFields;

};