Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -75,90 +75,104 @@ Mandatory: A motivation for the decomposition
Static Architecture
-------------------

.. feat:: Feature Name
:id: feat__feature_name
:security: YES
:safety: ASIL_B
:status: invalid
:includes: logic_arc_int__feature_name__interface_name1
The live feature architecture template snippets are maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.

General Feature Description
.. code-block:: rst

.. feat_arc_sta:: Feature Static View
:id: feat_arc_sta__feature_name__static_view
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
:includes: logic_arc_int__feature_name__interface_name1
:belongs_to: feat__feature_name
.. feat:: Feature Name
:id: feat__feature_name
:security: YES
:safety: ASIL_B
:status: invalid
:includes: logic_arc_int__feature_name__interface_name1

.. needarch::
:scale: 50
:align: center
General Feature Description

{{ draw_feature(need(), needs) }}
.. feat_arc_sta:: Feature Static View
:id: feat_arc_sta__feature_name__static_view
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
:includes: logic_arc_int__feature_name__interface_name1
:belongs_to: feat__feature_name

.. needarch::
:scale: 50
:align: center

{{ draw_feature(need(), needs) }}

Dynamic Architecture
--------------------

.. feat_arc_dyn:: Dynamic View
:id: feat_arc_dyn__feature_name__dynamic_view
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
:belongs_to: feat__feature_name
.. code-block:: rst

.. feat_arc_dyn:: Dynamic View
:id: feat_arc_dyn__feature_name__dynamic_view
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
:belongs_to: feat__feature_name

Put here a sequence diagram
Put here a sequence diagram

Logical Interfaces
------------------

.. logic_arc_int:: Interface Name
:id: logic_arc_int__feature_name__interface_name1
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title
.. code-block:: rst

General Interface Description
.. logic_arc_int:: Interface Name
:id: logic_arc_int__feature_name__interface_name1
:security: YES
:safety: ASIL_B
:status: invalid
:fulfils: feat_req__feature_name__some_title

.. needarch::
:scale: 50
:align: center
General Interface Description

{{ draw_interface(need(), needs) }}
.. needarch::
:scale: 50
:align: center

.. logic_arc_int_op:: Operation
:id: logic_arc_int_op__feature_name__operation
:security: YES
:safety: ASIL_B
:status: invalid
:included_by: logic_arc_int__feature_name__interface_name1
{{ draw_interface(need(), needs) }}

General Operation Description
.. logic_arc_int_op:: Operation
:id: logic_arc_int_op__feature_name__operation
:security: YES
:safety: ASIL_B
:status: invalid
:included_by: logic_arc_int__feature_name__interface_name1

General Operation Description

Module Viewpoint
----------------

The following modules are needed to be defined to be able to draw the static feature view.
They will be replaced by linking the proper module definitions in the used module's repositories as soon as those exist.

