ossimStatePlaneProjectionInfo Class Reference

#include <ossimStatePlaneProjectionInfo.h>

Public Member Functions
	ossimStatePlaneProjectionInfo (const std::string &name, int pcsCode, const std::string &projCode, const std::string &param1, const std::string &param2, const std::string &param3, const std::string &param4, double falseEast, double falseNorth, const std::string &units, const std::string &datumName)
int	code () const
const ossimString &	name () const
const ossimString &	projName () const
double	originLat () const
double	originLon () const
const ossimDatum *	datum () const
ossimGpt	origin () const
double	parallel1 () const
double	parallel2 () const
double	falseEasting () const
double	falseNorthing () const
double	falseEastingInMeters () const
double	falseNorthingInMeters () const
double	scaleFactor () const
ossimString	units () const
	Not stored as string; hence, returned by value. More...
ossimUnitType	getUnitType () const
bool	matchesProjection (const ossimMapProjection *proj) const
	Checks parameters of projection against this. More...
bool	isSameCode (int Code) const
void	populateProjectionKeywords (ossimKeywordlist &kwl, const char *prefix=0) const

Private Attributes
int	thePcsCode
ossimString	theName
ossimString	theProjectionName
const ossimDatum *	theDatum
ossimDms	theOriginLat
ossimDms	theOriginLon
ossimGpt	theOrigin
double	theParameter3
double	theParameter4
double	theFalseEasting
double	theFalseNorthing
double	theScaleFactor
ossimUnitType	theUnits

Friends
OSSIM_DLL std::ostream &	operator<< (std::ostream &, const ossimStatePlaneProjectionInfo &)

Detailed Description

Definition at line 21 of file ossimStatePlaneProjectionInfo.h.

Constructor & Destructor Documentation

ossimStatePlaneProjectionInfo()

ossimStatePlaneProjectionInfo::ossimStatePlaneProjectionInfo	(	const std::string &	name,
		int	pcsCode,
		const std::string &	projCode,
		const std::string &	param1,
		const std::string &	param2,
		const std::string &	param3,
		const std::string &	param4,
		double	falseEast,
		double	falseNorth,
		const std::string &	units,
		const std::string &	datumName
	)

Definition at line 19 of file ossimStatePlaneProjectionInfo.cpp.

References ossimString::c_str(), ossimDatumFactoryRegistry::create(), FLT_EPSILON, ossimDms::getDegrees(), ossimUnitTypeLut::getEntryNumber(), ossimUnitTypeLut::instance(), ossimDatumFactoryRegistry::instance(), OSSIM_FEET, OSSIM_METERS, OSSIM_US_SURVEY_FEET, ossimNotify(), ossimNotifyLevel_WARN, projName(), theDatum, theOrigin, theOriginLat, theOriginLon, theParameter3, theParameter4, theProjectionName, theScaleFactor, theUnits, ossimString::toDouble(), and units().

   :
      thePcsCode        (pcsCode),
      theName           (name),
      theProjectionName (projName),
      theDatum          (0),
      theOriginLat      (param1),
      theOriginLon      (param2),
      theOrigin         (),
      theParameter3     (0.0),
      theParameter4     (0.0),
      theFalseEasting   (falseEast),
      theFalseNorthing  (falseNorth),
      theScaleFactor    (0.0),
      theUnits          (OSSIM_UNIT_UNKNOWN)
      
{
   //---
   // If the projection name is abreviated, expand to be ossim class name.
   //---
   if (projName == "tm")
   {
      theProjectionName = "ossimTransMercatorProjection";
   }
   else if (projName == "lcc")
   {
      theProjectionName = "ossimLambertConformalConicProjection";
   }

   // Set the projection specific stuff.
   if (theProjectionName == "ossimTransMercatorProjection")
   {
      theParameter3 = ossimString::toDouble(param3);
      if(fabs(theParameter3) > FLT_EPSILON)
      {
         theScaleFactor = 1.0 - (1.0 / theParameter3);
      }
      else
      {
         theScaleFactor = 1.0;
      }
   }
   else if (theProjectionName == "ossimLambertConformalConicProjection")
   {
      theParameter3 = ossimDms(param3).getDegrees();
      theParameter4 = ossimDms(param4).getDegrees();
   }
   else
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimStatePlaneProjectionInfo unhandled projection type: "
         << projName << std::endl;
   }

   theDatum = ossimDatumFactoryRegistry::instance()->create(datumName);
   if (!theDatum)
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimStatePlaneProjectionInfo unhandled datum type: "
         << datumName << std::endl;
   }

   theOrigin = ossimGpt(theOriginLat.getDegrees(),
                        theOriginLon.getDegrees(),
                        0,
                        theDatum);

   theUnits = static_cast<ossimUnitType>(
      ossimUnitTypeLut::instance()->getEntryNumber(units.c_str()));

   // Currently only handle meters and us_survey_feet.
   if ( (theUnits != OSSIM_METERS) &&
        (theUnits != OSSIM_US_SURVEY_FEET) &&
        (theUnits != OSSIM_FEET) )
   {
      ossimNotify(ossimNotifyLevel_WARN)
         << "ossimStatePlaneProjectionInfo unhandled unit type: "
         << units.c_str()
         << std::endl;
   }
}

