simulationProgressStore.ts

Go to the documentation of this file.

// SPDX-License-Identifier: GPL-2.0-only
// Copyright (c) 2025-present FERS Contributors (see AUTHORS.md).
 
import { create } from 'zustand';
 
export type SimulationProgressState = {
    message: string;
    current: number;
    total: number;
    details?: SimulationProgressDetail[];
};
 
export type SimulationProgressDetail = {
    id: string;
    message: string;
    current: number;
    total: number;
};
 
export type SimulationRunStatus = 'idle' | 'running' | 'completed' | 'failed';
 
export type SimulationOutputMode = 'pulsed' | 'cw' | 'fmcw' | 'sfcw';
 
export type SimulationOutputChunkMetadata = {
    chunk_index: number;
    i_dataset: string;
    q_dataset: string;
    start_time: number;
    sample_count: number;
    sample_start: number;
    sample_end_exclusive: number;
};
 
export type SimulationOutputStreamingSegmentMetadata = {
    start_time: number;
    end_time: number;
    sample_count: number;
    sample_start: number;
    sample_end_exclusive: number;
    first_chirp_start_time?: number;
    emitted_chirp_count?: number;
    first_triangle_start_time?: number;
    emitted_triangle_count?: number;
    first_sfcw_step_start_time?: number;
    emitted_sfcw_step_count?: number;
};
 
export type SimulationOutputFmcwMetadata = {
    waveform_shape?: 'linear' | 'triangle' | 'file';
    chirp_bandwidth: number;
    chirp_duration: number;
    chirp_rate: number;
    start_frequency_offset: number;
    chirp_period?: number;
    chirp_rate_signed?: number;
    chirp_direction?: 'up' | 'down';
    chirp_count?: number;
    triangle_period?: number;
    triangle_count?: number;
    sampled_duration?: number;
    sampled_count?: number;
};
 
export type SimulationOutputFmcwSourceSegmentMetadata = {
    start_time: number;
    end_time: number;
    first_chirp_start_time?: number;
    emitted_chirp_count?: number;
    first_triangle_start_time?: number;
    emitted_triangle_count?: number;
};
 
export type SimulationOutputFmcwSourceMetadata =
    SimulationOutputFmcwMetadata & {
        transmitter_id: number;
        transmitter_name: string;
        waveform_id: number;
        waveform_name: string;
        carrier_frequency: number;
        segments: SimulationOutputFmcwSourceSegmentMetadata[];
    };
 
export type SimulationOutputSfcwMetadata = {
    carrier_frequency: number;
    start_frequency_offset: number;
    step_size: number;
    step_count: number;
    dwell_time: number;
    step_period: number;
    sweep_count?: number;
    first_frequency: number;
    last_frequency: number;
    frequency_span: number;
    effective_bandwidth: number;
    range_resolution: number;
    unambiguous_range: number;
};
 
export type SimulationOutputSfcwSourceSegmentMetadata = {
    start_time: number;
    end_time: number;
    first_step_start_time?: number;
    emitted_step_count?: number;
};
 
export type SimulationOutputSfcwSourceMetadata =
    SimulationOutputSfcwMetadata & {
        transmitter_id: number;
        transmitter_name: string;
        waveform_id: number;
        waveform_name: string;
        segments: SimulationOutputSfcwSourceSegmentMetadata[];
    };
 
export type SimulationOutputVita49Timestamp = {
    integer_seconds: number;
    fractional_picoseconds: number;
};
 
export type SimulationOutputVita49StreamMetadata = {
    receiver_id: number;
    receiver_name: string;
    stream_id: number;
    mode?: string;
    sample_rate: number;
    reference_frequency: number;
    packets_emitted: number;
    samples_emitted: number;
    packets_dropped: number;
    samples_dropped: number;
    over_range_count: number;
    late_data_packet_count: number;
    late_context_packet_count: number;
    context_packet_count: number;
    first_sample_time: number | null;
    end_sample_time: number | null;
    first_timestamp: SimulationOutputVita49Timestamp | null;
    end_timestamp: SimulationOutputVita49Timestamp | null;
};
 
export type SimulationOutputVita49Metadata = {
    endpoint: string;
    endpoint_host: string;
    endpoint_port: number;
    epoch_unix_nanoseconds: string | null;
    class_id: string;
    adc_fullscale: number;
    max_udp_payload: number;
    queue_depth: number;
    streams: SimulationOutputVita49StreamMetadata[];
};
 
