#include <ossimBngProjection.h>

Inheritance diagram for ossimBngProjection:

Public Member Functions
	ossimBngProjection ()

virtual ossimObject *	dup () const

virtual ossimGpt	inverse (const ossimDpt &eastingNorthing) const
	Will take a point in meters and convert it to ground. More...

virtual ossimDpt	forward (const ossimGpt &latLon) const
	All map projections will convert the world coordinate to an easting northing (Meters). More...

virtual void	update ()

virtual bool	saveState (ossimKeywordlist &kwl, const char *prefix=0) const

virtual bool	loadState (const ossimKeywordlist &kwl, const char *prefix=0)

Public Member Functions inherited from ossimMapProjection
	ossimMapProjection (const ossimEllipsoid &ellipsoid=ossimEllipsoid(), const ossimGpt &origin=ossimGpt())

	ossimMapProjection (const ossimMapProjection &src)

virtual ossimGpt	origin () const

virtual ossimDpt	worldToLineSample (const ossimGpt &worldPoint) const

virtual void	worldToLineSample (const ossimGpt &worldPoint, ossimDpt &lineSample) const

virtual ossimGpt	lineSampleToWorld (const ossimDpt &projectedPoint) const

virtual void	lineSampleToWorld (const ossimDpt &projectedPoint, ossimGpt &gpt) const

virtual void	lineSampleHeightToWorld (const ossimDpt &lineSampPt, const double &heightAboveEllipsoid, ossimGpt &worldPt) const
	This is the pure virtual that projects the image point to the given elevation above ellipsoid, thereby bypassing reference to a DEM. More...

virtual void	lineSampleToEastingNorthing (const ossimDpt &liineSample, ossimDpt &eastingNorthing) const

virtual void	eastingNorthingToLineSample (const ossimDpt &eastingNorthing, ossimDpt &lineSample) const

virtual void	eastingNorthingToWorld (const ossimDpt &eastingNorthing, ossimGpt &worldPt) const

virtual double	getFalseEasting () const

virtual double	getFalseNorthing () const

virtual double	getStandardParallel1 () const
	Derived classes should implement as needed. More...

virtual double	getStandardParallel2 () const
	Derived classes should implement as needed. More...

virtual void	setPcsCode (ossim_uint32 pcsCode)

virtual ossim_uint32	getPcsCode () const
	Returns the EPSG PCS code or 32767 if the projection is a custom (non-EPSG) projection. More...

virtual ossimString	getProjectionName () const
	Returns the projection name. More...

virtual double	getA () const
	ACCESS METHODS: More...

virtual double	getB () const

virtual double	getF () const

virtual ossimDpt	getMetersPerPixel () const

virtual const ossimDpt &	getDecimalDegreesPerPixel () const
	Returns decimal degrees per pixel as an ossimDpt with "x" representing longitude and "y" representing latitude. More...

virtual const ossimDpt &	getUlEastingNorthing () const

virtual const ossimGpt &	getUlGpt () const

virtual const ossimDatum *	getDatum () const

const ossimEllipsoid &	getEllipsoid () const

const ossimGpt &	getOrigin () const

virtual bool	isGeographic () const

virtual void	applyScale (const ossimDpt &scale, bool recenterTiePoint)
	Applies scale to theDeltaLonPerPixel, theDeltaLatPerPixel and theMetersPerPixel data members (eg: theDeltaLonPerPixel *= scale.x). More...

virtual void	setEllipsoid (const ossimEllipsoid &ellipsoid)
	SET METHODS: More...

virtual void	setAB (double a, double b)

virtual void	setDatum (const ossimDatum *datum)
	Sets theDatum to datum. More...

virtual void	setOrigin (const ossimGpt &origin)
	Sets theOrigin to origin. More...

virtual void	setMetersPerPixel (const ossimDpt &gsd)

virtual void	setDecimalDegreesPerPixel (const ossimDpt &gsd)

virtual void	setUlTiePoints (const ossimGpt &gpt)

virtual void	setUlTiePoints (const ossimDpt &eastingNorthing)

virtual void	setUlEastingNorthing (const ossimDpt &ulEastingNorthing)

virtual void	setUlGpt (const ossimGpt &ulGpt)

virtual void	assign (const ossimProjection &aProjection)

virtual std::ostream &	print (std::ostream &out) const
	Prints data members to stream. More...

virtual bool	operator== (const ossimProjection &projection) const
	Compares this to arg projection and returns TRUE if the same. More...

virtual void	computeDegreesPerPixel ()
	Computes the approximate resolution in degrees/pixel. More...

virtual void	computeMetersPerPixel ()
	This will go from the ground point and give you an approximate meters per pixel. More...

void	setMatrix (double rotation, const ossimDpt &scale, const ossimDpt &translation)

void	setMatrixScale (const ossimDpt &scale)

void	setMatrixRotation (double rotation)

void	setMatrixTranslation (const ossimDpt &translation)

void	snapTiePointTo (ossim_float64 multiple, ossimUnitType unitType)
	Utility method to snap the tie point to some multiple. More...

void	snapTiePointToOrigin ()

void	setElevationLookupFlag (bool flag)

bool	getElevationLookupFlag () const

ossimUnitType	getModelTransformUnitType () const

