include/vmap/vpfTable.h

Go to the documentation of this file.

/******************************************************************************
** Copyright  (c) 2006 MAK Technologies, Inc.** All rights reserved.     
******************************************************************************/
/******************************************************************************
* $RCSfile: vpfTable.h,v $ $Revision: 1.11 $ $State: Exp $
******************************************************************************/

#ifndef VPF_TABLE_H_
#define VPF_TABLE_H_


#include <string>
#include <iostream>
#include <fstream>
#include <vector>

#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>

#include "vmap/vmapDefines.h"

//forward defs
class DtVpfIndexTable;
class DtVpfColumn;
class DtVpfRow;

typedef std::vector<DtVpfColumn*> DtColumnList;
typedef std::vector<DtVpfRow*> DtRowList;


class DT_DLL_vmap DtVpfTable
{
   enum DtByteOrderEnum {LSB, MSB};

   private:
      DtVpfTable(const DtVpfTable& table);

      DtVpfTable& operator=(const DtVpfTable& table);

   public:
      DtVpfTable(const DtFilename& path);

      virtual ~DtVpfTable();

      virtual std::istream& file();

      virtual const DtFilename& fileName() const;

      virtual const DtFilename& filePath();

      virtual bool mustSwap() const;

      virtual const DtVpfColumn* column(const DtString& columnName) const;

      virtual const DtColumnList* columns() const;

      virtual unsigned int numColumns() const; 
      
      virtual const DtVpfRow* row(int unsigned rowNumber) const;

      virtual const DtVpfRow* rowById(int unsigned id) const;

      virtual const DtRowList* rows() const;

      virtual unsigned int numRows() const;

      virtual const DtVpfTable* intDescriptionTable() const;

      virtual const DtVpfTable* charDescriptionTable() const;

   protected:
      virtual bool readTable();

      virtual bool readHeader();

      virtual bool readData();

      virtual void calculateByteOrder();

      virtual bool loadValueDescriptionTable(const DtString &tableName);

      int myHeaderLength;
      DtByteOrderEnum myFileByteOrder;
      DtByteOrderEnum myMachineByteOrder;
      DtString myTableDescription;
      DtString myNarrativeTableFileName;
      DtFilename myFileName;
      DtFilename myFilePath;
      std::ifstream myFile;
      std::ifstream::pos_type myFileSize;    

      DtColumnList myColumns;
      DtRowList myRows;

      //some columns have descriptions stored in these tables
      //a columns description() function will reference these tables
      DtVpfTable* myIntDescriptions;
      DtVpfTable* myCharDescriptions;
};

#endif