Member Function Documentation

code()

int ossimStatePlaneProjectionInfo::code

(

)

const

Definition at line 112 of file ossimStatePlaneProjectionInfo.cpp.

References thePcsCode.

Referenced by operator<<().

{
   return thePcsCode;
}

datum()

const ossimDatum * ossimStatePlaneProjectionInfo::datum

(

)

const

Definition at line 137 of file ossimStatePlaneProjectionInfo.cpp.

References theDatum.

{
   return theDatum;
}

falseEasting()

double ossimStatePlaneProjectionInfo::falseEasting

(

)

const

Definition at line 157 of file ossimStatePlaneProjectionInfo.cpp.

References theFalseEasting.

Referenced by operator<<().

{
   return theFalseEasting;
}

falseEastingInMeters()

double ossimStatePlaneProjectionInfo::falseEastingInMeters

(

)

const

Definition at line 187 of file ossimStatePlaneProjectionInfo.cpp.

References MTRS_PER_FT, OSSIM_FEET, OSSIM_US_SURVEY_FEET, theFalseEasting, theUnits, and US_METERS_PER_FT.

Referenced by matchesProjection().

{
   double result = theFalseEasting;
   switch (theUnits)
   {
      case OSSIM_US_SURVEY_FEET:
         result *= US_METERS_PER_FT;
         break;
      case OSSIM_FEET:
         result *= MTRS_PER_FT;
         break;
      default:
         break;
   }
   return result;
}

falseNorthing()

double ossimStatePlaneProjectionInfo::falseNorthing

(

)

const

Definition at line 162 of file ossimStatePlaneProjectionInfo.cpp.

References theFalseNorthing.

Referenced by operator<<().

{
   return theFalseNorthing;
}

falseNorthingInMeters()

double ossimStatePlaneProjectionInfo::falseNorthingInMeters

(

)

const

Definition at line 204 of file ossimStatePlaneProjectionInfo.cpp.

References MTRS_PER_FT, OSSIM_FEET, OSSIM_US_SURVEY_FEET, theFalseNorthing, theUnits, and US_METERS_PER_FT.

Referenced by matchesProjection().

{
   double result = theFalseNorthing;
   switch (theUnits)
   {
      case OSSIM_US_SURVEY_FEET:
         result *= US_METERS_PER_FT;
         break;
      case OSSIM_FEET:
         result *= MTRS_PER_FT;
         break;
      default:
         break;
   }
   return result;
}

getUnitType()

ossimUnitType ossimStatePlaneProjectionInfo::getUnitType

(

)

const

Returns

ossimUnitType

Definition at line 285 of file ossimStatePlaneProjectionInfo.cpp.

References theUnits.

{
   return theUnits;
}

isSameCode()

bool ossimStatePlaneProjectionInfo::isSameCode

(

int

Code

)

const

Definition at line 177 of file ossimStatePlaneProjectionInfo.cpp.

References thePcsCode.

{
   if(pcsCode == thePcsCode)
   {
      return true;
   }

   return false;
}

matchesProjection()

bool ossimStatePlaneProjectionInfo::matchesProjection

(

const ossimMapProjection *

proj

)

const

Checks parameters of projection against this.

Returns

true if projection parameters match this, false if not.

Definition at line 290 of file ossimStatePlaneProjectionInfo.cpp.

