Anegm/fault models needs elements

process/conf.py

@@ -34,3 +34,64 @@
 
 # :need:`{title}` is used in the needs templates to display the title of the need
 needs_role_need_template = "{title}"
+
+
+def setup(app):
+    # Register the FMEA Fault Model need type.
+    # This type is used for fault models listed in the FMEA fault models guideline
+    # so they can be linked to from FMEA analyses instead of using plain IDs.
+    fmea_fault_model_type = {
+        "directive": "fmea_fault_model",
+        "title": "FMEA Fault Model",
+        "prefix": "fmea_fault_model__",
+        "tags": [],
+        "parts": 2,
+        "mandatory_options": {
+            "id": "^fmea_fault_model__[0-9a-z_]+$",
+            "status": "^(valid|draft)$",
+            "element": "^.*$",
+            "failure_mode": "^.*$",
+            "importance": "^(High|Medium|Low)$",
+        },
+        "optional_options": {
+            # parent_need (singular) is auto-computed by sphinx-needs from the
+            # parent_needs link and is not a user-specified option.
+            "parent_need": "^fmea_fault_model__[0-9a-z_]+$",
+        },
+        "mandatory_links": {},
+        "optional_links": {
+            # parent_needs is auto-populated by sphinx-needs when a need is
+            # nested inside another need's content block.
+            "parent_needs": "^fmea_fault_model__[0-9a-z_]+$",
+        },
+    }
+    app.config.needs_types.append(fmea_fault_model_type)
+    for opt in ("element", "failure_mode", "importance"):
+        if opt not in app.config.needs_extra_options:
+            app.config.needs_extra_options.append(opt)
+
+    # Register the DFA Failure Initiator need type.
+    # This type is used for failure initiators listed in the DFA failure initiators
+    # guideline so they can be linked to from DFA analyses instead of using plain IDs.
+    dfa_failure_initiator_type = {
+        "directive": "dfa_failure_initiator",
+        "title": "DFA Failure Initiator",
+        "prefix": "dfa_failure_initiator__",
+        "tags": [],
+        "parts": 2,
+        "mandatory_options": {
+            "id": "^dfa_failure_initiator__[0-9a-z_]+$",
+            "status": "^(valid|draft)$",
+            "element": "^.*$",
+            "failure_mode": "^.*$",
+            "importance": "^(High|Medium|Low)$",
+        },
+        "optional_options": {
+            "parent_need": "^dfa_failure_initiator__[0-9a-z_]+$",
+        },
+        "mandatory_links": {},
+        "optional_links": {
+            "parent_needs": "^dfa_failure_initiator__[0-9a-z_]+$",
+        },
+    }
+    app.config.needs_types.append(dfa_failure_initiator_type)

process/folder_templates/features/feature_name/safety_analysis/dfa.rst

@@ -44,6 +44,7 @@ Dependent Failure Initiators
        :id: feat_saf_dfa__<Feature>__<Element descriptor>
        :failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`>
        :failure_effect: "description of failure effect of the failure initiator on the element"
+       :safety_relevant: <yes|no>
        :mitigated_by: <ID from Feature Requirement | ID from AoU Feature Requirement>
        :mitigation_issue: <ID from Issue Tracker>
        :sufficient: <yes|no>

process/folder_templates/features/feature_name/safety_analysis/fmea.rst

@@ -45,6 +45,8 @@ Failure Mode List
        :id: feat_saf_fmea__<Feature>__<Element descriptor>
        :fault_id: <ID from fault model :need:`gd_guidl__fault_models`>
        :failure_effect: "description of failure effect of the fault model on the element"
+       :failure_root_cause: "description of the root cause of the failure"
+       :safety_relevant: <yes|no>
        :mitigated_by: <ID from Feature Requirement | ID from AoU Feature Requirement>
        :mitigation_issue: <ID from Issue Tracker>
        :sufficient: <yes|no>

process/folder_templates/modules/module_name/component_name/docs/safety_analysis/dfa.rst

@@ -44,6 +44,7 @@ Dependent Failure Initiators
        :id: comp_saf_dfa__<Component>__<Element descriptor>
        :failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`>
        :failure_effect: "description of failure effect of the failure initiator on the element"
+       :safety_relevant: <yes|no>
        :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement>
        :mitigation_issue: <ID from Issue Tracker>
        :sufficient: <yes|no>

process/folder_templates/modules/module_name/component_name/docs/safety_analysis/fmea.rst

@@ -44,6 +44,8 @@ Failure Mode List
        :id: comp_saf_fmea__<Component>__<Element descriptor>
        :fault_id: <ID from fault model :need:`gd_guidl__fault_models`>
        :failure_effect: "description of failure effect of the fault model on the element"
+       :failure_root_cause: "description of the root cause of the failure"
+       :safety_relevant: <yes|no>
        :mitigated_by: <ID from Component Requirement | ID from AoU Component Requirement>
        :mitigation_issue: <ID from Issue Tracker>
        :sufficient: <yes|no>

process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst

@@ -40,6 +40,7 @@ Dependent Failure Initiators
        :id: plat_saf_DFA__Platform__<Element descriptor>
        :failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`>
        :failure_effect: "description of failure effect of the failure initiator on the element"
+       :safety_relevant: <yes|no>
        :mitigated_by: <ID from Stakeholder Requirement | ID from AoU Feature Requirement>
        :mitigation_issue: <ID from Issue Tracker>
        :sufficient: <yes|no>