include/shape/shapeEntry.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: shapeEntry.h,v $ $Revision: 1.11 $ $State: Exp $
*******************************************************************************/
#ifndef shapeEntry_H_
#define shapeEntry_H_

// \file shapeEntry.h
// \brief Contains the DtShapeEntry class declaration and other related definitions/declarations.

#include "shape/shapeDefines.h"
#include <vlutil/vlFilename.h>
#include <vlutil/vlString.h>


enum DtShapefileEntryType 
{
   SHAPEFILE_NOTYPE,
   SHAPEFILE_FEATURE,
   SHAPEFILE_ELEVATIONFIELD,
   SHAPEFILE_ELEVATIONDELTA,
   SHAPEFILE_ELEVATIONINDATA
};


// 
// The DtShapeEntry class is responsible for holding all the data necessary for 
// the shape vector importer to import the specified shape file as a set of vector
// features.
class DT_DLL_shape DtShapeEntry
{

public:

   // default constructor.
   DtShapeEntry();
   DtShapeEntry(const DtFilename& filename, const DtString& dataString, float factorToMtrs);
   DtShapeEntry(const DtFilename& filename, float elevationDelta, float factorToMtrs);
   DtShapeEntry(const DtFilename& filename, float factorToMtrs);
   DtShapeEntry(const DtFilename& filename, int fccCode);

   // Copy constructor
   DtShapeEntry(const DtShapeEntry& original);
   
   // Assignment operator
   DtShapeEntry& operator=(const DtShapeEntry& original);
   

   // destructor
   virtual ~DtShapeEntry();

   virtual void setType(DtShapefileEntryType newType);
   virtual DtShapefileEntryType type() const;

   // add a filename to the load list
   virtual void setFile(const DtFilename& filename);
   virtual DtFilename& file();
   virtual const DtFilename& file() const;

   virtual void setDataString(const DtString& dataString);
   virtual DtString& dataString();
   virtual const DtString& dataString() const;

   virtual void setElevationDelta(float stp);
   virtual double elevationDelta() const;

   virtual void setFactorToMtrs(float factor);
   virtual float factorToMtrs() const;

   virtual void setFccCode(int fccCod);
   virtual int fccCode() const;

   virtual void setPath(const DtFilename&);
   virtual const DtFilename& path() const;

   // Indicates whether or not we should load all attributes
   // found in .dbf file.  Default is false (only load those
   // attributes we specifically ask for through a
   // DtVectorDataInitializer object).
   virtual void setLoadAllAttributes(bool yesNo);
   virtual bool loadAllAttributes() const;

   // Indicates whether or not attributes from the sedris map files
   // should be loaded when loading this shape file.  If yes, the map file
   // (specified in setDfadSedrisFile()) will be used to initialize the 
   // shape attributes based on the FCC code.
   // Default is true.
   virtual void setLoadSedrisMapAttributes(bool yesNo);
   virtual bool loadSedrisMapAttributes() const;

protected:
   DtFilename           myFilename;
   DtFilename           myPath;
   DtShapefileEntryType myType;
   DtString             myDataString;
   double               myElevationDelta;
   float                myFactorToMtrs;
   int                  myFccCode;
   bool                 myLoadAllAttributes;
   bool                 myLoadSedrisMapAttributes;
};

#endif