export type SimulationOutputFileMetadata = {
    receiver_id: number;
    receiver_name: string;
    mode: SimulationOutputMode;
    path: string;
    sampling_rate: number;
    total_samples: number;
    sample_start: number;
    sample_end_exclusive: number;
    pulse_count: number;
    min_pulse_length_samples: number;
    max_pulse_length_samples: number;
    uniform_pulse_length: boolean;
    chunks: SimulationOutputChunkMetadata[];
    streaming_segments: SimulationOutputStreamingSegmentMetadata[];
    fmcw?: SimulationOutputFmcwMetadata;
    fmcw_sources: SimulationOutputFmcwSourceMetadata[];
    sfcw?: SimulationOutputSfcwMetadata;
    sfcw_sources: SimulationOutputSfcwSourceMetadata[];
    fmcw_dechirp_mode?: 'none' | 'physical' | 'ideal';
    fmcw_dechirp_reference_source?:
        | 'none'
        | 'attached'
        | 'transmitter'
        | 'custom';
    fmcw_dechirp_reference_transmitter_id?: number;
    fmcw_dechirp_reference_transmitter_name?: string;
    fmcw_dechirp_reference_waveform_id?: number;
    fmcw_dechirp_reference_waveform_name?: string;
    fmcw_dechirp_reference_waveform?: SimulationOutputFmcwMetadata;
};
 
export type SimulationOutputMetadata = {
    schema_version: number;
    simulation_name: string;
    output_directory: string;
    start_time: number;
    end_time: number;
    sampling_rate: number | null;
    sampling_rates?: number[];
    oversample_ratio: number;
    files: SimulationOutputFileMetadata[];
    vita49?: SimulationOutputVita49Metadata;
};
 
export type RawSimulationOutputFileMetadata = Omit<
    SimulationOutputFileMetadata,
    'sampling_rate' | 'streaming_segments' | 'fmcw_sources' | 'sfcw_sources'
> & {
    sampling_rate?: number;
    streaming_segments?: SimulationOutputStreamingSegmentMetadata[];
    cw_segments?: SimulationOutputStreamingSegmentMetadata[];
    fmcw_sources?: SimulationOutputFmcwSourceMetadata[];
    sfcw_sources?: SimulationOutputSfcwSourceMetadata[];
};
 
export type RawSimulationOutputMetadata = Omit<
    SimulationOutputMetadata,
    'files'
> & {
    files: RawSimulationOutputFileMetadata[];
};
 
export const normalizeSimulationOutputMetadata = (
    metadata: RawSimulationOutputMetadata
): SimulationOutputMetadata => ({
    ...metadata,
    files: metadata.files.map((file) => {
        const {
            cw_segments,
            streaming_segments,
            fmcw_sources,
            sfcw_sources,
            sampling_rate,
            ...normalizedFile
        } = file;
        return {
            ...normalizedFile,
            sampling_rate:
                sampling_rate ??
                metadata.sampling_rate ??
                metadata.sampling_rates?.[0] ??
                0,
            streaming_segments: streaming_segments ?? cw_segments ?? [],
            fmcw_sources: fmcw_sources ?? [],
            sfcw_sources: sfcw_sources ?? [],
        };
    }),
});
 
type SimulationProgressStore = {
    isSimulating: boolean;
    isGeneratingKml: boolean;
    simulationProgress: Record<string, SimulationProgressState>;
    simulationRunStatus: SimulationRunStatus;
    simulationRunError: string | null;
    simulationOutputMetadata: SimulationOutputMetadata | null;
 
    setIsSimulating: (isSimulating: boolean) => void;
    setIsGeneratingKml: (isGeneratingKml: boolean) => void;
    startSimulationRun: () => void;
    setSimulationProgressSnapshot: (
        progress: Record<string, SimulationProgressState>
    ) => void;
    setSimulationOutputMetadata: (
        metadata: SimulationOutputMetadata | null
    ) => void;
    completeSimulationRun: () => void;
    failSimulationRun: (errorMessage: string) => void;
    clearSimulationProgress: () => void;
};
 
export const useSimulationProgressStore = create<SimulationProgressStore>()(
    (set) => ({
        isSimulating: false,
        isGeneratingKml: false,
        simulationProgress: {},
        simulationRunStatus: 'idle',
        simulationRunError: null,
        simulationOutputMetadata: null,
 
        setIsSimulating: (isSimulating) => set({ isSimulating }),
        setIsGeneratingKml: (isGeneratingKml) => set({ isGeneratingKml }),
        startSimulationRun: () =>
            set({
                isSimulating: true,
                simulationProgress: {},
                simulationRunStatus: 'running',
                simulationRunError: null,
                simulationOutputMetadata: null,
            }),
        setSimulationProgressSnapshot: (progress) =>
            set({ simulationProgress: progress }),
        setSimulationOutputMetadata: (metadata) =>
            set({ simulationOutputMetadata: metadata }),
        completeSimulationRun: () =>
            set({
                isSimulating: false,
                simulationRunStatus: 'completed',
                simulationRunError: null,
            }),
        failSimulationRun: (errorMessage) =>
            set({
                isSimulating: false,
                simulationRunStatus: 'failed',
                simulationRunError: errorMessage,
            }),
        clearSimulationProgress: () =>
            set({
                simulationProgress: {},
                simulationRunStatus: 'idle',
                simulationRunError: null,
                simulationOutputMetadata: null,
            }),
    })
);