void	setModelTransformUnitType (ossimUnitType unit)

bool	hasModelTransform () const

virtual bool	isAffectedByElevation () const
	Implementation of pure virtual ossimProjection::isAffectedByElevation method. More...

void	setProjectionUnits (ossimUnitType units)

ossimUnitType	getProjectionUnits () const
	OSSIM considers all map projection coordinates (including false eastings and northings) to be in meters. More...

virtual bool	isEqualTo (const ossimObject &obj, ossimCompareType compareType=OSSIM_COMPARE_FULL) const

Public Member Functions inherited from ossimProjection
	ossimProjection ()

virtual	~ossimProjection ()

virtual void	getRoundTripError (const ossimDpt &imagePoint, ossimDpt &errorResult) const

virtual void	getRoundTripError (const ossimGpt &groundPoint, ossimDpt &errorResult) const

virtual void	getGroundClipPoints (ossimGeoPolygon &gpts) const

virtual bool	operator!= (const ossimProjection &projection) const

Public Member Functions inherited from ossimObject
	ossimObject ()

virtual	~ossimObject ()

virtual ossimString	getShortName () const

virtual ossimString	getLongName () const

virtual ossimString	getDescription () const

virtual ossimString	getClassName () const

virtual RTTItypeid	getType () const

virtual bool	canCastTo (ossimObject *obj) const

virtual bool	canCastTo (const RTTItypeid &id) const

virtual bool	canCastTo (const ossimString &parentClassName) const

virtual void	accept (ossimVisitor &visitor)

Public Member Functions inherited from ossimReferenced
	ossimReferenced ()

	ossimReferenced (const ossimReferenced &)

ossimReferenced &	operator= (const ossimReferenced &)

void	ref () const
	increment the reference count by one, indicating that this object has another pointer which is referencing it. More...

void	unref () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

void	unref_nodelete () const
	decrement the reference count by one, indicating that a pointer to this object is referencing it. More...

int	referenceCount () const

Public Member Functions inherited from ossimErrorStatusInterface
	ossimErrorStatusInterface ()

virtual	~ossimErrorStatusInterface ()

virtual ossimErrorCode	getErrorStatus () const

virtual ossimString	getErrorStatusString () const

virtual void	setErrorStatus (ossimErrorCode error_status) const

virtual void	setErrorStatus () const

virtual void	clearErrorStatus () const

bool	hasError () const

Protected Member Functions
long	Find_Index (char letter, const char letter_Array, long index) const

long	Round_BNG (double value) const

long	Make_BNG_String (char ltrnum[4], long Easting, long Northing, char *BNG, long Precision) const

long	Break_BNG_String (char BNG, char Letters[3], double Easting, double Northing, long Precision) const

long	Check_Out_Of_Area (char BNG500, char BNG100) const

long	Set_BNG_Parameters (char *Ellipsoid_Code)

void	Get_BNG_Parameters (char *Ellipsoid_Code)

long	Convert_Geodetic_To_BNG (double Latitude, double Longitude, long Precision, char *BNG) const

long	Convert_BNG_To_Geodetic (char BNG, double Latitude, double *Longitude) const

long	Convert_Transverse_Mercator_To_BNG (double Easting, double Northing, long Precision, char *BNG) const

long	Convert_BNG_To_Transverse_Mercator (char BNG, double Easting, double *Northing) const

Protected Member Functions inherited from ossimMapProjection
virtual	~ossimMapProjection ()

void	updateFromTransform ()

Protected Member Functions inherited from ossimReferenced
virtual	~ossimReferenced ()

Protected Attributes
double	BNG_a

double	BNG_f

double	BNG_Origin_Lat

double	BNG_Origin_Long

double	BNG_False_Northing

double	BNG_False_Easting

double	BNG_Scale_Factor

long	string_Broken

Protected Attributes inherited from ossimMapProjection
ossimEllipsoid	theEllipsoid
	This method verifies that the projection parameters match the current pcs code. More...

ossimGpt	theOrigin

const ossimDatum *	theDatum
	This is only set if we want to have built in datum shifting. More...

ossimDpt	theMetersPerPixel
	Holds the number of meters per pixel. More...

ossimDpt	theDegreesPerPixel
	Hold the decimal degrees per pixel. More...

ossimGpt	theUlGpt
	Hold tie point in decimal degrees. More...

ossimDpt	theUlEastingNorthing
	Hold tie point as easting northing. More...

ossimDpt	theFalseEastingNorthing
	Hold the false easting northing. More...

ossim_uint32	thePcsCode
	Projection Coordinate System(PCS) code. More...

bool	theElevationLookupFlag

ossimMatrix4x4	theModelTransform

ossimMatrix4x4	theInverseModelTransform

ossimUnitType	theModelTransformUnitType

ossimUnitType	theProjectionUnits
	Linear units of the projection as indicated in the projection's specification: More...

Protected Attributes inherited from ossimErrorStatusInterface
ossimErrorCode	theErrorStatus

Detailed Description

Definition at line 11 of file ossimBngProjection.h.

Constructor & Destructor Documentation

◆ ossimBngProjection()

ossimBngProjection::ossimBngProjection ( )

Definition at line 49 of file ossimBngProjection.cpp.

