Luciad.Grids.Mgrs.MgrsFormat.Builder Class Reference

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

Inheritance diagram for Luciad.Grids.Mgrs.MgrsFormat.Builder:

Public Member Functions
	Builder (Luciad.Grids.Mgrs.MgrsFormat.Builder other)
Luciad.Grids.Mgrs.MgrsFormat	Build ()
	Creates the MGRS format, based on the properties set on this builder. More...
Luciad.Grids.Mgrs.MgrsFormat.Builder	CoordinateSeparator (string coordinateSeparator)
	Sets the string to separate the zone/grid letters and the coordinates. More...
void	Dispose ()
Luciad.Grids.Mgrs.MgrsFormat.Builder	FormatType (Luciad.Grids.Mgrs.MgrsFormatType formatType)
	Sets the luciad::MgrsFormatType. More...
Luciad.Grids.Mgrs.MgrsFormat.Builder	Precision (Luciad.Grids.Mgrs.MgrsFormatPrecision precision)
	Sets the luciad::MgrsFormatPrecision used to format an MGRS or UTM/UPS string. More...
Luciad.Grids.Mgrs.MgrsFormat.Builder	ZoneSeparator (string zoneSeparator)
	Sets the string to use as zoneSeparator between the grid zone and the 100km squares when formatting MGRS strings. More...

Detailed Description

Builder for creating luciad::MgrsFormat.

Example usage:

            MgrsFormat mgrsFormat = MgrsFormat.NewBuilder()
                                      .Precision(MgrsFormatPrecision.Precision1M)
                                      .FormatType(MgrsFormatType.Mgrs)
                                      .ZoneSeparator(" ")
                                      .CoordinateSeparator(" ")
                                      .Build();

Warning

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

Constructor & Destructor Documentation

Builder()

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

inline

Member Function Documentation

Build()

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

inline

Creates the MGRS format, based on the properties set on this builder.

the MGRS format, based on the properties set on this builder.

luciad::LogicException

if the set precision is not compatible with the format type.

Warning

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

CoordinateSeparator()

Luciad.Grids.Mgrs.MgrsFormat.Builder Luciad.Grids.Mgrs.MgrsFormat.Builder.CoordinateSeparator ( string  coordinateSeparator )

inline

Sets the string to separate the zone/grid letters and the coordinates.

coordinateSeparator

the coordinateSeparator. If not set, default is an empty string.

this builder.

Warning

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

Dispose()

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

inline

FormatType()

Luciad.Grids.Mgrs.MgrsFormat.Builder Luciad.Grids.Mgrs.MgrsFormat.Builder.FormatType ( Luciad.Grids.Mgrs.MgrsFormatType  formatType )

inline

Sets the luciad::MgrsFormatType.

formatType

this builder.

Warning

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

Precision()

Luciad.Grids.Mgrs.MgrsFormat.Builder Luciad.Grids.Mgrs.MgrsFormat.Builder.Precision ( Luciad.Grids.Mgrs.MgrsFormatPrecision  precision )

inline

Sets the luciad::MgrsFormatPrecision used to format an MGRS or UTM/UPS string.

luciad::MgrsFormatPrecision::Precision1000KM and luciad::MgrsFormatPrecision::PrecisionGridZone may not be used when the format type is set to luciad::MgrsFormatType::Mgrs.

precision

the precision. If not set, deafault is luciad::MgrsFormatPrecision::Precision1M.

this builder.

Warning

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

ZoneSeparator()

Luciad.Grids.Mgrs.MgrsFormat.Builder Luciad.Grids.Mgrs.MgrsFormat.Builder.ZoneSeparator ( string  zoneSeparator )

inline

Sets the string to use as zoneSeparator between the grid zone and the 100km squares when formatting MGRS strings.

zoneSeparator

the zoneSeparator. If not set, default is an empty string.

this builder.

Warning

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