Skip to content

docs-md


Interface: ProcessDocumentation

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:644

Interface representing documentation of the process used in the success criteria development.

Extends

Properties

calculationLimitations?

optional calculationLimitations: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:712

Documentation of limitations of calculations and codes Implements SC-C1(d)

affectedItems

affectedItems: string[]

Affected calculations or codes

description

description: string

Description of the limitation

impact

impact: string

Impact on success criteria

limitationId

limitationId: string

Limitation identifier

mitigation?

optional mitigation: string

Mitigation strategies


calculationsUsed?

optional calculationsUsed: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:670

Documentation of calculations used to establish success criteria Implements SC-C1(b)

calculationId

calculationId: string

Calculation identifier

calculationType

calculationType: "PLANT_SPECIFIC" | "GENERIC"

Whether it's generic or plant-specific

description

description: string

Description of the calculation

establishedCriteria

establishedCriteria: string[]

Success criteria established by this calculation

references

references: string[]

References to the calculation documentation


computerCodesUsed?

optional computerCodesUsed: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:691

Documentation of computer codes used Implements SC-C1(c)

codeId

codeId: string

Code identifier

description

description: string

Description of the code

establishedCriteria

establishedCriteria: string[]

Success criteria established using this code

nameAndVersion

nameAndVersion: string

Code name and version

validationReferences

validationReferences: string[]

References to validation documentation


description?

optional description: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/meta.ts:37

Inherited from

BaseProcessDocumentation.description


designInformation?

optional designInformation: BaseDesignInformation[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/documentation.ts:79

Design information sources used in the analysis

Inherited from

BaseProcessDocumentation.designInformation


digitalSystemsCriteria?

optional digitalSystemsCriteria: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:808

Documentation of success criteria for digital systems Implements SC-C1(i)

criteria

criteria: string

Success criteria

failureModes

failureModes: string[]

Failure modes considered

supportingAnalyses

supportingAnalyses: string[]

References to supporting analyses

systemId

systemId: string

Digital system identifier

technicalBasis

technicalBasis: string

Technical basis


endStateDefinitions?

optional endStateDefinitions: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:649

Documentation of the definition of end states Implements SC-C1(a)

definition

definition: string

Definition of the end state

endStateId

endStateId: EndState

End state identifier

eventSequences

eventSequences: EventSequenceReference[]

Event sequences leading to this end state

parameterBasis

parameterBasis: string

Basis for parameter values

parameters

parameters: Record<string, string>

Key parameters used to define this end state


expertJudgmentUse?

optional expertJudgmentUse: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:733

Documentation of expert judgment use Implements SC-C1(e)

impactedCriteria

impactedCriteria: string[]

Success criteria impacted

judgmentId

judgmentId: string

Identifier for the expert judgment

rationale

rationale: string

Rationale for using expert judgment

topic

topic: string

Topic of the judgment


groupedEventsCriteria?

optional groupedEventsCriteria: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:787

Documentation of grouped initiating events criteria Implements SC-C1(h)

groupedEvents

groupedEvents: string[]

Initiating events in this group

groupId

groupId: string

Group identifier

groupingBasis

groupingBasis: string

Basis for the grouping

limitations?

optional limitations: string

Limitations of the grouping

process

process: string

Process for defining common success criteria


humanActionTimingBasis?

optional humanActionTimingBasis: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:769

Documentation of time available for human actions Implements SC-C1(g)

actionId

actionId: string

Human action identifier

basis

basis: string

Basis for this time

supportingAnalyses

supportingAnalyses: string[]

References to supporting analyses

timeAvailable

timeAvailable: string

Time available


inputsDescription?

optional inputsDescription: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/documentation.ts:76

Description of inputs used in the analysis

Inherited from

BaseProcessDocumentation.inputsDescription


methodsDescription?

optional methodsDescription: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/documentation.ts:82

Description of methods applied in the analysis

Inherited from

BaseProcessDocumentation.methodsDescription


mitigatingSystemsCriteria?

optional mitigatingSystemsCriteria: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:751

Documentation of success criteria for mitigating systems Implements SC-C1(f)

applicableInitiatingEvents

applicableInitiatingEvents: string[]

Initiating events where this system is credited

successCriteria

successCriteria: string

Success criteria for this system

systemId

systemId: string

System identifier

technicalBasis

technicalBasis: string

Technical basis


name

name: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/meta.ts:36

Inherited from

BaseProcessDocumentation.name


passiveSafetyCriteria?

optional passiveSafetyCriteria: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:829

Documentation of passive safety function criteria Implements SC-C1(j)

criteria

criteria: string

Success criteria

description

description: string

Description of the function

functionId

functionId: string

Passive safety function identifier

technicalBasis

technicalBasis: string

Technical basis

uncertainties

uncertainties: string

Uncertainties in these criteria

uncertaintyTreatment

uncertaintyTreatment: string

How uncertainties were addressed


processDescription

processDescription: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/documentation.ts:73

Description of the overall process used

Inherited from

BaseProcessDocumentation.processDescription


requirementReferences?

optional requirementReferences: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/documentation.ts:91

Traceability to requirements

implementation

implementation: string

How the requirement is addressed

requirementId

requirementId: string

Requirement identifier

Inherited from

BaseProcessDocumentation.requirementReferences


resultsDescription?

optional resultsDescription: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/documentation.ts:85

Description of the results of the analysis

Inherited from

BaseProcessDocumentation.resultsDescription


sharedSystemsCriteria?

optional sharedSystemsCriteria: object[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/success-criteria/success-criteria-development.ts:853

Documentation of shared systems criteria Implements SC-C1(k)

commonInitiatingEvents

commonInitiatingEvents: string[]

Common initiating events considered

criteria

criteria: string

Success criteria

sharedByReactors

sharedByReactors: string[]

Reactors sharing this system

systemId

systemId: string

Shared system identifier

technicalBasis

technicalBasis: string

Technical basis


supportingDocumentationReferences?

optional supportingDocumentationReferences: string[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/documentation.ts:88

References to supporting documentation

Inherited from

BaseProcessDocumentation.supportingDocumentationReferences


uuid

uuid: Format<"uuid">

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/meta.ts:20

Inherited from

BaseProcessDocumentation.uuid