Skip to content
Merged
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,43 +75,39 @@ The components are designed to cover the expectations from the feature architect

A component can optional also consist of lower level components 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__mod_temp_component_name_template
:security: YES
:safety: ASIL_B
:status: valid
:version: 1
:consists_of: comp__mod_temp_archex_sub_component_1, comp__mod_temp_archex_sub_component_2, comp__mod_temp_archex_sub_component_3
:belongs_to: feat__mtef
.. code-block:: rst

.. comp_arc_sta:: Component Name (Static View)
:id: comp_arc_sta__mod_temp_component_name__sv
:security: YES
:safety: ASIL_B
:status: valid
:version: 1
:belongs_to: comp__mod_temp_component_name_template
:fulfils: comp_req__mod_temp_component_name__some_title
.. comp_arc_sta:: Component Name (Static View)
:id: comp_arc_sta__mod_temp_component_name__sv
:security: YES
:safety: ASIL_B
:status: valid
:version: 1
:belongs_to: comp__mod_temp_component_name_template
:fulfils: comp_req__mod_temp_component_name__some_title

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

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

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

.. comp_arc_dyn:: Dynamic View
:id: comp_arc_dyn__mod_temp_component_name__dv
:security: YES
:safety: ASIL_B
:status: valid
:version: 1
:belongs_to: comp__mod_temp_component_name_template
:fulfils: comp_req__mod_temp_component_name__some_title
.. code-block:: rst

.. comp_arc_dyn:: Dynamic View
:id: comp_arc_dyn__mod_temp_component_name__dv
:security: YES
:safety: ASIL_B
:status: valid
:version: 1
:belongs_to: comp__mod_temp_component_name_template
:fulfils: comp_req__mod_temp_component_name__some_title

Put here a sequence diagram

Put here a sequence diagram

Interfaces
----------
Expand All @@ -128,16 +124,20 @@ Interfaces
Internal Components
-------------------

.. comp_arc_sta:: Component Name Static View
:id: comp_arc_sta__mod_temp_component_name__2
:status: valid
:version: 1
:safety: ASIL_B
:security: YES
:fulfils: comp_req__mod_temp_component_name__some_title
:belongs_to: comp__mod_temp_component_example_2
<If a component is further split into internal components, the internal components are described here.>

.. code-block:: rst

.. comp_arc_sta:: Component Name Static View
:id: comp_arc_sta__mod_temp_component_name__2
:status: valid
:version: 1
:safety: ASIL_B
:security: YES
:fulfils: comp_req__mod_temp_component_name__some_title
:belongs_to: comp__mod_temp_component_example_2

No architecture but detailed design
No architecture but detailed design

.. 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
8 changes: 4 additions & 4 deletions score/component_example/docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@
:id: comp__mod_temp_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
:status: valid
:implements: logic_arc_int__example_feature__if_1
:version: 1
:belongs_to: feat__mtef

.. attention::
The above directives must be updated according to your Component.
Expand Down
24 changes: 13 additions & 11 deletions score/component_example/docs/requirements/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,21 @@ Component <Name> Requirements
Functional Requirements
-----------------------

.. comp_req:: Some Title
:id: comp_req__mod_temp_component_name__some_title
:reqtype: Process
:security: YES
:safety: ASIL_B
:derived_from: feat_req__example_feature__example_req
:status: valid
:version: 1
:satisfied_by: comp__mod_temp_component_name_template
.. code-block:: rst

.. comp_req:: Some Title
:id: comp_req__mod_temp_component_name__some_title
:reqtype: Process
:security: YES
:safety: ASIL_B
:derived_from: feat_req__example_feature__example_req
:status: valid
:version: 1
:satisfied_by: comp__mod_temp_component_name_template

The Component shall do xyz to another component to bring it to this condition at this time
The Component shall do xyz to another component to bring it to this condition at this time

Note: (optional, not to be verified)
Note: (optional, not to be verified)

.. attention::
The above directive must be updated according to your component requirements.
Expand Down
Loading