Luciad.Grids.Mgrs.MgrsFormat Class Reference

Class to format points as MGRS or UTM/UPS coordinates. More...

Inheritance diagram for Luciad.Grids.Mgrs.MgrsFormat:

Classes
class	Builder
	Builder for creating luciad::MgrsFormat. More...

Public Member Functions
	MgrsFormat (Luciad.Grids.Mgrs.MgrsFormat other)
Luciad.Grids.Mgrs.MgrsFormat.Builder	AsBuilder ()
	Creates a new builder initialized with all the properties of this style. More...
void	Dispose ()
string	Format (Luciad.Geometries.Point lonLatPoint)
	Formats the given point or the given (lon,lat) pair as an MGRS or UTM/UPS coordinate string. More...
Luciad.Geometries.Point	Parse (string coordinateString)
	Parses the given MGRS or UTM/UPS coordinate string into a point with WGS84 lon lat coordinates. More...

Static Public Member Functions
static Luciad.Grids.Mgrs.MgrsFormat.Builder	NewBuilder ()
	Creates a new builder with the default values. More...

Properties
string	CoordinateSeparator [get]
Luciad.Grids.Mgrs.MgrsFormatType	FormatType [get]
Luciad.Grids.Mgrs.MgrsFormatPrecision	Precision [get]
string	ZoneSeparator [get]

Detailed Description

Class to format points as MGRS or UTM/UPS coordinates.

This class offers methods to format coordinates into either UTM MGRS, UPS MGRS, UTM or UPS notation. The UTM MGRS and UTM notations are used for coordinates within the UTM latitude bounds. For points in the polar regions, outside the UTM latitude bounds, the UPS MGRS and UPS notations are used. Construction of this class is done through the Builder design pattern mechanism. Example usage:

2023.1

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsFormat.

Constructor & Destructor Documentation

MgrsFormat()

Luciad.Grids.Mgrs.MgrsFormat.MgrsFormat ( Luciad.Grids.Mgrs.MgrsFormat  other )

inline

Member Function Documentation

AsBuilder()

Luciad.Grids.Mgrs.MgrsFormat.Builder Luciad.Grids.Mgrs.MgrsFormat.AsBuilder ( )

inline

Creates a new builder initialized with all the properties of this style.

the new builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsFormat::asBuilder.

Dispose()

void Luciad.Grids.Mgrs.MgrsFormat.Dispose ( )

inline

Format()

string Luciad.Grids.Mgrs.MgrsFormat.Format ( Luciad.Geometries.Point  lonLatPoint )

inline

Formats the given point or the given (lon,lat) pair as an MGRS or UTM/UPS coordinate string.

lonLatPoint

the point to be formatted. The reference of the point must be WGS84.

the formatted string.

luciad::InvalidArgumentException

when the the point cannot be formatted.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsFormat::format.

NewBuilder()

Luciad.Grids.Mgrs.MgrsFormat.Builder Luciad.Grids.Mgrs.MgrsFormat.NewBuilder ( )

inlinestatic

Creates a new builder with the default values.

the new builder.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsFormat::newBuilder.

Parse()

Luciad.Geometries.Point Luciad.Grids.Mgrs.MgrsFormat.Parse ( string  coordinateString )

inline

Parses the given MGRS or UTM/UPS coordinate string into a point with WGS84 lon lat coordinates.

coordinateString

a MGRS coordinate string

the coordinate reference.

luciad::ParseException

when the coordinate string cannot be parsed.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MgrsFormat::parse.

Property Documentation

CoordinateSeparator

string Luciad.Grids.Mgrs.MgrsFormat.CoordinateSeparator

get

FormatType

Luciad.Grids.Mgrs.MgrsFormatType Luciad.Grids.Mgrs.MgrsFormat.FormatType

get

Precision

Luciad.Grids.Mgrs.MgrsFormatPrecision Luciad.Grids.Mgrs.MgrsFormat.Precision

get

ZoneSeparator

string Luciad.Grids.Mgrs.MgrsFormat.ZoneSeparator

get