Definition of a Metamodel

Here we define a sphinx-needs metamodel.

Requirements

SN_TYPEGROUP: Requirements GROUP__requirements

targets_back: TYPE__test_specification__verifies groups_back: TYPE__sys_requirement, TYPE__sw_requirement, TYPE__assumed_req

SN_TYPE: sys requirement TYPE__sys_requirement

style: node directive: sysreq prefix: SYSREQ__ color: #FFA500 mandatory: OPTION__safety groups: GROUP__requirements

SN_TYPE: sw requirement TYPE__sw_requirement

style: node directive: swreq prefix: SWREQ__ color: #FFA500 mandatory: OPTION__safety groups: GROUP__requirements

SN_TYPE: assumed requirement TYPE__assumed_req

style: node directive: asreq prefix: ASREQ__ color: #FFA500 targets_back: TYPE__sw_arch__satisfies__assumed_req, TYPE__aou__satisfies__assumed_req mandatory: OPTION__safety groups: GROUP__requirements

Software Architecture

SN_TYPEGROUP: Software Architecture GROUP__sw_arch

child needs: TYPE__sw_arch__satisfies__assumed_req, TYPE__sw_arch__covered_by__unit targets_back: TYPE__aou__satisfies__sw_arch groups_back: TYPE__sw_arch_diagram, TYPE__sw_arch_decision

SN_ASSOCIATION: satisfies TYPE__sw_arch__satisfies__assumed_req parent needs: GROUP__sw_arch targets: TYPE__assumed_req link: LINK__satisfies The Software Architecture (GROUP__sw_arch) satisfies assumed requirement (TYPE__assumed_req). SN_ASSOCIATION: covered by TYPE__sw_arch__covered_by__unit parent needs: GROUP__sw_arch targets: TYPE__unit link: LINK__covered_by The Software Architecture (GROUP__sw_arch) is covered by Unit (TYPE__unit).

SN_TYPE: Software Architecture Diagram TYPE__sw_arch_diagram

style: node directive: sw_arch_dia prefix: ARCH_DIA__ color: #FFA500 mandatory: OPTION__safety groups: GROUP__sw_arch

SN_TYPE: Software Architecture Decision TYPE__sw_arch_decision

style: node directive: sw_arch_dec prefix: ARCH_DEC__ color: #FFA500 mandatory: OPTION__safety groups: GROUP__sw_arch

Safety

SN_TYPE: Assumption of Use TYPE__aou

style: node directive: aou prefix: AOU__ color: #FF0000 child needs: TYPE__aou__satisfies__assumed_req, TYPE__aou__satisfies__sw_arch mandatory: OPTION__safety

SN_ASSOCIATION: satisfies TYPE__aou__satisfies__assumed_req parent needs: TYPE__aou targets: TYPE__assumed_req link: LINK__satisfies The Assumption of Use (TYPE__aou) satisfies assumed requirement (TYPE__assumed_req). SN_ASSOCIATION: satisfies TYPE__aou__satisfies__sw_arch parent needs: TYPE__aou targets: GROUP__sw_arch link: LINK__satisfies The Assumption of Use (TYPE__aou) satisfies Software Architecture (GROUP__sw_arch).

SN_OPTION: safety OPTION__safety

name: safety description: safety level schema: {"type": "string", "enum": ["QM", "ASIL-A", "ASIL-B", "ASIL-C", "ASIL-D"]} mandatory_back: TYPE__sys_requirement, TYPE__sw_requirement, TYPE__assumed_req, TYPE__sw_arch_diagram, TYPE__sw_arch_decision, TYPE__aou, TYPE__test_specification, TYPE__unit, TYPE__port

The safety option indicates the safety level of a need.

Testing

SN_TYPE: test_specification TYPE__test_specification

style: node directive: test_specification prefix: TESTSPEC__ color: #00FF00 child needs: TYPE__test_specification__verifies mandatory: OPTION__safety

A test specification describes a need that defines tests for requirements. SN_ASSOCIATION: verifies TYPE__test_specification__verifies parent needs: TYPE__test_specification targets: GROUP__requirements link: LINK__verifies The test_specification verifies requirements.

Software Architecture II

SN_TYPEGROUP: Software Architecture II GROUP__sw_arch2

groups_back: TYPE__unit, TYPE__port, TYPE__parameter, TYPE__datatype

SN_TYPE: Unit TYPE__unit

style: node directive: unit prefix: UNIT__ color: #FFA500 child needs: TYPE__unit__provided, TYPE__unit__required targets_back: TYPE__sw_arch__covered_by__unit mandatory: OPTION__safety groups: GROUP__sw_arch2

SN_ASSOCIATION: provided TYPE__unit__provided parent needs: TYPE__unit targets: TYPE__port link: LINK__provided The unit provided port. SN_ASSOCIATION: required TYPE__unit__required parent needs: TYPE__unit targets: TYPE__port link: LINK__required The unit required port.

SN_TYPE: Port TYPE__port

style: node directive: port prefix: PORT__ color: #FFA500 targets_back: TYPE__unit__provided, TYPE__unit__required mandatory: OPTION__safety groups: GROUP__sw_arch2

SN_TYPE: Parameter TYPE__parameter

style: node directive: parameter prefix: PORT__ color: #FFA500 groups: GROUP__sw_arch2

SN_TYPE: Datatype TYPE__datatype

style: node directive: datatype prefix: DATATYPE__ color: #FFA500 groups: GROUP__sw_arch2

Options

Links

SN_LINK: verifies LINK__verifies

style: #000000 option: verifies incoming: verified by outgoing: verifies copy: true allow_dead_links: false style_part: #000000 style_start: - style_end: -> link_back: TYPE__test_specification__verifies

A “verifies” link indicates that a test specification verifies a requirement.

SN_LINK: satisfies LINK__satisfies

style: #000000 option: satisfies incoming: satisfied by outgoing: satisfies copy: true allow_dead_links: false style_part: #000000 style_start: - style_end: -> link_back: TYPE__sw_arch__satisfies__assumed_req, TYPE__aou__satisfies__assumed_req, TYPE__aou__satisfies__sw_arch

A “satisfies” link indicates that a element satisfies another element.

SN_LINK: covers LINK__covers

style: #000000 option: covers incoming: covered by outgoing: covers copy: true allow_dead_links: false style_part: #000000 style_start: - style_end: ->

A “covers” link indicates that a element covers another element.

SN_LINK: covered_by LINK__covered_by

style: #000000 option: covered_by incoming: covers outgoing: covered by copy: true allow_dead_links: false style_part: #000000 style_start: - style_end: -> link_back: TYPE__sw_arch__covered_by__unit

A “covered_by” link indicates that a element is covered by another element.

SN_LINK: provided LINK__provided

style: #000000 option: provided incoming: provided by outgoing: provided copy: true allow_dead_links: false style_part: #000000 style_start: - style_end: -> link_back: TYPE__unit__provided

A “provided” link indicates that a element is provided another element.

SN_LINK: required LINK__required

style: #000000 option: required incoming: required by outgoing: required copy: true allow_dead_links: false style_part: #000000 style_start: - style_end: -> link_back: TYPE__unit__required

A “required” link indicates that a element is required another element.

SN_LINK: datatype LINK__datatype

style: #000000 option: datatype incoming: datatype of outgoing: datatype copy: true allow_dead_links: false style_part: #000000 style_start: - style_end: ->

A “optinal” link indicates that a element is optinal of another element.