References ossimDatum::code(), falseEastingInMeters(), falseNorthingInMeters(), ossimObject::getClassName(), ossimMapProjection::getFalseEasting(), ossimMapProjection::getFalseNorthing(), ossimTransMercatorProjection::getScaleFactor(), ossimLambertConformalConicProjection::getStandardParallel1(), ossimLambertConformalConicProjection::getStandardParallel2(), ossimMapProjection::origin(), parallel1(), parallel2(), PTR_CAST, theDatum, theOrigin, theProjectionName, and theScaleFactor.

{
   if (!proj)
   {
      return false;
   }

#if 0
   cout << "\ntheProjectionName: " << theProjectionName
           << "\nclassName: " << proj->getClassName()
           << "\ntheOrigin: " << theOrigin
           << "\nproj->origin(): "<< proj->origin()
           << "\nfalseEastingInMeters(): "<< falseEastingInMeters()
           << "\nproj->getFalseEasting(): " << proj->getFalseEasting()
           << "\nfalseNorthingInMeters(): " << falseNorthingInMeters()
           << "\nproj->getFalseNorthing(): " << proj->getFalseNorthing()
           << "\ndatum: " << theDatum->code() 
           << endl;
#endif
   
   if ( (theProjectionName != proj->getClassName()) ||
        ( (theOrigin == proj->origin()) == false) ||
        (falseEastingInMeters() != proj->getFalseEasting()) ||
        (falseNorthingInMeters() != proj->getFalseNorthing()) )
   {
      return false;
   }

   //---
   // NOTE:  Going from double to strings, radians to degrees and back is
   // causing a wiggle in the floating point values; hence the
   // ALLOWABLE_VARIANCE.
   //---
   const double ALLOWABLE_VARIANCE = 0.00000000000001;
   
   if (theProjectionName == "ossimTransMercatorProjection")
   {
      ossimTransMercatorProjection* tm = PTR_CAST(ossimTransMercatorProjection,
                                                  proj);
      if (!tm)
      {
         return false;
      }
      double d1 = fabs(theScaleFactor - tm->getScaleFactor());
      if (d1 < ALLOWABLE_VARIANCE)
      {
         return true;
      }
   }
   else // Lambert.
   {
      ossimLambertConformalConicProjection* lam =
         PTR_CAST(ossimLambertConformalConicProjection, proj);
      if (!lam)
      {
         return false;
      }
      double d1 = fabs(parallel1() - lam->getStandardParallel1());
      double d2 = fabs(parallel2() - lam->getStandardParallel2());
      if ( (d1 < ALLOWABLE_VARIANCE) && (d2 < ALLOWABLE_VARIANCE) )
      {
         return true;
      }
   }
   
   return false;
}

name()

const ossimString & ossimStatePlaneProjectionInfo::name

(

)

const

Definition at line 117 of file ossimStatePlaneProjectionInfo.cpp.

References theName.

Referenced by operator<<().

{
   return theName;
}

origin()

ossimGpt ossimStatePlaneProjectionInfo::origin

(

)

const

Definition at line 142 of file ossimStatePlaneProjectionInfo.cpp.

References theOrigin.

Referenced by operator<<(), and populateProjectionKeywords().

{
   return theOrigin;
}

originLat()

double ossimStatePlaneProjectionInfo::originLat

(

)

const

Definition at line 127 of file ossimStatePlaneProjectionInfo.cpp.

References ossimDms::getDegrees(), and theOriginLat.

{
   return theOriginLat.getDegrees();
}

originLon()

double ossimStatePlaneProjectionInfo::originLon

(

)

const

Definition at line 132 of file ossimStatePlaneProjectionInfo.cpp.

References ossimDms::getDegrees(), and theOriginLon.

{
   return theOriginLon.getDegrees();
}

parallel1()

double ossimStatePlaneProjectionInfo::parallel1

(

)

const

Definition at line 147 of file ossimStatePlaneProjectionInfo.cpp.

References theParameter3.

Referenced by matchesProjection(), operator<<(), and populateProjectionKeywords().

{
   return theParameter3;
}

parallel2()

double ossimStatePlaneProjectionInfo::parallel2

(

)

const

Definition at line 152 of file ossimStatePlaneProjectionInfo.cpp.

References theParameter4.

Referenced by matchesProjection(), operator<<(), and populateProjectionKeywords().

{
   return theParameter4;
}

populateProjectionKeywords()

void ossimStatePlaneProjectionInfo::populateProjectionKeywords	(	ossimKeywordlist &	kwl,
		const char *	prefix = 0
	)		const

