setObject

The set object configures global properties within Spiral during scheduling. It can be issued at various stages, though scheduling constraints apply once optimisation has begun.

{

"time": <integer>,

"costSensitivity": <real>,

"staticStart": <bool>,

"staticGears": <bool>,

"clockInterval": <timeInterval>,

"hostClockResolution": <timeInterval>,

"hostClockSpread": <timeInterval>,

"atResolution": <distance>,

"debug": <integer>,

"responseLimit": <timeInterval>,

"licence": <string> | null,

"testMode": <bool>,

"simulation": <bool>,

"fragile": <bool>,

"schedule": <bool>,

"gear": <integer>,

"hostMode": SEQUENCE | TIMES,

"travelCalculator": <travelCalculatorObject>,

"ignore": { "<objectType>": [string] },

}

time integer: Set the internal UTC clock from a Unix timestamp (test scenarios).
costSensitivity real default 0.01: Minimum value-gain threshold for optimisation.
staticStart bool default false: Prevent pre-optimisation before the first host change.
staticGears bool default false: Disable automated gear changes.
clockInterval timeInterval default 1 s: Lowest granularity of the internal clock.
hostClockResolution timeInterval default 1 min: Schedule time resolution with the host.
hostClockSpread timeInterval default 10 s: Random event distribution period.
atResolution distance default 5 km: Location accuracy.
debug integer default 0: Diagnostic output level (0–4+).
responseLimit timeInterval default 2 s: Maximum optimisation response time.
licence string: Licence key.
testMode bool default false: Rapid processing with time adjustment.
simulation bool default false: Allow workload-scenario modelling.
fragile bool default false: Halt on warnings during development.
schedule bool default false: Initiate optimisation (issued once).
gear integer default 0: Force a gear level for testing.
hostMode SEQUENCE | TIMES default TIMES: Schedule communication style.
travelCalculator travelCalculatorObject: External travel-calculator configuration.
ignore { "<objectType>": [string] }: Attribute names Spiral should ignore (not echo back) per object type — keys are resource, project, desk, stop and responsePoint.

setObject

Related