luciad::MgrsFormat::Builder Class Reference

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

#include <luciad/grids/mgrs/MgrsFormat.h>

Public Member Functions
	Builder (const Builder &other)
	~Builder ()
MgrsFormat	build () const
	Creates the MGRS format, based on the properties set on this builder. More...
Builder &	coordinateSeparator (std::string coordinateSeparator)
	Sets the string to separate the zone/grid letters and the coordinates. More...
Builder &	formatType (MgrsFormatType formatType)
	Sets the luciad::MgrsFormatType. More...
Builder &	precision (MgrsFormatPrecision precision)
	Sets the luciad::MgrsFormatPrecision used to format an MGRS or UTM/UPS string. More...
Builder &	zoneSeparator (std::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();

Constructor & Destructor Documentation

Builder()

luciad::MgrsFormat::Builder::Builder

(

const Builder &

other

)

~Builder()

luciad::MgrsFormat::Builder::~Builder

(

)

Member Function Documentation

build()

MgrsFormat luciad::MgrsFormat::Builder::build

(

)

const

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

Returns

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

Exceptions

luciad::LogicException

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

coordinateSeparator()

Builder & luciad::MgrsFormat::Builder::coordinateSeparator

(

std::string

coordinateSeparator

)

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

Parameters

coordinateSeparator

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

Returns

this builder.

formatType()

Builder & luciad::MgrsFormat::Builder::formatType

(

MgrsFormatType

formatType

)

Sets the luciad::MgrsFormatType.

Parameters

formatType

Returns

this builder.

precision()

Builder & luciad::MgrsFormat::Builder::precision

(

MgrsFormatPrecision

precision

)

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.

Parameters

precision

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

Returns

this builder.

zoneSeparator()

Builder & luciad::MgrsFormat::Builder::zoneSeparator

(

std::string

zoneSeparator

)

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

Parameters

zoneSeparator

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

Returns

this builder.