References ossimDatumFactory::create(), ossimDatumFactory::instance(), string_Broken, ossimMapProjection::theDatum, and update().

    :ossimMapProjection(*ossimEllipsoidFactory::instance()->create("AA"),
                        ossimGpt(49.0, -2.0, ossim::nan(), 
                        ossimDatumFactory::instance()->create(ossimString("OGB-M"))))
 {
    string_Broken = 0;
    theDatum = ossimDatumFactory::instance()->create(ossimString("OGB-M"));
    update();
 }

Member Function Documentation

◆ Break_BNG_String()

long ossimBngProjection::Break_BNG_String	(	char *	BNG,
		char	Letters[3],
		double *	Easting,
		double *	Northing,
		long *	Precision
	)		const

protected

Definition at line 259 of file ossimBngProjection.cpp.

References BNG_NO_ERROR, BNG_STRING_ERROR, and n.

Referenced by Convert_BNG_To_Geodetic(), and Convert_BNG_To_Transverse_Mercator().

 { /* Break_BNG_String */
   long i = 0;
   long j;
   long num_digits = 0;
   long num_letters;
   long temp_error = 0;
   long length = (long)strlen(BNG);
   long error_code = BNG_NO_ERROR;
 
   string_Broken = 1;
   while (BNG[i] == ' ')
      i++;  /* skip any leading blanks */
   j = i;
   while (isalpha(BNG[i]))
     i++;
   num_letters = i - j;
   if (num_letters == 2)
   {
     /* get letters */
     Letters[0] = (char)toupper(BNG[j]);
     Letters[1] = (char)toupper(BNG[j+1]);
     Letters[2] = 0;
   }
   else
     error_code |= BNG_STRING_ERROR;
   if (!error_code)
   {
     error_code |= Check_Out_Of_Area(Letters[0], Letters[1]);
     while (BNG[i] == ' ')
       i++;
     j = i;
     if (BNG[length-1] == ' ')
       length --;
     while ((i < length) && (!temp_error))
     {
       if (isdigit(BNG[i]))
         i++;
       else
       {
          temp_error = BNG_STRING_ERROR;
       }
     }
     if (temp_error)
       error_code |= temp_error;
     if (!error_code)
     {
        num_digits = i - j;
       if ((num_digits <= 10) && (num_digits%2 == 0))
       {
         long n;
         char east_string[6];
         char north_string[6];
         long east;
         long north;
         double multiplier;
 
         /* get easting & northing */
         n = num_digits / 2;
         *Precision = n;
         if (n > 0)
         {
           strncpy (east_string, BNG+j, n);
           east_string[n] = 0;
           sscanf (east_string, "%ld", &east);
           strncpy (north_string, BNG+j+n, n);
           north_string[n] = 0;
           sscanf (north_string, "%ld", &north);
           multiplier = pow ((double)10.0,(double)( 5 - n));
           *Easting = east * multiplier;
           *Northing = north * multiplier;
         }
         else
         {
           *Easting = 0.0;
           *Northing = 0.0;
         }
       }
       else
         error_code |= BNG_STRING_ERROR;
     }
   }
   return (error_code);
 } /* Break_BNG_String */

◆ Check_Out_Of_Area()

long ossimBngProjection::Check_Out_Of_Area	(	char	BNG500,
		char	BNG100
	)		const

protected

Definition at line 349 of file ossimBngProjection.cpp.

References BNG_INVALID_AREA_ERROR, and BNG_NO_ERROR.

 { /* BEGIN Check_Out_Of_Area */
 /*
  * The function Check_Out_Of_Area checks if the 500,000 and 
  * 100,000 unit square identifications are within the valid area. If
  * they are not, an error code is returned, otherwise BNG_NO_ERROR 
  * is returned.
  *
  *    BNG500        : 500,000 square unit identification         
  *    BNG100        : 100,000 square unit identification         
  */
 
   long Error_Code = BNG_NO_ERROR;
 
   switch (BNG500)
   {
     case 'S':
       switch (BNG100)
       {
         case 'A':
         case 'F':
         case 'L':
           Error_Code |= BNG_INVALID_AREA_ERROR;
           break;
         default:
           break;
       }
       break;
     case 'N':
       switch (BNG100)
       {
         case 'V':
           Error_Code |= BNG_INVALID_AREA_ERROR;
           break;
         default:
           break;
       }
       break;
 
     case 'H':
       if (BNG100 < 'L')
         Error_Code |= BNG_INVALID_AREA_ERROR;
       break;
     case 'T':
       switch (BNG100)
       {
         case 'D':
         case 'E':
         case 'J':
         case 'K':
         case 'O':
         case 'P':
         case 'T':
         case 'U':
         case 'X':
         case 'Y':
         case 'Z':
           Error_Code |= BNG_INVALID_AREA_ERROR;
           break;
         default:
           break;
       }
       break;
     case 'O':
       switch (BNG100)
       {
         case 'C':
         case 'D':
         case 'E':
         case 'J':
         case 'K':
         case 'O':
         case 'P':
         case 'T':
         case 'U':
         case 'Y':
         case 'Z':
           Error_Code |= BNG_INVALID_AREA_ERROR;
           break;
         default:
           break;
       }
       break;
     case 'J':
       switch (BNG100)
       {
         case 'L':
         case 'M':
         case 'Q':
         case 'R':
         case 'V':
         case 'W':
           Error_Code = BNG_NO_ERROR;
           break;
         default:
           Error_Code |= BNG_INVALID_AREA_ERROR;
           break;
       }
       break;
     default:
       Error_Code |= BNG_INVALID_AREA_ERROR;
       break;
   }
   return Error_Code;
 } /* END OF Check_Out_Of_Area */

