TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual

class CoordinateOperation in Tinman.Terrain.Georef

A horizontal coordinate operation (i.e. map projection).

sealed class CoordinateOperation extends GeoObject
  implements ICoordinateOperation
  ICoordinateOperationParameters

See also:

GeoRegistry

Configuration

Config

The configurator object for this type.

public static property Config { get }
type IConfigurator<ICoordinateOperation>
value [not-null] The configurator object.

ToConfig

Returns the configuration value that describes this object.

public override method ToConfig ()
type ConfigValue
returns [not-null] The configuration value.
overrides GeoObject.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

Serialization

SerialId

Serialization information about this type.

public static readonly field SerialId
type ISerialTypeInfo

Public / Constants

FirstParameter

public constant FirstParameter = CoordinateOperationParameter.Angle
type CoordinateOperationParameter

LastParameter

public constant LastParameter = CoordinateOperationParameter.Scale
type CoordinateOperationParameter

ParameterCount

public constant ParameterCount = 9
type int32

Public / Attributes

Method

The coordinate operation method.

public property Method { get }
type CoordinateOperationMethod
value [not-null] The CoordinateOperationMethod object that represents the coordinate operation method.

Name

The human-readable name of this object.

public property Name { get }
type string
value [not-empty] The object name.
inherited GeoObject.Name

SerialType

Returns the serial type of this object.

public property SerialType { get }
type ISerialTypeInfo
value [not-null] The serial type.
inherited SerializableBase.SerialType

SerialVersion

Returns the serial data version.

public virtual property SerialVersion { get }
type int32
value [>=1] The serial data version tag.
inherited SerializableBase.SerialVersion

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Type

The type of this geo object.

public property Type { get }
type GeoObjectType
value The geo object type.
inherited GeoObject.Type

Public / Constructors

CoordinateOperation

Creates a new instance of CoordinateOperation.

public constructor CoordinateOperation (CoordinateOperationMethod method, string name = null)
params method [not-null] The coordinate operation method.
  name Human-readable name of the geo object. If empty or null, UserDefined will be used instead. Defaults to null.

Public / Methods

Clear

Clears the given parameter.

public method Clear (CoordinateOperationParameter parameter)
type CoordinateOperation
params parameter The parameter.
returns [not-null] this

CreateCoordinateTransform

Creates a new instance of ICoordinateTransform for the given ellipsoid.

public method CreateCoordinateTransform (Ellipsoid ellipsoid)
type ICoordinateTransform
params ellipsoid [not-null] The ellipsoid.
returns [not-null] The coordinate transform.
implements ICoordinateOperation.CreateCoordinateTransform

Deserialize

Initializes the state of this object from the given data stream.

public override method Deserialize (int32 serialVersion, ISerializer data)
type ISerializable
params serialVersion [>=1] The serial data version.
  data [not-null] The serial data stream.
returns [not-null] The deserialized object. This will typically be this, but in some circumstances, another instance may be returned (e.g. singletons).
overrides GeoObject.Deserialize

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion

Equals

Compares this object with the given one.

[Pure]
public override method Equals (IGeoObject other)
type bool
params other The object to compare to.
returns true if this object is equal to other, false if not.
overrides GeoObject.Equals

Compares this object with the given one.

[Pure]
public override sealed method Equals (object other)
type bool
params other The object to compare to.
returns true if this object is equal to other, false if not.
inherited GeoObject.Equals

Get

Returns the value of the given parameter.

public method Get (CoordinateOperationParameter parameter, UnitOfMeasure unit = null)
type float64
params parameter The parameter.
  unit The unit to return or null. Defaults to null.
returns The parameter value.
implements ICoordinateOperationParameters.Get

GetHashCode

[Pure]
public override sealed method GetHashCode ()
type int32
inherited GeoObject.GetHashCode

Has

Does the given parameter have a value?

public method Has (CoordinateOperationParameter parameter)
type bool
params parameter The parameter.
returns true if the parameter has a value, false if it has not been specified.
implements ICoordinateOperationParameters.Has

ParameterName

Returns the human-readable name of the given parameter.

public static method ParameterName (CoordinateOperationParameter parameter)
type string
params parameter The parameter.
returns [not-null] The parameter name.

ParameterType

Returns the unit type of the given parameter.

public static method ParameterType (CoordinateOperationParameter parameter)
type UnitOfMeasureType
params parameter The parameter.
returns The unit type.

Serialize

Serializes the current state of this object to the given data stream.

public override method Serialize (ISerializer data)
params data [not-null] The serial data stream.
overrides GeoObject.Serialize

See also:

ISerializable.Deserialize
ISerializable.SerialVersion

Set

Sets the Latitude and Longitude parameters.

public method Set (LatLon latLon)
type CoordinateOperation
params latLon The parameter value.
returns [not-null] this

Sets the given parameter.

public method Set (CoordinateOperationParameter parameter, float64 value, UnitOfMeasure unit = null)
type CoordinateOperation
params parameter The parameter.
  value The parameter value.
  unit The value unit. If null, the default unit of the parameter will be used (see ParameterType). Defaults to null.
returns [not-null] this

ToString

[Pure]
public override sealed method ToString ()
type string
inherited GeoObject.ToString