Technical Elements Documentation
    Preparing search index...

    Interface ComponentBasicEvent

    Interface representing a component-specific basic event

    Extends the core BasicEvent type with component-specific properties and SAPHIRE integration capabilities.

    interface ComponentBasicEvent {
        componentTypeReference: string;
        failureMode: string;
        isTemplate: boolean;
        probabilityModel: ProbabilityModel;
        saphireAttributes?: {
            alternateDescriptions?: {
                graphical?: string;
                long?: string;
                short?: string;
                technical?: string;
            };
            categories?: string[];
            componentId?: string;
            eventType?: string;
            location?: string;
            notes?: string;
            phaseApplicability?: Record<string, boolean>;
            references?: string[];
            systemId?: string;
            templateUseFlags: {
                categories: boolean[];
                componentId: boolean;
                description: boolean;
                eventType: boolean;
                failureMode: boolean;
                location: boolean;
                models: boolean;
                notes: boolean;
                phases: boolean;
                references: boolean;
                system: boolean;
                train: boolean;
                type: boolean;
            };
            train?: string;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    componentTypeReference failureMode isTemplate probabilityModel saphireAttributes?

    Properties

    componentTypeReference: string

    Reference to ComponentType from core

    failureMode: string

    Reference to FailureModeType

    isTemplate: boolean

    Indicates this is a template that can be referenced

    probabilityModel: ProbabilityModel

    Probability model for this event

    saphireAttributes?: {
        alternateDescriptions?: {
            graphical?: string;
            long?: string;
            short?: string;
            technical?: string;
        };
        categories?: string[];
        componentId?: string;
        eventType?: string;
        location?: string;
        notes?: string;
        phaseApplicability?: Record<string, boolean>;
        references?: string[];
        systemId?: string;
        templateUseFlags: {
            categories: boolean[];
            componentId: boolean;
            description: boolean;
            eventType: boolean;
            failureMode: boolean;
            location: boolean;
            models: boolean;
            notes: boolean;
            phases: boolean;
            references: boolean;
            system: boolean;
            train: boolean;
            type: boolean;
        };
        train?: string;
    }

    SAPHIRE-specific attributes

    Type declaration

    • OptionalalternateDescriptions?: { graphical?: string; long?: string; short?: string; technical?: string }

      Alternate descriptions (BEDA format)

    • Optionalcategories?: string[]
    • OptionalcomponentId?: string

      Component identifiers

    • OptionaleventType?: string

      Additional categorization

    • Optionallocation?: string
    • Optionalnotes?: string

      Documentation

    • OptionalphaseApplicability?: Record<string, boolean>

      Phase applicability

    • Optionalreferences?: string[]
    • OptionalsystemId?: string

      System and location

    • templateUseFlags: {
          categories: boolean[];
          componentId: boolean;
          description: boolean;
          eventType: boolean;
          failureMode: boolean;
          location: boolean;
          models: boolean;
          notes: boolean;
          phases: boolean;
          references: boolean;
          system: boolean;
          train: boolean;
          type: boolean;
      }

      Template use flags for controlling what attributes are applied

    • Optionaltrain?: string

    Settings

    Member Visibility

    On This Page

    Properties