◆ Convert_BNG_To_Geodetic()

long ossimBngProjection::Convert_BNG_To_Geodetic	(	char *	BNG,
		double *	Latitude,
		double *	Longitude
	)		const

protected

The function Convert_BNG_To_Geodetic converts a BNG coordinate string to geodetic (latitude and longitude) coordinates, according to the current ellipsoid parameters. If any errors occur, the error code(s) are returned by the function, otherwise BNG_NO_ERROR is returned.

BNG : British National Grid coordinate string (input) Latitude : Latitude, in radians (output) Longitude : Longitude, in radians (output)

Definition at line 553 of file ossimBngProjection.cpp.

References BNG_NO_ERROR, and Break_BNG_String().

Referenced by inverse().

 { /* Convert_BNG_To_Geodetic */
 /*
  * The function Convert_BNG_To_Geodetic converts a BNG coordinate string 
  * to geodetic (latitude and longitude) coordinates, according to the current
  * ellipsoid parameters. If any errors occur, the error code(s) are returned 
  * by the function, otherwise BNG_NO_ERROR is returned. 
  * 
  *    BNG        : British National Grid coordinate string (input)
  *    Latitude   : Latitude, in radians                    (output)
  *    Longitude  : Longitude, in radians                   (output)
  *  
  */
 
   double TMEasting, TMNorthing;
   long in_Precision;
   long temp_Error = 0;
   long Error_Code = BNG_NO_ERROR;
   
   Error_Code |= Break_BNG_String(BNG, BNG_Letters, &BNG_Easting, &BNG_Northing, &in_Precision);
   
   if(!Error_Code)
   {
     Error_Code |= Convert_BNG_To_Transverse_Mercator(BNG, &TMEasting, &TMNorthing);
 
     if ((TMEasting < BNG_Min_Easting) || (TMEasting > BNG_Max_Easting))
       Error_Code |= BNG_INVALID_AREA_ERROR;
     if ((TMNorthing < BNG_Min_Northing) || (TMNorthing > BNG_Max_Northing))
       Error_Code |= BNG_INVALID_AREA_ERROR;
 
     if(!Error_Code)
     {
       temp_Error |= Convert_Transverse_Mercator_To_Geodetic(TMEasting, TMNorthing, Latitude, Longitude);
       
       if (temp_Error & TRANMERC_EASTING_ERROR)
         Error_Code |= BNG_EASTING_ERROR;
       if (temp_Error & TRANMERC_NORTHING_ERROR)
         Error_Code |= BNG_NORTHING_ERROR;
 
       if ((*Latitude < MIN_LAT) || (*Latitude > MAX_LAT))
         Error_Code|= BNG_INVALID_AREA_ERROR;
       if ((*Longitude < MIN_LON) || (*Longitude > MAX_LON))
         Error_Code|= BNG_INVALID_AREA_ERROR;
     }
   }
   return Error_Code;
 } /* END OF Convert_BNG_To_Geodetic */

◆ Convert_BNG_To_Transverse_Mercator()

long ossimBngProjection::Convert_BNG_To_Transverse_Mercator	(	char *	BNG,
		double *	Easting,
		double *	Northing
	)		const

protected

The function Convert_BNG_To_Transverse_Mercator converts a BNG coordinate string to Transverse Mercator projection (easting and northing) coordinates according to the current ellipsoid parameters. If any errors occur, the error code(s) are returned by the function, otherwise BNG_NO_ERROR is returned.

BNG : British National Grid coordinate string (input) Easting : Easting (X), in meters (output) Northing : Northing (Y), in meters (output)

Definition at line 693 of file ossimBngProjection.cpp.

References BNG_NO_ERROR, Break_BNG_String(), and string_Broken.

Referenced by forward().

 { /* Convert_BNG_To_Transverse_Mercator */
 /*
  * The function Convert_BNG_To_Transverse_Mercator converts a BNG coordinate string
  * to Transverse Mercator projection (easting and northing) coordinates 
  * according to the current ellipsoid parameters.  If any errors occur, 
  * the error code(s) are returned by the function, otherwise BNG_NO_ERROR 
  * is returned.
  *
  *    BNG        : British National Grid coordinate string (input)
  *    Easting    : Easting (X), in meters                  (output)
  *    Northing   : Northing (Y), in meters                 (output)
  */
   long northing_Offset, easting_Offset;
   long i = 0;
   long j = 0;
   long in_Precision;
   long Error_Code = BNG_NO_ERROR;
   
   if (!string_Broken)
   {
      Error_Code |= Break_BNG_String(BNG, BNG_Letters, &BNG_Easting, &BNG_Northing, &in_Precision);
   }
   if (!Error_Code)
   {
     Error_Code |= Find_Index(BNG_Letters[0], BNG500GRID, &i);
     if (!Error_Code)
     {
       northing_Offset = 500000 * (i / 2);
       easting_Offset = 500000 * (i % 2);
 
       Error_Code |= Find_Index(BNG_Letters[1], BNG100GRID, &j);
       if (!Error_Code)
       {
         northing_Offset += 100000 * (j / 5);
         easting_Offset += 100000 * (j % 5);
         
         *Easting = BNG_Easting + easting_Offset;
         *Northing = BNG_Northing + northing_Offset;
       }
     }
   }
   return Error_Code;
 } /* END OF Convert_BNG_To_Transverse_Mercator */

