IofControl

Types

controlType

The role a control plays on a course.

type controlType =
  | Start
  | Finish
  | Control
  | CrossingPoint
  | EndOfMarkedRoute

Constructors:

• Start
• Finish
• Control
• CrossingPoint
• EndOfMarkedRoute

geoPosition

A georeferenced position using WGS84 coordinates from IOF GeoPosition.

type geoPosition = {
  lng: float,
  lat: float,
  alt: option<float>,
}

Fields:

• lng: float
• lat: float
• alt: option<float>

mapPosition

A position in the map coordinate system.

type mapPosition = {
  x: float,
  y: float,
  unit: option<string>,
}

Fields:

• x: float
• y: float
• unit: option<string>

t

A physical control on the terrain, identified by its control code.

See: Control in the IOF XML 3.0 XSD

type t = {
  id: string,
  punchingUnitIds: array<string>,
  name: option<string>,
  position: option<geoPosition>,
  mapPosition: option<mapPosition>,
  controlType: controlType,
  modifyTime: option<string>,
}

Fields:

• id: string — The control code, e.g. "32".
• punchingUnitIds: array<string> — Punching unit ids associated with this control.
• name: option<string> — A human-readable control name, if supplied.
• position: option<geoPosition> — The control's georeferenced position.
• mapPosition: option<mapPosition> — The control's position in the map coordinate system.
• controlType: controlType — The role this control plays.
• modifyTime: option<string> — The IOF modifyTime attribute, if supplied.

Values

parseControlType

let parseControlType: string => controlType

controlTypeToString

let controlTypeToString: controlType => string

parseGeoPosition

let parseGeoPosition: IofXml.XmlUtils.xmlElement => option<geoPosition>

parseMapPosition

let parseMapPosition: IofXml.XmlUtils.xmlElement => option<mapPosition>

parse

let parse: IofXml.XmlUtils.xmlElement => option<t>