Definition at line 221 of file ossimStatePlaneProjectionInfo.cpp.

References ossimKeywordlist::add(), ossimString::c_str(), ossimKeywordNames::CENTRAL_MERIDIAN_KW, ossimDatum::code(), ossimKeywordNames::DATUM_KW, ossimKeywordNames::FALSE_EASTING_NORTHING_KW, ossimKeywordNames::FALSE_EASTING_NORTHING_UNITS_KW, ossimUnitTypeLut::instance(), origin(), ossimKeywordNames::ORIGIN_LATITUDE_KW, parallel1(), parallel2(), ossimKeywordNames::PCS_CODE_KW, projName(), ossimKeywordNames::SCALE_FACTOR_KW, STATIC_TYPE_NAME, ossimKeywordNames::STD_PARALLEL_1_KW, ossimKeywordNames::STD_PARALLEL_2_KW, theDatum, theFalseEasting, theFalseNorthing, thePcsCode, theScaleFactor, theUnits, ossimDpt::toString(), and ossimKeywordNames::TYPE_KW.

{
   kwl.add(prefix,
           ossimKeywordNames::PCS_CODE_KW,
           thePcsCode,
           true);
  
   kwl.add(prefix,
           ossimKeywordNames::FALSE_EASTING_NORTHING_UNITS_KW,
           (ossimUnitTypeLut::instance()->getEntryString(theUnits)),
           true);

   ossimDpt pt(theFalseEasting, theFalseNorthing);
           
   kwl.add(prefix,
           ossimKeywordNames::FALSE_EASTING_NORTHING_KW,
           pt.toString().c_str(),
           true);

   kwl.add(prefix,
           ossimKeywordNames::ORIGIN_LATITUDE_KW,
           origin().latd(),
           true);
   
   kwl.add(prefix,
           ossimKeywordNames::CENTRAL_MERIDIAN_KW,
           origin().lond(),
           true);
   
   kwl.add(prefix,
      ossimKeywordNames::TYPE_KW,
      projName(),
      true);
   
   if(theDatum)
   {
      
      kwl.add(prefix,
              ossimKeywordNames::DATUM_KW,
              theDatum->code(),
              true);
   }

   if (projName()== STATIC_TYPE_NAME(ossimLambertConformalConicProjection))
   {
      kwl.add(prefix,
              ossimKeywordNames::STD_PARALLEL_1_KW,
              parallel1(),
              true);
      kwl.add(prefix,
              ossimKeywordNames::STD_PARALLEL_2_KW,
              parallel2(),
              true);
   }
   else
   {
      kwl.add(prefix,
              ossimKeywordNames::SCALE_FACTOR_KW,
              theScaleFactor,
              true);
   }
}

projName()

const ossimString & ossimStatePlaneProjectionInfo::projName

(

)

const

Definition at line 122 of file ossimStatePlaneProjectionInfo.cpp.

References theProjectionName.

Referenced by operator<<(), ossimStatePlaneProjectionInfo(), and populateProjectionKeywords().

{
   return theProjectionName;
}

scaleFactor()

double ossimStatePlaneProjectionInfo::scaleFactor

(

)

const

Definition at line 167 of file ossimStatePlaneProjectionInfo.cpp.

References theScaleFactor.

Referenced by operator<<().

{
   return theScaleFactor;
}

units()

ossimString ossimStatePlaneProjectionInfo::units

(

)

const

Not stored as string; hence, returned by value.

Definition at line 172 of file ossimStatePlaneProjectionInfo.cpp.

References ossimLookUpTable::getEntryString(), ossimUnitTypeLut::instance(), and theUnits.

Referenced by ossimStatePlaneProjectionInfo().

{
   return ossimUnitTypeLut::instance()->getEntryString(theUnits);
}

Friends And Related Function Documentation

operator<<

OSSIM_DLL std::ostream& operator<< ( std::ostream &  os, const ossimStatePlaneProjectionInfo &  thePlane  )

friend

Definition at line 359 of file ossimStatePlaneProjectionInfo.cpp.