◆ Convert_Geodetic_To_BNG()

long ossimBngProjection::Convert_Geodetic_To_BNG	(	double	Latitude,
		double	Longitude,
		long	Precision,
		char *	BNG
	)		const

protected

The function Convert_Geodetic_To_BNG converts geodetic (latitude and longitude) coordinates to a BNG coordinate string, according to the current ellipsoid parameters. If any errors occur, the error code(s)
are returned by the function, otherwise BNG_NO_ERROR is returned.

Latitude : Latitude, in radians (input) Longitude : Longitude, in radians (input) Precision : Precision level of BNG string (input) BNG : British National Grid coordinate string (output)

Definition at line 502 of file ossimBngProjection.cpp.

References BNG_LAT_ERROR, BNG_LON_ERROR, BNG_NO_ERROR, Convert_Geodetic_To_Transverse_Mercator(), MAX_LAT, MAX_LON, MIN_LAT, and MIN_LON.

Referenced by forward().

 { /* BEGIN Convert_Geodetic_To_BNG */
 /*
  * The function Convert_Geodetic_To_BNG converts geodetic (latitude and
  * longitude) coordinates to a BNG coordinate string, according to the 
  * current ellipsoid parameters.  If any errors occur, the error code(s)  
  * are returned by the function, otherwise BNG_NO_ERROR is returned.
  * 
  *    Latitude   : Latitude, in radians                    (input)
  *    Longitude  : Longitude, in radians                   (input)
  *    Precision  : Precision level of BNG string           (input)
  *    BNG        : British National Grid coordinate string (output)
  *  
  */
   double TMEasting, TMNorthing;
   long Error_Code = BNG_NO_ERROR;
 
   if ((Latitude < MIN_LAT) || (Latitude > MAX_LAT))
   {  /* Latitude out of range */
     Error_Code|= BNG_LAT_ERROR;
   }
   if ((Longitude < MIN_LON) || (Longitude > MAX_LON))
   {  /* Longitude out of range */
     Error_Code|= BNG_LON_ERROR;
   }
 
   if (!Error_Code)
   { /* no errors */
 
      Error_Code |= Convert_Geodetic_To_Transverse_Mercator(Latitude, Longitude, &TMEasting, &TMNorthing);
      
     if ((TMEasting < 0.0) && (TMEasting > -2.0))
       TMEasting = 0.0;
     if ((TMNorthing < 0.0) && (TMNorthing > -2.0))
       TMNorthing = 0.0;
 
     if ((TMEasting < BNG_Min_Easting) || (TMEasting > BNG_Max_Easting))
       Error_Code |= BNG_INVALID_AREA_ERROR;
     if ((TMNorthing < BNG_Min_Northing) || (TMNorthing > BNG_Max_Northing))
       Error_Code |= BNG_INVALID_AREA_ERROR;
     
     if (!Error_Code)
       Error_Code |= Convert_Transverse_Mercator_To_BNG(TMEasting, TMNorthing, Precision, BNG);
   }
   return Error_Code;
 } /* END OF Convert_Geodetic_To_BNG */

◆ Convert_Transverse_Mercator_To_BNG()

long ossimBngProjection::Convert_Transverse_Mercator_To_BNG	(	double	Easting,
		double	Northing,
		long	Precision,
		char *	BNG
	)		const

protected

The function Convert_Transverse_Mercator_To_BNG converts Transverse Mercator (easting and northing) coordinates to a BNG coordinate string, according to the current ellipsoid parameters. If any errors occur, the error code(s) are returned by the function, otherwise BNG_NO_ERROR is returned.

Easting : Easting (X), in meters (input) Northing : Northing (Y), in meters (input) Precision : Precision level of BNG string (input) BNG : British National Grid coordinate string (output)

Definition at line 605 of file ossimBngProjection.cpp.

References BNG_NO_ERROR, x, and y.

