include/shape/shapeProjectionInformation.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2005 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: shapeProjectionInformation.h,v $ $Revision: 1.12 $ $State: Exp $
*******************************************************************************/
#ifndef shapeProjectionInformation_H_
#define shapeProjectionInformation_H_

#include "shape/shapeDefines.h"
#include <vlutil/vlString.h>
#include <vlutil/vlConfig.h>
#include <list>
#include <map>

class DtShapeProjectionInformation;
class DtPoint;
class Coordinate_System;
class DtShapeInitializer;
class DtShapeVectorInitializer;
class DtFilename;

typedef std::list<DtShapeProjectionInformation*> DtShapeProjectionInformationList;

class DT_DLL_shape DtShapeProjectionInformation
{
public:
   DtShapeProjectionInformation();
   DtShapeProjectionInformation(const DtString& s);

   virtual ~DtShapeProjectionInformation();

   virtual bool load(FILE*);
   virtual bool valueFor(const DtString& key, DtString& value) const;
   virtual void parseBracketString(const DtString& bracketString);

   DtString key() const;
   DtString value() const;
   void setValue(const DtString&);
   const DtShapeProjectionInformationList& children() const;

   virtual void add(const DtString& key, const DtString& val);

   virtual void addKeyword(const DtString& kw, const DtString& expectedValues);
   void initializeKeywords();

protected:
   virtual DtString readKeyword(FILE* f);
   virtual bool parseContents(FILE* f, const DtString& expected);
   virtual DtString parseString(FILE* f);
   virtual DtString allBetweenBrackets(FILE* f);
   virtual void addChildren(FILE* f);
   virtual void parseKeyValuePair();

protected:
   DtString myKey;

   DtString myValue;

   DtString mySubKey;

   DtShapeProjectionInformationList myChildren;

   std::map<DtString, DtString>  myKeywords;
};

class DT_DLL_shape DtShapeProjection
{
public:
   DtShapeProjection();
   virtual ~DtShapeProjection();

   virtual bool load(FILE*, const DtShapeInitializer*);
   virtual bool load(FILE*, const DtShapeVectorInitializer*);
   virtual bool valueFor(const DtString& key, DtString& value) const;

   static DtShapeProjection* create();

   // Returns true if the projection is a transverse mercator projection.  It will then convert
   // the TM value to geodetic.  The projection will be considered a TM projection if it is
   // projected and has both a central meridian and scale factor defined
   virtual bool isTransverseMercator() const;
   virtual bool isProjected() const;

   virtual void add(const DtString& key, const DtString& val);
   Coordinate_System* coordinateSystem() { return  myCoordinateSystem; };
   virtual Coordinate_System* createCoordinateSystem() const;

   // Creates a new coordinate system based on contents of a given projection (.prj) file.
   // Caller is responsible for deleting the memory associated with the coordinate system.
   static Coordinate_System* createCoordinateSystem(const DtFilename& projectionFile);

public:
   // Given the projection, convert from source projection to geodetic (degrees, not radians).  This
   // supports mappings from keywords (string) to coordinate system types.  Currently supported type
   // is only UTM.  Note the point p must be in the source mapping.  If no mapping exists, the point
   // is not modified
   virtual bool convertPointFromProjectionToGeodetic(DtPoint& p) const;

   void setInitializer(const DtShapeInitializer*);
   void setVectorInitializer(const DtShapeVectorInitializer*);

protected:
   DtShapeProjectionInformation  myShapeProjectionInformation;

   mutable Coordinate_System*   myCoordinateSystem;
   const DtShapeInitializer* myInitializer;
   const DtShapeVectorInitializer* myVectorInitializer;
};

typedef DtShapeProjection* (*DtShapeProjectionCreatorFcn)();

inline void DtShapeProjection::setInitializer(const DtShapeInitializer* i)
{
   myInitializer = i;
}

inline void DtShapeProjection::setVectorInitializer(const DtShapeVectorInitializer* i)
{
   myVectorInitializer = i;
}

inline DtString DtShapeProjectionInformation::key() const
{
   return myKey;
}

inline DtString DtShapeProjectionInformation::value() const
{
   return myValue;
}

inline void DtShapeProjectionInformation::setValue(const DtString& val)
{
   myValue = val;
}

inline const DtShapeProjectionInformationList& DtShapeProjectionInformation::children() const
{
   return myChildren;
}

#endif