{
   if (thePlane.projName()== STATIC_TYPE_NAME(ossimTransMercatorProjection))
   {
      return  os << "ossimStatePlaneProjection: "
                 << "\nName:    " << thePlane.name()
                 << "\nPcsCode: " << thePlane.code()
                 << "\norigin:  " << thePlane.origin()
                 << "\nscale factor:  " << setprecision(12)
                 << thePlane.scaleFactor()
                 << "\nfalseEasting:   " << thePlane.falseEasting()
                 << "\nfalseNorthing:  " << thePlane.falseNorthing()
                 << endl;
   }
   else  // Lambert
   {
      return  os << "ossimStatePlaneProjection: "
                 << "\nName:    " << thePlane.name()
                 << "\nPcsCode: " << thePlane.code()
                 << "\norigin:  " << thePlane.origin()
                 << "\nphi1:    "
                 << setprecision(12) << thePlane.parallel1()
                 << "\nphi2:    "
                 << setprecision(12) << thePlane.parallel2()
                 << "\nfalseEasting:   " << thePlane.falseEasting()
                 << "\nfalseNorthing:  " << thePlane.falseNorthing()
                 << endl;
   }
}

Member Data Documentation

theDatum

const ossimDatum* ossimStatePlaneProjectionInfo::theDatum

private

Definition at line 86 of file ossimStatePlaneProjectionInfo.h.

Referenced by datum(), matchesProjection(), ossimStatePlaneProjectionInfo(), and populateProjectionKeywords().

theFalseEasting

double ossimStatePlaneProjectionInfo::theFalseEasting

private

Definition at line 95 of file ossimStatePlaneProjectionInfo.h.

Referenced by falseEasting(), falseEastingInMeters(), and populateProjectionKeywords().

theFalseNorthing

double ossimStatePlaneProjectionInfo::theFalseNorthing

private

Definition at line 96 of file ossimStatePlaneProjectionInfo.h.

Referenced by falseNorthing(), falseNorthingInMeters(), and populateProjectionKeywords().

theName

ossimString ossimStatePlaneProjectionInfo::theName

private

Definition at line 78 of file ossimStatePlaneProjectionInfo.h.

Referenced by name().

theOrigin

ossimGpt ossimStatePlaneProjectionInfo::theOrigin

private

Definition at line 90 of file ossimStatePlaneProjectionInfo.h.

Referenced by matchesProjection(), origin(), and ossimStatePlaneProjectionInfo().

theOriginLat

ossimDms ossimStatePlaneProjectionInfo::theOriginLat

private

Definition at line 88 of file ossimStatePlaneProjectionInfo.h.

Referenced by originLat(), and ossimStatePlaneProjectionInfo().

theOriginLon

ossimDms ossimStatePlaneProjectionInfo::theOriginLon

private

Definition at line 89 of file ossimStatePlaneProjectionInfo.h.

Referenced by originLon(), and ossimStatePlaneProjectionInfo().

theParameter3

double ossimStatePlaneProjectionInfo::theParameter3

private

Definition at line 92 of file ossimStatePlaneProjectionInfo.h.

Referenced by ossimStatePlaneProjectionInfo(), and parallel1().

theParameter4

double ossimStatePlaneProjectionInfo::theParameter4

private

Definition at line 93 of file ossimStatePlaneProjectionInfo.h.

Referenced by ossimStatePlaneProjectionInfo(), and parallel2().

thePcsCode

int ossimStatePlaneProjectionInfo::thePcsCode

private

Definition at line 77 of file ossimStatePlaneProjectionInfo.h.

Referenced by code(), isSameCode(), and populateProjectionKeywords().

theProjectionName

ossimString ossimStatePlaneProjectionInfo::theProjectionName

private

ossimLambertConformalConicProjection or ossimTransMercatorProjection

Definition at line 84 of file ossimStatePlaneProjectionInfo.h.

Referenced by matchesProjection(), ossimStatePlaneProjectionInfo(), and projName().

theScaleFactor

double ossimStatePlaneProjectionInfo::theScaleFactor

private

Definition at line 98 of file ossimStatePlaneProjectionInfo.h.

Referenced by matchesProjection(), ossimStatePlaneProjectionInfo(), populateProjectionKeywords(), and scaleFactor().

theUnits

ossimUnitType ossimStatePlaneProjectionInfo::theUnits

private

Definition at line 100 of file ossimStatePlaneProjectionInfo.h.

Referenced by falseEastingInMeters(), falseNorthingInMeters(), getUnitType(), ossimStatePlaneProjectionInfo(), populateProjectionKeywords(), and units().

---

The documentation for this class was generated from the following files:

• ossimStatePlaneProjectionInfo.h
• ossimStatePlaneProjectionInfo.cpp