Referenced by inverse().

 {/* BEGIN Convert_Transverse_Mercator_To_BNG */
 /*
  * The function Convert_Transverse_Mercator_To_BNG converts Transverse Mercator
  * (easting and northing) coordinates to a BNG coordinate string, according
  * to the current ellipsoid parameters.  If any errors occur, the error code(s)
  * are returned by the function, otherwise BNG_NO_ERROR is returned.
  *
  *    Easting    : Easting (X), in meters                  (input)
  *    Northing   : Northing (Y), in meters                 (input)
  *    Precision  : Precision level of BNG string           (input)
  *    BNG        : British National Grid coordinate string (output)
  */
 
   char letters[4];
   long x, y;
   long index;
   long temp_Easting, temp_Northing;
   long Error_Code = BNG_NO_ERROR;
 
   if ((Easting < BNG_Min_Easting) || (Easting > BNG_Max_Easting))
   { /* Easting out of range  */
     Error_Code |= BNG_EASTING_ERROR;
   }
   if ((Northing < BNG_Min_Northing) || (Northing > BNG_Max_Northing))
   { /* Northing out of range */
     Error_Code |= BNG_NORTHING_ERROR;
   }
 
   if (!Error_Code)
   { /* no errors */
     temp_Easting = Round_BNG(Easting);
     temp_Northing = Round_BNG(Northing);
 
     temp_Easting += 1000000; 
     temp_Northing += 500000;
 
     x = temp_Easting / 500000;
     y = temp_Northing / 500000;
     
     index = y * 5 + x;
     if ((index >= 0) && (index < 25))
     {
       letters[0] = BNG100GRID[index];
       temp_Easting %= 500000;
       temp_Northing %= 500000;
       x = temp_Easting / 100000;
       y = temp_Northing / 100000;
       index = y * 5 + x;
       if ((index >= 0) && (index < 25))
       {
         letters[1] = BNG100GRID[index];
         Error_Code |= Check_Out_Of_Area(letters[0], letters[1]);
         if (!Error_Code)
         {
           letters[2] = ' ';
           letters[3] = 0;
           temp_Easting %= 100000;
           temp_Northing %= 100000;
           Make_BNG_String(letters, temp_Easting, temp_Northing, BNG, Precision);
         }
       }
       else
       {
         long five_y = 5 * y;
         if ((x >= (25 - five_y)) || (x < -five_y))
           Error_Code |= BNG_EASTING_ERROR;
         if ((five_y >= (25 - x)) || (five_y < -x))
           Error_Code |= BNG_NORTHING_ERROR;
       }
     }
     else
     {
       long five_y = 5 * y;
       if ((x >= (25 - five_y)) || (x < -five_y))
         Error_Code |= BNG_EASTING_ERROR;
       if ((five_y >= (25 - x)) || (five_y < -x))
         Error_Code |= BNG_NORTHING_ERROR;
     }
   }
   return Error_Code;
 } /* END OF Convert_Transverse_Mercator_To_BNG */

◆ dup()

virtual ossimObject* ossimBngProjection::dup ( ) const

inlinevirtual

Implements ossimProjection.

Definition at line 16 of file ossimBngProjection.h.

       {
          return new ossimBngProjection(*this);
       }

◆ Find_Index()

long ossimBngProjection::Find_Index	(	char	letter,
		const char *	letter_Array,
		long *	index
	)		const

protected

Definition at line 171 of file ossimBngProjection.cpp.

References BNG_NO_ERROR, and BNG_STRING_ERROR.

 {
 /*
  * The function Find_Index searches for a given letter in an array. 
  * It returns the index of the letter in the array if the letter is found.
  * If the letter is not found, an error code is returned, otherwise
  * BNG_NO_ERROR is returned. 
  *
  *    letter              : Letter being searched for         
  *    letter_Array        : Array being searched         
  *    index               : Index of letter in array        
  */
   ossim_uint32 i = 0;
   ossim_uint32 not_Found = 1;
   ossim_uint32 length = (ossim_uint32)strlen(letter_Array);
   ossim_uint32 Error_Code = BNG_NO_ERROR;
 
   while ((i < length) && (not_Found))
   {
     if (letter == letter_Array[i])
     {
       *index = i;
       not_Found = 0;
     }
     i++;
   }
   if (not_Found)
     Error_Code = BNG_STRING_ERROR;
 
   return Error_Code;
 }

◆ forward()

ossimDpt ossimBngProjection::forward ( const ossimGpt & worldPoint ) const

virtual

All map projections will convert the world coordinate to an easting northing (Meters).

Implements ossimMapProjection.

Definition at line 85 of file ossimBngProjection.cpp.

References BNG_a, BNG_f, BNG_False_Easting, BNG_False_Northing, BNG_Origin_Lat, BNG_Origin_Long, BNG_Scale_Factor, Convert_BNG_To_Transverse_Mercator(), Convert_Geodetic_To_BNG(), ossimGpt::latr(), ossimGpt::lonr(), Set_Transverse_Mercator_Parameters(), and string_Broken.

 {
    char BNG[100];
 
    string_Broken = 0;
    Set_Transverse_Mercator_Parameters(BNG_a, BNG_f, BNG_Origin_Lat,
                                       BNG_Origin_Long, BNG_False_Easting, 
                                       BNG_False_Northing, BNG_Scale_Factor);
    
    Convert_Geodetic_To_BNG (latLon.latr(),
                             latLon.lonr(),
                             5,
                             BNG);
 
    ossimDpt en;
    
    Convert_BNG_To_Transverse_Mercator(BNG,
                       &en.x,
                       &en.y);
    
    return en;
 }

◆ Get_BNG_Parameters()

void ossimBngProjection::Get_BNG_Parameters ( char * Ellipsoid_Code )

protected

