Skip to main content

Module inputs

Module inputs 

Source
Expand description

Checking the inputs before anything is read (ADR-0015).

Contract: validate and InputsError.

Every refusal names the field and the value it found: a width of -3 is said as such, never as “invalid settings”. The checks go one step past what the type says, to what the calculation downstream would refuse in its own words (Corridor wants a width on at least one side and no zero-length segment): refusing here keeps the message about the inputs.

Enums§

InputsError
Inputs that cannot make a catalogue - each refusal names what is wrong.

Constants§

MAX_CROSSES
The most cross sections one set of inputs may ask for: a guard against a spacing of a millimetre on a trace of kilometres, not a limit anyone meets.

Functions§

validate
Whether these inputs can make a catalogue.