Technical Elements Documentation
    Preparing search index...

    Interface SystemBasicEvent

    Interface for a basic event in a system logic model.

    Extends the core BasicEvent type with system-specific properties. The core BasicEvent is defined in the upstream core/events.ts module and is the authoritative source for basic event definitions across the codebase.

    This follows the dependency structure where:

    1. Core events.ts (most upstream): Defines the base BasicEvent interface
    2. Systems-analysis.ts (midstream): Extends BasicEvent with system-specific properties
    3. Data-analysis.ts (downstream): Uses both BasicEvent and references SystemBasicEvent
    interface SystemBasicEvent {
        attributes?: { name: string; value: string }[];
        componentReference?: string;
        dataAnalysisBasicEventRef?: string;
        expression?: {
            formula?: string;
            parameter?: string;
            type?: "constant" | "parameter" | "formula";
            value?: number;
        };
        failureMode?: string;
        meanTimeToRepair?: number;
        probability?: number;
        probabilityModel?: ProbabilityModel;
        repairJustification?: string;
        repairModeled?: boolean;
        role?: "public"
        | "private"
        | "interface";
        unit?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    attributes?: { name: string; value: string }[]

    Attributes for the quantification adapter Enables passing additional information to the quantification engine

    componentReference?: string

    Reference to the component associated with this basic event, if applicable.

    dataAnalysisBasicEventRef?: string

    Reference to a ComponentBasicEvent in the data-analysis module This establishes a link between systems analysis and data analysis

    expression?: {
        formula?: string;
        parameter?: string;
        type?: "constant" | "parameter" | "formula";
        value?: number;
    }

    Expression that can be used in place of a fixed probability Used by the quantification adapter for parametric calculations

    Type declaration

    • Optionalformula?: string

      Formula (using mathematical notation)

    • Optionalparameter?: string

      Parameter reference (for using model-wide parameters)

    • Optionaltype?: "constant" | "parameter" | "formula"

      Expression type

    • Optionalvalue?: number

      Fixed value (equivalent to the probability field)

    Use probabilityModel from data-analysis module instead

    failureMode?: string

    The failure mode represented by this basic event.

    meanTimeToRepair?: number

    Mean time to repair, if repair is modeled

    probability?: number

    The probability or frequency of this basic event.

    probabilityModel?: ProbabilityModel

    Probability model from data analysis module Reuses the data analysis module's definition to avoid duplication

    repairJustification?: string

    Justification for modeling repair, if applicable

    repairModeled?: boolean

    Whether repair is modeled for this basic event

    SY-A31

    role?: "public" | "private" | "interface"

    Role of this basic event in quantification Used by the quantification adapter for model organization

    unit?: string

    Unit for the probability/frequency value Used by the quantification adapter for proper unit conversion