Definition at line 487 of file ossimBngProjection.cpp.

 { /* BEGIN Get_BNG_Parameters */
 /*                         
  * The function Get_BNG_Parameters returns the current ellipsoid
  * code.
  *
  *   Ellipsoid_Code : 2-letter code for ellipsoid          (output)
  */
 
   strcpy(Ellipsoid_Code, BNG_Ellipsoid_Code);
 
   return;
 } /* END OF Get_BNG_Parameters */

◆ inverse()

ossimGpt ossimBngProjection::inverse ( const ossimDpt & projectedPoint ) const

virtual

Will take a point in meters and convert it to ground.

Implements ossimMapProjection.

Definition at line 60 of file ossimBngProjection.cpp.

References BNG_a, BNG_f, BNG_False_Easting, BNG_False_Northing, BNG_Origin_Lat, BNG_Origin_Long, BNG_Scale_Factor, Convert_BNG_To_Geodetic(), Convert_Transverse_Mercator_To_BNG(), ossimGpt::latr(), ossimGpt::lonr(), ossim::nan(), Set_Transverse_Mercator_Parameters(), string_Broken, ossimMapProjection::theDatum, ossimDpt::x, and ossimDpt::y.

 {
    char s[100];
    double lat;
    double lon;
 
    string_Broken = 0;
    Set_Transverse_Mercator_Parameters(BNG_a, BNG_f, BNG_Origin_Lat,
                                       BNG_Origin_Long, BNG_False_Easting, 
                                       BNG_False_Northing, BNG_Scale_Factor);
    
    Convert_Transverse_Mercator_To_BNG(eastingNorthing.x,
                                       eastingNorthing.y,
                                       5,
                                       s);
    Convert_BNG_To_Geodetic(s,
                            &lat,
                            &lon);
    ossimGpt result(49, -2, ossim::nan(),theDatum);
    result.latr(lat);
    result.lonr(lon);
 
    return result;
 }

◆ loadState()

bool ossimBngProjection::loadState	(	const ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)

virtual

Method to the load (recreate) the state of an object from a keyword list. Return true if ok or false on error.

Reimplemented from ossimMapProjection.

Definition at line 159 of file ossimBngProjection.cpp.

References ossimMapProjection::loadState(), and update().

 {
    
    ossimMapProjection::loadState(kwl, prefix);
 
    update();
 
    return true;
 }

◆ Make_BNG_String()

long ossimBngProjection::Make_BNG_String	(	char	ltrnum[4],
		long	Easting,
		long	Northing,
		char *	BNG,
		long	Precision
	)		const

protected

Definition at line 218 of file ossimBngProjection.cpp.

References BNG_NO_ERROR, and Round_BNG().

 { /* Make_BNG_String */
 /* Construct a BNG string from its component parts */
   double divisor;
   long east;
   long north;
   long i;
   long j;
   double unitInterval;
   long error_code = BNG_NO_ERROR;
 
   i = 0;
   for (j = 0; j < 3; j++)
   {
      BNG[i++] = ltrnum[j];
   }
   
   divisor = pow ((double)10.0,(double) (5 - Precision));
   unitInterval = pow ((double)10.0, (double)Precision);
   east = Round_BNG (Easting/divisor);
   if (east == unitInterval)
     east -= 1;
   if ((Precision == 0) && (east == 1))
      east = 0;
   i += sprintf (BNG + i, "%*.*ld",(int) Precision,(int) Precision, east);
 
   north = Round_BNG (Northing/divisor);
   if (north == unitInterval)
     north -= 1;
   if ((Precision == 0) && (north == 1))
     north = 0;
   i += sprintf (BNG + i, "%*.*ld",(int)  Precision,(int) Precision, north);
 
   return (error_code);
 } /* Make_BNG_String */

◆ Round_BNG()

long ossimBngProjection::Round_BNG ( double value ) const

protected

Definition at line 205 of file ossimBngProjection.cpp.

Referenced by Make_BNG_String().

 { /* Round_BNG */
    double ivalue;
    long ival;
    double fraction = modf (value, &ivalue);
    ival = (long)(ivalue);
    if ((fraction > 0.5) || ((fraction == 0.5) && (ival%2 == 1)))
       ival++;
    
    return (ival);
 }

◆ saveState()

bool ossimBngProjection::saveState	(	ossimKeywordlist &	kwl,
		const char *	prefix = `0`
	)		const

virtual

Method to save the state of an object to a keyword list. Return true if ok or false on error.

Reimplemented from ossimMapProjection.

Definition at line 139 of file ossimBngProjection.cpp.

References ossimKeywordlist::add(), BNG_Scale_Factor, ossimObject::getClassName(), ossimMapProjection::saveState(), ossimKeywordNames::SCALE_FACTOR_KW, and ossimKeywordNames::TYPE_KW.

 {
    kwl.add(prefix,
            ossimKeywordNames::TYPE_KW,
            getClassName(),
            true);
    
    kwl.add(prefix,
            ossimKeywordNames::SCALE_FACTOR_KW,
        BNG_Scale_Factor,
            true);
 
    return ossimMapProjection::saveState(kwl, prefix);
 }

◆ Set_BNG_Parameters()

long ossimBngProjection::Set_BNG_Parameters ( char * Ellipsoid_Code )

protected

Definition at line 457 of file ossimBngProjection.cpp.

