Technical Elements Documentation
    Preparing search index...

    Interface SystemsAnalysis

    Interface representing the Systems Analysis technical element.

    HLR-SY-A, HLR-SY-B, HLR-SY-C

    interface SystemsAnalysis {
        attributes?: { name: string; value: string }[];
        commonAssumptions?: BaseAssumption[];
        commonCauseFailureGroups: Record<string, CommonCauseFailureGroup>;
        componentDependencies: ComponentDependency[];
        created: string;
        dataAnalysisReference?: string;
        dependencySearchMethodology: DependencySearchMethodology;
        description?: string;
        digitalInstrumentationAndControl: Record<
            string,
            DigitalInstrumentationAndControl,
        >;
        faultTrees?: Record<string, systems_analysis.FaultTree>;
        humanFailureEventIntegrations: HumanFailureEventIntegration[];
        modelUncertaintyDocumentation: systems_analysis.ModelUncertaintyDocumentation;
        modelValidations: ModelValidation[];
        modified: string;
        overCapacityConsiderations: OverCapacityConsideration[];
        owner?: string;
        parameters?: Record<
            string,
            {
                dataAnalysisParameterRef?: string;
                description?: string;
                id: string;
                name: string;
                unit?: string;
                value: number;
            },
        >;
        passiveSystemsTreatment: Record<string, PassiveSystemsTreatment>;
        processDocumentation: systems_analysis.ProcessDocumentation;
        references?: {
            description: string;
            technicalElementId: string;
            technicalElementType: TechnicalElementTypes;
        }[];
        sensitivityStudies: SystemSensitivityStudy[];
        status?: "DRAFT"
        | "APPROVED"
        | "REVIEW"
        | "DEPRECATED";
        systemBasicEvents?: Record<string, systems_analysis.SystemBasicEvent>;
        systemDefinitions: Record<
            systems_analysis.SystemReference,
            SystemDefinition,
        >;
        systemDependencies: SystemDependency[];
        systemLogicModels: Record<string, SystemLogicModel>;
        systemModelEvaluations: Record<
            systems_analysis.SystemReference,
            SystemModelEvaluation,
        >;
        tags?: string[];
        templateInstanceRegistry?: TemplateInstanceRegistry;
        type: SYSTEMS_ANALYSIS;
        uncertaintyAnalysis?: Record<
            systems_analysis.SystemReference,
            SystemUncertaintyAnalysis,
        >;
        version: string;
    }

    Hierarchy

    • TechnicalElement<TechnicalElementTypes.SYSTEMS_ANALYSIS>
      • SystemsAnalysis
    Index

    Properties

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

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

    commonAssumptions?: BaseAssumption[]

    Common assumptions that apply across this technical element Using the standardized BaseAssumption interface

    commonCauseFailureGroups: Record<string, CommonCauseFailureGroup>

    Common cause failure groups.

    SY-B1

    SY-B4

    componentDependencies: ComponentDependency[]

    Dependencies between components within systems.

    SY-B5

    created: string

    The date the technical element was created

    dataAnalysisReference?: string

    Reference to associated Data Analysis module This field establishes the integration between Systems Analysis and Data Analysis for use in system basic event quantification

    dependencySearchMethodology: DependencySearchMethodology

    Methodology used to search for dependencies.

    SY-C1(i)

    description?: string

    The description of the technical element

    digitalInstrumentationAndControl: Record<
        string,
        DigitalInstrumentationAndControl,
    >

    Digital instrumentation and control systems modeling.

    SY-C1(t)

    faultTrees?: Record<string, systems_analysis.FaultTree>

    Fault trees organized in a format directly accessible by the quantification adapter This simplifies the conversion process compared to extracting them from systemLogicModels

    humanFailureEventIntegrations: HumanFailureEventIntegration[]

    Human failure events integrated into system models.

    SY-A1

    modelUncertaintyDocumentation: systems_analysis.ModelUncertaintyDocumentation

    Documentation of model uncertainty in the systems analysis.

    SY-C2

    modelValidations: ModelValidation[]

    Model validation methods.

    SY-A33

    modified: string

    The date the technical element was last modified

    overCapacityConsiderations: OverCapacityConsideration[]

    Considerations of potential overload conditions.

    SY-A29

    owner?: string

    The owner of the technical element

    parameters?: Record<
        string,
        {
            dataAnalysisParameterRef?: string;
            description?: string;
            id: string;
            name: string;
            unit?: string;
            value: number;
        },
    >

    Global parameters that can be used in expressions across the model These parameters can be referenced by basic events and other model elements Note: For complex parameter definitions, reference data-analysis module parameters

    passiveSystemsTreatment: Record<string, PassiveSystemsTreatment>

    Passive safety systems modeling.

    SY-C1(u)

    Documentation of the process used in the systems analysis.

    SY-C1

    references?: {
        description: string;
        technicalElementId: string;
        technicalElementType: TechnicalElementTypes;
    }[]

    References to other technical elements

    sensitivityStudies: SystemSensitivityStudy[]

    Sensitivity studies on system models.

    SY-C1(p)

    status?: "DRAFT" | "APPROVED" | "REVIEW" | "DEPRECATED"

    The status of the technical element

    systemBasicEvents?: Record<string, systems_analysis.SystemBasicEvent>

    Basic events organized in a flat structure for the quantification adapter This provides easier access than searching through fault trees

    System definitions, including boundaries, components, and success criteria.

    SY-A1

    SY-A3

    systemDependencies: SystemDependency[]

    Dependencies between systems.

    SY-B5

    systemLogicModels: Record<string, SystemLogicModel>

    System logic models (e.g., fault trees).

    SY-A1

    systemModelEvaluations: Record<
        systems_analysis.SystemReference,
        SystemModelEvaluation,
    >

    System model evaluation results.

    SY-C1(o)

    tags?: string[]

    Tags associated with the technical element

    templateInstanceRegistry?: TemplateInstanceRegistry

    Registry for tracking template instances and managing template changes

    type: SYSTEMS_ANALYSIS

    The type of technical element

    uncertaintyAnalysis?: Record<
        systems_analysis.SystemReference,
        SystemUncertaintyAnalysis,
    >

    Uncertainty analysis for systems.

    SY-B4

    version: string

    The version of the technical element