ICoordinateOperationParametersGeneric

Description

interface Tinman.Terrain.Georef.ICoordinateOperationParametersGeneric
→ <T out ref : ICoordinateOperationParametersGeneric<T>>

Derived from

ICoordinateOperationParameters

Extended by

CoordinateOperation sealed
CoordinateSystemBuilderOperation sealed

Base interface for classes that contain coordinate operation parameters values.

Public / Methods

Clear

public method Clear → (1)

parameter in : CoordinateOperationParameter

The parameter.

returns → T

this

Clears the given parameter.

Set

public method Set → (4)

parameter in : CoordinateOperationParameter

The parameter.

value in : float64

The parameter value.

unit opt : UnitOfMeasure = null

The value unit. If null or if value in is 0, the default unit of the parameter will be used (see CoordinateOperation.ParameterType).

flags opt : CoordinateSystemFlags = CoordinateSystemFlags.None

The coordinate system flags to use for flipping the sign of parameter values, see GeorefUtil.IsDepth, GeorefUtil.IsSouthing and GeorefUtil.IsWesting.

returns → T

this

Sets the given parameter.

If parameter in is ignored, the given value in is ignored and the method returns silently.

See also

UnitOfMeasure.Default
ICoordinateOperationParameters.SetFix

Extensions

Clear­All

public static method ClearAll → ()
→ <T ref : ICoordinateOperationParametersGeneric<T>>

returns → T

this

Clears all parameter values.

See also

ICoordinateOperationParametersGeneric.Clear

Set­Default

public static method SetDefault → (3)
→ <T ref : ICoordinateOperationParametersGeneric<T>>

parameter in : CoordinateOperationParameter

The parameter.

value in : float64

The parameter value.

unit opt : UnitOfMeasure = null

The value unit or null to use the default.

Sets the given default value for an undefined parameter.

This method first calls ICoordinateOperationParameters.Has to check whether parameter in has a value. If it does not, the method delegates to ICoordinateOperationParametersGeneric.Set, passing value in and unit opt.

See also

UnitOfMeasure.Default
ICoordinateOperationParameters.SetFix

Set­Easting­Northing

public static method SetEastingNorthing → (1)
→ <T ref : ICoordinateOperationParametersGeneric<T>>

eastingNorthing in : Vec2D

The parameter values, in metres.

returns → T

this

Sets the CoordinateOperationParameter.Easting and CoordinateOperationParameter.Northing parameters.

See also

ICoordinateOperationParametersGeneric.Set

Set­Fix

public static method SetFix → (4)
→ <T ref : ICoordinateOperationParametersGeneric<T>>

parameter in : CoordinateOperationParameter

The parameter.

value in : float64

The parameter value.

unit in : UnitOfMeasure

The value unit. If null or if value in is 0, the default unit of the parameter will be used (see CoordinateOperation.ParameterType).

semantic in : int32

The semantic of parameter in:
0 : no semantic,
1 : latitude of natural origin (EPSG 8801),
2 : Latitude of false origin (EPSG 8821)

returns → bool

true if a new parameter value has been set,
false if an existing parameter value has been replaced.

Sets the given parameter after fixing potential conflicts.

In some rare cases, the mapping defined by CoordinateOperationParameter produces conflicts where two values are mapped to a single parameter. Use the semantic in parameter to apply the built-in logic for resolving such conflicts. This method delegates to ICoordinateOperationParametersGeneric.Set to set the parameter value.

See also

UnitOfMeasure.Default

Set­Latitude­Longitude

public static method SetLatitudeLongitude → (1)
→ <T ref : ICoordinateOperationParametersGeneric<T>>

latLon in : LatLon

The parameter values.

returns → T

this

Sets the CoordinateOperationParameter.Latitude and CoordinateOperationParameter.Longitude parameters.

See also

ICoordinateOperationParametersGeneric.Set