References BNG_NO_ERROR.

 { /* BEGIN Set_BNG_Parameters */
 /*
  * The function Set_BNG_Parameters receives the ellipsoid code and sets
  * the corresponding state variables. If any errors occur, the error code(s)
  * are returned by the function, otherwise BNG_NO_ERROR is returned.
  *
  *   Ellipsoid_Code : 2-letter code for ellipsoid           (input)
  */
 
   long Error_Code = BNG_NO_ERROR;
 
   if (strcmp(Ellipsoid_Code, Airy) != 0)
   { /* Ellipsoid must be Airy */
     Error_Code |= BNG_ELLIPSOID_ERROR;
   }
     
   if (!Error_Code)
   { /* no errors */
     strcpy(BNG_Ellipsoid_Code, Ellipsoid_Code);
     string_Broken = 0;
 
     Set_Transverse_Mercator_Parameters(BNG_a, BNG_f, BNG_Origin_Lat,
                                        BNG_Origin_Long, BNG_False_Easting, 
                                        BNG_False_Northing, BNG_Scale_Factor);
   }
   return (Error_Code);
 }  /* END of Set_BNG_Parameters  */

◆ update()

void ossimBngProjection::update ( )

virtual

Reimplemented from ossimMapProjection.

Definition at line 108 of file ossimBngProjection.cpp.

References BNG_a, BNG_f, BNG_False_Easting, BNG_False_Northing, BNG_Origin_Lat, BNG_Origin_Long, BNG_Scale_Factor, M_PI, ossim::nan(), ossimMapProjection::theDatum, ossimMapProjection::theFalseEastingNorthing, ossimMapProjection::theOrigin, ossimMapProjection::update(), ossimDpt::x, and ossimDpt::y.

Referenced by loadState(), and ossimBngProjection().

 {
    BNG_Origin_Lat     = (49.0 * M_PI / 180.0);
    BNG_Origin_Long    = (-2.0 * M_PI / 180.0);
    BNG_False_Northing = -100000.0;
    BNG_False_Easting  = 400000.0;
    BNG_Scale_Factor   = .9996012717;
    BNG_a              = 6377563.396;
    BNG_f              = 1 / 299.324964600;
 
    //      ossimString code = theDatum->code();
       //   if(code.upcase().contains("OGB"))
    //     {
 
    theOrigin = ossimGpt(49.0, -2.0, ossim::nan(), theDatum);
    theFalseEastingNorthing.x = BNG_False_Easting;
    theFalseEastingNorthing.y = BNG_False_Northing;
 
        //     }
    //   else
 //      {
 //        theOrigin = ossimGpt(49.0, -2.0, ossim::nan(), ossimDatumFactory::instance()->create("OGB-7"));      
 //      }
    
    ossimMapProjection::update();
 }

Member Data Documentation

◆ BNG_a

double ossimBngProjection::BNG_a

protected

Definition at line 41 of file ossimBngProjection.h.

Referenced by forward(), inverse(), and update().

◆ BNG_f

double ossimBngProjection::BNG_f

protected

Definition at line 42 of file ossimBngProjection.h.

Referenced by forward(), inverse(), and update().

◆ BNG_False_Easting

double ossimBngProjection::BNG_False_Easting

protected

Definition at line 48 of file ossimBngProjection.h.

Referenced by forward(), inverse(), and update().

◆ BNG_False_Northing

double ossimBngProjection::BNG_False_Northing

protected

Definition at line 47 of file ossimBngProjection.h.

Referenced by forward(), inverse(), and update().

◆ BNG_Origin_Lat

double ossimBngProjection::BNG_Origin_Lat

protected

Definition at line 45 of file ossimBngProjection.h.

Referenced by forward(), inverse(), and update().

◆ BNG_Origin_Long

double ossimBngProjection::BNG_Origin_Long

protected

Definition at line 46 of file ossimBngProjection.h.

Referenced by forward(), inverse(), and update().

◆ BNG_Scale_Factor

double ossimBngProjection::BNG_Scale_Factor

protected

Definition at line 49 of file ossimBngProjection.h.

Referenced by forward(), inverse(), saveState(), and update().

◆ string_Broken

long ossimBngProjection::string_Broken

mutableprotected

Definition at line 50 of file ossimBngProjection.h.

Referenced by Convert_BNG_To_Transverse_Mercator(), forward(), inverse(), and ossimBngProjection().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ossimBngProjection()

Member Function Documentation

◆ Break_BNG_String()

◆ Check_Out_Of_Area()

◆ Convert_BNG_To_Geodetic()

◆ Convert_BNG_To_Transverse_Mercator()

◆ Convert_Geodetic_To_BNG()

◆ Convert_Transverse_Mercator_To_BNG()

◆ dup()

◆ Find_Index()

◆ forward()

◆ Get_BNG_Parameters()

◆ inverse()

◆ loadState()

◆ Make_BNG_String()

◆ Round_BNG()

◆ saveState()

◆ Set_BNG_Parameters()

◆ update()

Member Data Documentation

◆ BNG_a

◆ BNG_f

◆ BNG_False_Easting

◆ BNG_False_Northing

◆ BNG_Origin_Lat

◆ BNG_Origin_Long

◆ BNG_Scale_Factor

◆ string_Broken