Technical Elements Documentation
    Preparing search index...

    Interface EventSequenceFamily

    Interface representing an event sequence family. An event sequence family is a group of event sequences with similar characteristics.

    ES-C3

    ES-C4

    ES-C5

    ES-C6

    interface EventSequenceFamily {
        description?: string;
        endState: EndState;
        familySpecificAssumptions?: event_sequence_analysis.Assumption[];
        frequency?: {
            distribution?: DistributionType;
            distributionParameters?: Record<string, number>;
            mean: Frequency;
            units: FrequencyUnit;
        };
        groupingCriteriaId: string;
        memberSequenceIds: event_sequence_analysis.EventSequenceReference[];
        releaseCategoryIds?: event_sequence_analysis.ReleaseCategoryReference[];
        representativeInitiatingEventId: string;
        representativePlantOperatingStateId: string;
        representativePlantResponse: string;
        representativeSourceTermId?: event_sequence_analysis.SourceTermReference;
        similarityBasis?: string;
    }

    Hierarchy

    • Unique
    • Named
      • EventSequenceFamily
    Index

    Properties

    description? endState familySpecificAssumptions? frequency? groupingCriteriaId memberSequenceIds releaseCategoryIds? representativeInitiatingEventId representativePlantOperatingStateId representativePlantResponse representativeSourceTermId? similarityBasis?

    Properties

    description?: string

    Description of the event sequence family

    endState: EndState

    End state of the sequence family

    familySpecificAssumptions?: event_sequence_analysis.Assumption[]

    Assumptions specific to this family

    frequency?: {
        distribution?: DistributionType;
        distributionParameters?: Record<string, number>;
        mean: Frequency;
        units: FrequencyUnit;
    }

    Mean frequency of the event sequence family

    Type declaration

    • Optionaldistribution?: DistributionType

      Statistical distribution of the frequency

    • OptionaldistributionParameters?: Record<string, number>

      Parameters of the distribution

    • mean: Frequency

      Mean value of the frequency

    • units: FrequencyUnit

      Units of the frequency

    groupingCriteriaId: string

    Criteria used for grouping sequences into this family

    memberSequenceIds: event_sequence_analysis.EventSequenceReference[]

    IDs of event sequences that belong to this family

    releaseCategoryIds?: event_sequence_analysis.ReleaseCategoryReference[]

    References to release categories associated with this family

    representativeInitiatingEventId: string

    Representative initiating event for the family

    representativePlantOperatingStateId: string

    Representative plant operating state for the family

    representativePlantResponse: string

    Representative plant response characteristics

    representativeSourceTermId?: event_sequence_analysis.SourceTermReference

    Reference to the representative source term

    similarityBasis?: string

    Basis for considering these sequences similar

    Settings

    Member Visibility

    On This Page

    Properties