CourseData

Types

classCourseAssignment

An assignment of a class to a named course within a race.

type classCourseAssignment = {
  className: string,
  classId: option<string>,
  courseName: string,
}

Fields:

• className: string
• classId: option<string>
• courseName: string

raceCourseData

Course data for a single race in an event.

See: RaceCourseData in the IOF XML 3.0 XSD

type raceCourseData = {
  raceNumber: option<int>,
  courses: array<IofXml.IofCourse.t>,
  classAssignments: array<classCourseAssignment>,
}

Fields:

• raceNumber: option<int> — The ordinal race number in a multi-race event, starting at 1.
• courses: array<IofXml.IofCourse.t>
• classAssignments: array<classCourseAssignment> — Class-to-course assignments for this race.

t

Course and control information for an event, used to transfer data from course-setting software to event administration software.

See: CourseData in the IOF XML 3.0 XSD

type t = {
  event: option<IofXml.IofEvent.t>,
  raceCourseData: array<raceCourseData>,
}

Fields:

• event: option<IofXml.IofEvent.t>
• raceCourseData: array<raceCourseData> — Course data per race; one element per race in the event.

Values

parseClassAssignment

let parseClassAssignment: IofXml.XmlUtils.xmlElement => option<classCourseAssignment>

parseRaceCourseData

let parseRaceCourseData: (IofXml.XmlUtils.xmlElement, int) => raceCourseData

parse

Parse an IOF XML 3.0 CourseData document string into a typed structure.

let parse: string => result<t, string>

serializeCourseControl

let serializeCourseControl: IofXml.IofCourse.courseControl => string

serializeCourse

let serializeCourse: IofXml.IofCourse.t => string

serializeAssignment

let serializeAssignment: classCourseAssignment => string

serializeRaceCourseData

let serializeRaceCourseData: raceCourseData => string

serializeEvent

let serializeEvent: IofXml.IofEvent.t => string

serialize

Serialize a CourseData structure to an IOF XML 3.0 document string.

let serialize: t => string