include/shape/shapeVectorInit.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2003 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: shapeVectorInit.h,v $ $Revision: 1.13 $ $State: Exp $
*******************************************************************************/
#ifndef shapeVectorInit_H_
#define shapeVectorInit_H_

#include "shape/shapeDefines.h"
#include "gdb/vectorDataInitializer.h"
#include "shape/shapeEntry.h"

#include <vlutil/vlConfig.h>
#include <vlutil/vlFilename.h>
#include <list>

// Entries which get stored in myAttributeMappingList
struct DtShapeAttributeMapping
{
   DtString attributeName;
   unsigned int attributeType;
   DtString fieldName;
};


// DtShapeVectorInitializer holds the settings specified in a 
// ShapeVectorMetafileRecord
class DT_DLL_shape DtShapeVectorInitializer : public DtVectorDataInitializer
{

public:

   typedef std::list<DtShapeEntry> DtShapeFileContainer;
   typedef DtShapeFileContainer::iterator DtShapeFileIter;
   typedef DtShapeFileContainer::const_iterator DtShapeFileConstIter;

   typedef std::list<DtShapeAttributeMapping> DtShapeAttributeMapContainer;
   typedef DtShapeAttributeMapContainer::iterator DtShapeAttributeMapIter;
   typedef DtShapeAttributeMapContainer::const_iterator DtShapeAttributeMapConstIter;

   // default constructor.
   DtShapeVectorInitializer();

   // destructor
   virtual ~DtShapeVectorInitializer();

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

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

   // \return "shape"
   virtual DtString type();

   // \return The container of shape entries in this initializer.
   virtual const DtShapeFileContainer& featureDataFileList() const;
   virtual DtShapeFileContainer& featureDataFileList();

   // Add a filename to the load list
   virtual void addFeatureDataFile(const DtFilename& filename, int fccCode, const DtFilename& path);

   // \return the origin latitude;
   virtual const double& originLatitude() const;
   virtual void setOriginLatitude(const double& d);

   // \return the origin longitude
   virtual const double& originLongitude() const;
   virtual void setOriginLongitude(const double& d);

   // \return the low-color height
   virtual bool isOriginSpecified() const;
   virtual void setIsOriginSpecified(bool b);

   // Called by DtShapeVectorMetafileRecord::processToken to import the
   // given fieldName from the dBASE file as an attribute with the given
   // attributeName and attributeType.
   virtual void addAttributeMapping(const DtString& attributeName, 
      unsigned int attributeType, const DtString& fieldName);
   
   // \return The container of attribute mappings
   // \see DtShapeAttributeMapping
   virtual const DtShapeAttributeMapContainer& attributeMap() const;
   virtual DtShapeAttributeMapContainer& attributeMap();

   virtual void clearList();

   // Mapping file (CSV formatted) which maps shape filename fragments
   // to entries in the DfadSedrisMap file to be used for all features in
   // that file.
   // Only used if #myClassifyFeaturesFromFilename is true.
   virtual void setShapeFilenameMapFile(const DtFilename& filename);
   virtual DtFilename shapeFilenameMapFile() const;

   // If true, will attempt to choose DfadSedisMap entries based on 
   // filename, using #myShameFilenameMapFile.
   virtual void setClassifyFeaturesFromFilename(bool v);
   virtual bool classifyFeaturesFromFilename() const;

   // Mapping file (CSV formatted) which lists attribute names to a set
   // of alternative names that may be found in the .dbf file along with
   // a shape file.  Any occurrences of any of the name aliases will be 
   // imported to the attribute named in this list.
   // Only used if #myUseAttributeAliasMapping is true.
   virtual void setShapeAttributeAliasFile(const DtFilename& filename);
   virtual DtFilename shapeAttributeAliasFile() const;

   // If true, will map attributes using #myShapeAttributeAliasFile.
   virtual void setUseAttributeAliasFile(bool v);
   virtual bool useAttributeAliasFile() const;
   
protected:

   DtShapeFileContainer          myFeatureDataFileList;
   DtShapeAttributeMapContainer  myAttributeMappingList;

   DtFilename myShapeFilenameMapFile;
   DtFilename myShapeAttributeAliasFile;

   double                  myOriginLatitude;
   double                  myOriginLongitude;
   double                  myMinimumDistance;
   double                  myThresholdForSeaLevel;

   bool                    myIsOriginSpecified;
   bool                    myClassifyFeaturesFromFilename;
   bool                    myUseAttributeAliasMapping;

};

#endif