ui/blueskylogging/createLogCommands¶

Interfaces¶

LogVariablePreset¶

Defined in: ui/blueskylogging/createLogCommands.ts:12

A preset variable offered as a checkbox in the Create Log dialog. name is the dotted BlueSky variable-explorer name sent to the server (LOGNAME ADD <name>); desc is the human-readable label shown next to it.

Properties¶

name¶

name: string;

Defined in: ui/blueskylogging/createLogCommands.ts:13

desc¶

desc: string;

Defined in: ui/blueskylogging/createLogCommands.ts:14

checked?¶

optional checked?: boolean;

Defined in: ui/blueskylogging/createLogCommands.ts:15

CreateLogSpec¶

Defined in: ui/blueskylogging/createLogCommands.ts:44

Everything needed to create one BlueSky data logger.

Properties¶

name¶

name: string;

Defined in: ui/blueskylogging/createLogCommands.ts:45

dt¶

dt: number;

Defined in: ui/blueskylogging/createLogCommands.ts:46

header¶

header: string;

Defined in: ui/blueskylogging/createLogCommands.ts:47

variables¶

variables: string[];

Defined in: ui/blueskylogging/createLogCommands.ts:48

startNow¶

startNow: boolean;

Defined in: ui/blueskylogging/createLogCommands.ts:49

Variables¶

LOG_VARIABLE_PRESETS¶

const LOG_VARIABLE_PRESETS: readonly LogVariablePreset[];

Defined in: ui/blueskylogging/createLogCommands.ts:22

Per-aircraft (traf) variables from BlueSky's variable explorer that are useful in a data log. Names and units match bluesky/traffic/traffic.py.

LOG_VARIABLE_NAME_PATTERN¶

const LOG_VARIABLE_NAME_PATTERN: RegExp;

Defined in: ui/blueskylogging/createLogCommands.ts:41

Syntax for a single variable-explorer name, e.g. traf.perf.mass, lat[0]

Functions¶

validateLogSpec()¶

function validateLogSpec(spec): string | null;

Defined in: ui/blueskylogging/createLogCommands.ts:55

Validate a CreateLogSpec. Returns an error message, or null when valid.

Parameters¶

spec¶

CreateLogSpec

Returns¶

string | null

buildCreateLogCommands()¶

function buildCreateLogCommands(spec): string[];

Defined in: ui/blueskylogging/createLogCommands.ts:84

Compose the BlueSky console commands that create (and optionally start) the logger described by spec: CRELOG NAME,dt[,header] -> creates a periodic logger + a NAME command NAME ADD var1,var2,... -> selects the variables to record NAME ON -> opens the log file and starts recording Variable names are passed as-is: BlueSky's stack keeps the case of word arguments, and the variable explorer is case-sensitive (traf.lat, traf.M).

Parameters¶

spec¶

CreateLogSpec

Returns¶

string[]