.. mod:: Module Name
:id: mod__module_name
:includes: comp__component_name_template
The rendered module and used-component examples are maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`_.

.. code-block:: rst

.. mod:: Module Name
:id: mod__module_name
:includes: comp__component_name_template


.. mod_view_sta:: Module Name Static View
:id: mod_view_sta__feature_name__module_name
:includes: comp__component_name_template
.. mod_view_sta:: Module Name Static View
:id: mod_view_sta__feature_name__module_name
:includes: comp__component_name_template

.. needarch::
:scale: 50
:align: center
.. needarch::
:scale: 50
:align: center

{{ draw_module(need(), needs) }}
{{ draw_module(need(), needs) }}

Used Components
---------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,29 +34,33 @@ Feature Requirements
<Headlines (for the list of requirements if structuring is needed)>
===================================================================

.. feat_req:: Some Title
:id: feat_req__feature_name__some_title
:reqtype: Process
:security: NO
:safety: ASIL_B
:satisfies: stkh_req__requirements__template
:valid_from: v0.0.1
:valid_until: v1.0.1
:status: invalid
:belongs_to: feat__feature_name
.. code-block:: rst

The Feature shall do xyz to the user to bring him to this condition at this time.
.. feat_req:: Some Title
:id: feat_req__feature_name__some_title
:reqtype: Process
:security: NO
:safety: ASIL_B
:satisfies: stkh_req__requirements__template
:valid_from: v0.0.1
:valid_until: v1.0.1
:status: invalid
:belongs_to: feat__feature_name

Note: (optional, not to be verified)
The Feature shall do xyz to the user to bring him to this condition at this time.

.. aou_req:: Some Other Title
:id: aou_req__feature_name__some_other_title
:reqtype: Process
:security: NO
:safety: ASIL_B
:status: invalid
Note: (optional, not to be verified)

.. code-block:: rst

.. aou_req:: Some Other Title
:id: aou_req__feature_name__some_other_title
:reqtype: Process
:security: NO
:safety: ASIL_B
:status: invalid

The Feature User shall do xyz to use the feature safely.
The Feature User shall do xyz to use the feature safely.

.. attention::
The above directives must be updated according to your feature requirements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,42 +72,49 @@ The components are designed to cover the expectations from the feature architect

A component can optional also consist of subcomponents to further structure the architecture. The component and its static views can also optionally use interfaces provided by other components.

.. comp:: Component Name
:id: comp__component_name_template
:security: YES
:safety: ASIL_B
:status: invalid
:implements: logic_arc_int__feature_name__interface_name1
:consists_of: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3
:belongs_to: feat__feature_name

.. comp_arc_sta:: Component Name (Static View)
:id: comp_arc_sta__component_name__static_view
:security: YES
:safety: ASIL_B
:status: invalid
:belongs_to: comp__component_name_template
:uses: logic_arc_int__feature_name__interface_name1
:fulfils: comp_req__component_name__some_title
The live component architecture template is maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/component_architecture_template.html>`_.

.. needarch::
:scale: 50
:align: center
.. code-block:: rst

{{ draw_component(need(), needs) }}
.. comp:: Component Name
:id: comp__component_name_template
:security: YES
:safety: ASIL_B
:status: invalid
:implements: logic_arc_int__feature_name__interface_name1
:consists_of: comp__component_name_internal_1, comp__component_name_internal_2, comp__component_name_internal_3
:belongs_to: feat__feature_name

.. comp_arc_sta:: Component Name (Static View)
:id: comp_arc_sta__component_name__static_view
:security: YES
:safety: ASIL_B
:status: invalid
:belongs_to: comp__component_name_template
:uses: logic_arc_int__feature_name__interface_name1
:fulfils: comp_req__component_name__some_title

.. needarch::
:scale: 50
:align: center

{{ draw_component(need(), needs) }}

Dynamic Architecture
--------------------

.. comp_arc_dyn:: Dynamic View
:id: comp_arc_dyn__component_name__dynamic_view
:security: YES
:safety: ASIL_B
:status: invalid
:belongs_to: comp__component_name_template
:fulfils: comp_req__component_name__some_title
.. code-block:: rst

.. comp_arc_dyn:: Dynamic View
:id: comp_arc_dyn__component_name__dynamic_view
:security: YES
:safety: ASIL_B
:status: invalid
:belongs_to: comp__component_name_template
:fulfils: comp_req__component_name__some_title

Put here a sequence diagram
Put here a sequence diagram


Interfaces
Expand All @@ -125,15 +132,38 @@ Interfaces
Internal Components
-------------------

.. comp_arc_sta:: Component Name Static View
:id: comp_arc_sta__component_name__2
:status: invalid
:safety: ASIL_B
:security: YES
:fulfils: comp_req__component_name__some_title
:belongs_to: comp__component_example_2
.. code-block:: rst

No architecture but detailed design
.. comp_arc_sta:: Component Name Static View
:id: comp_arc_sta__component_name__2
:status: invalid
:safety: ASIL_B
:security: YES
:fulfils: comp_req__component_name__some_title
:belongs_to: comp__component_name_template

No architecture but detailed design

.. comp:: Internal Component 1
:id: comp__component_name_internal_1
:status: invalid
:safety: ASIL_B
:security: YES
:belongs_to: feat__feature_name

.. comp:: Internal Component 2
:id: comp__component_name_internal_2
:status: invalid
:safety: ASIL_B
:security: YES
:belongs_to: feat__feature_name

.. comp:: Internal Component 3
:id: comp__component_name_internal_3
:status: invalid
:safety: ASIL_B
:security: YES
:belongs_to: feat__feature_name

.. note::
Architecture can be split into multiple files. At component level the public interfaces to be used by the user and tester to be shown.
Expand Down
Loading
Loading