Skip to content

Commit 47e3a48

Browse files
RolandJentschETASRolandJentschETAS
authored
Start to move examples to template module repository (#632)
* Start to move exmples to template module repository * change link path
1 parent 4cd734e commit 47e3a48

16 files changed

Lines changed: 252 additions & 769 deletions

File tree

‎process/folder_templates/features/feature_name/architecture/index.rst‎

Lines changed: 69 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -75,90 +75,104 @@ Mandatory: A motivation for the decomposition
7575
Static Architecture
7676
-------------------
7777

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

85-
General Feature Description
81+
.. code-block:: rst
8682
87-
.. feat_arc_sta:: Feature Static View
88-
:id: feat_arc_sta__feature_name__static_view
89-
:security: YES
90-
:safety: ASIL_B
91-
:status: invalid
92-
:fulfils: feat_req__feature_name__some_title
93-
:includes: logic_arc_int__feature_name__interface_name1
94-
:belongs_to: feat__feature_name
83+
.. feat:: Feature Name
84+
:id: feat__feature_name
85+
:security: YES
86+
:safety: ASIL_B
87+
:status: invalid
88+
:includes: logic_arc_int__feature_name__interface_name1
9589
96-
.. needarch::
97-
:scale: 50
98-
:align: center
90+
General Feature Description
9991
100-
{{ draw_feature(need(), needs) }}
92+
.. feat_arc_sta:: Feature Static View
93+
:id: feat_arc_sta__feature_name__static_view
94+
:security: YES
95+
:safety: ASIL_B
96+
:status: invalid
97+
:fulfils: feat_req__feature_name__some_title
98+
:includes: logic_arc_int__feature_name__interface_name1
99+
:belongs_to: feat__feature_name
100+
101+
.. needarch::
102+
:scale: 50
103+
:align: center
104+
105+
{{ draw_feature(need(), needs) }}
101106
102107
Dynamic Architecture
103108
--------------------
104109

105-
.. feat_arc_dyn:: Dynamic View
106-
:id: feat_arc_dyn__feature_name__dynamic_view
107-
:security: YES
108-
:safety: ASIL_B
109-
:status: invalid
110-
:fulfils: feat_req__feature_name__some_title
111-
:belongs_to: feat__feature_name
110+
.. code-block:: rst
111+
112+
.. feat_arc_dyn:: Dynamic View
113+
:id: feat_arc_dyn__feature_name__dynamic_view
114+
:security: YES
115+
:safety: ASIL_B
116+
:status: invalid
117+
:fulfils: feat_req__feature_name__some_title
118+
:belongs_to: feat__feature_name
112119
113-
Put here a sequence diagram
120+
Put here a sequence diagram
114121
115122
Logical Interfaces
116123
------------------
117124

118-
.. logic_arc_int:: Interface Name
119-
:id: logic_arc_int__feature_name__interface_name1
120-
:security: YES
121-
:safety: ASIL_B
122-
:status: invalid
123-
:fulfils: feat_req__feature_name__some_title
125+
.. code-block:: rst
124126
125-
General Interface Description
127+
.. logic_arc_int:: Interface Name
128+
:id: logic_arc_int__feature_name__interface_name1
129+
:security: YES
130+
:safety: ASIL_B
131+
:status: invalid
132+
:fulfils: feat_req__feature_name__some_title
126133
127-
.. needarch::
128-
:scale: 50
129-
:align: center
134+
General Interface Description
130135
131-
{{ draw_interface(need(), needs) }}
136+
.. needarch::
137+
:scale: 50
138+
:align: center
132139
133-
.. logic_arc_int_op:: Operation
134-
:id: logic_arc_int_op__feature_name__operation
135-
:security: YES
136-
:safety: ASIL_B
137-
:status: invalid
138-
:included_by: logic_arc_int__feature_name__interface_name1
140+
{{ draw_interface(need(), needs) }}
139141
140-
General Operation Description
142+
.. logic_arc_int_op:: Operation
143+
:id: logic_arc_int_op__feature_name__operation
144+
:security: YES
145+
:safety: ASIL_B
146+
:status: invalid
147+
:included_by: logic_arc_int__feature_name__interface_name1
148+
149+
General Operation Description
141150
142151
Module Viewpoint
143152
----------------
144153

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

148-
.. mod:: Module Name
149-
:id: mod__module_name
150-
:includes: comp__component_name_template
157+
The rendered module and used-component examples are maintained in the
158+
`module template documentation <https://eclipse-score.github.io/module_template/main/>`_.
159+
160+
.. code-block:: rst
161+
162+
.. mod:: Module Name
163+
:id: mod__module_name
164+
:includes: comp__component_name_template
151165
152166
153-
.. mod_view_sta:: Module Name Static View
154-
:id: mod_view_sta__feature_name__module_name
155-
:includes: comp__component_name_template
167+
.. mod_view_sta:: Module Name Static View
168+
:id: mod_view_sta__feature_name__module_name
169+
:includes: comp__component_name_template
156170
157-
.. needarch::
158-
:scale: 50
159-
:align: center
171+
.. needarch::
172+
:scale: 50
173+
:align: center
160174
161-
{{ draw_module(need(), needs) }}
175+
{{ draw_module(need(), needs) }}
162176
163177
Used Components
164178
---------------

‎process/folder_templates/features/feature_name/requirements/index.rst‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -34,29 +34,33 @@ Feature Requirements
3434
<Headlines (for the list of requirements if structuring is needed)>
3535
===================================================================
3636

37-
.. feat_req:: Some Title
38-
:id: feat_req__feature_name__some_title
39-
:reqtype: Process
40-
:security: NO
41-
:safety: ASIL_B
42-
:satisfies: stkh_req__requirements__template
43-
:valid_from: v0.0.1
44-
:valid_until: v1.0.1
45-
:status: invalid
46-
:belongs_to: feat__feature_name
37+
.. code-block:: rst
4738
48-
The Feature shall do xyz to the user to bring him to this condition at this time.
39+
.. feat_req:: Some Title
40+
:id: feat_req__feature_name__some_title
41+
:reqtype: Process
42+
:security: NO
43+
:safety: ASIL_B
44+
:satisfies: stkh_req__requirements__template
45+
:valid_from: v0.0.1
46+
:valid_until: v1.0.1
47+
:status: invalid
48+
:belongs_to: feat__feature_name
4949
50-
Note: (optional, not to be verified)
50+
The Feature shall do xyz to the user to bring him to this condition at this time.
5151
52-
.. aou_req:: Some Other Title
53-
:id: aou_req__feature_name__some_other_title
54-
:reqtype: Process
55-
:security: NO
56-
:safety: ASIL_B
57-
:status: invalid
52+
Note: (optional, not to be verified)
53+
54+
.. code-block:: rst
55+
56+
.. aou_req:: Some Other Title
57+
:id: aou_req__feature_name__some_other_title
58+
:reqtype: Process
59+
:security: NO
60+
:safety: ASIL_B
61+
:status: invalid
5862
59-
The Feature User shall do xyz to use the feature safely.
63+
The Feature User shall do xyz to use the feature safely.
6064
6165
.. attention::
6266
The above directives must be updated according to your feature requirements.

‎process/folder_templates/modules/module_name/component_name/docs/architecture/index.rst‎

Lines changed: 67 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -72,42 +72,49 @@ The components are designed to cover the expectations from the feature architect
7272

7373
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.
7474

75-
.. comp:: Component Name
76-
:id: comp__component_name_template
77-
:security: YES
78-
:safety: ASIL_B
79-
:status: invalid
80-
:implements: logic_arc_int__feature_name__interface_name1
81-
:consists_of: comp__archex_sub_component_1, comp__archex_sub_component_2, comp__archex_sub_component_3
82-
:belongs_to: feat__feature_name
83-
84-
.. comp_arc_sta:: Component Name (Static View)
85-
:id: comp_arc_sta__component_name__static_view
86-
:security: YES
87-
:safety: ASIL_B
88-
:status: invalid
89-
:belongs_to: comp__component_name_template
90-
:uses: logic_arc_int__feature_name__interface_name1
91-
:fulfils: comp_req__component_name__some_title
75+
The live component architecture template is maintained in the
76+
`module template documentation <https://eclipse-score.github.io/module_template/component_architecture_template.html>`_.
9277

93-
.. needarch::
94-
:scale: 50
95-
:align: center
78+
.. code-block:: rst
9679
97-
{{ draw_component(need(), needs) }}
80+
.. comp:: Component Name
81+
:id: comp__component_name_template
82+
:security: YES
83+
:safety: ASIL_B
84+
:status: invalid
85+
:implements: logic_arc_int__feature_name__interface_name1
86+
:consists_of: comp__component_name_internal_1, comp__component_name_internal_2, comp__component_name_internal_3
87+
:belongs_to: feat__feature_name
88+
89+
.. comp_arc_sta:: Component Name (Static View)
90+
:id: comp_arc_sta__component_name__static_view
91+
:security: YES
92+
:safety: ASIL_B
93+
:status: invalid
94+
:belongs_to: comp__component_name_template
95+
:uses: logic_arc_int__feature_name__interface_name1
96+
:fulfils: comp_req__component_name__some_title
97+
98+
.. needarch::
99+
:scale: 50
100+
:align: center
101+
102+
{{ draw_component(need(), needs) }}
98103
99104
Dynamic Architecture
100105
--------------------
101106

102-
.. comp_arc_dyn:: Dynamic View
103-
:id: comp_arc_dyn__component_name__dynamic_view
104-
:security: YES
105-
:safety: ASIL_B
106-
:status: invalid
107-
:belongs_to: comp__component_name_template
108-
:fulfils: comp_req__component_name__some_title
107+
.. code-block:: rst
108+
109+
.. comp_arc_dyn:: Dynamic View
110+
:id: comp_arc_dyn__component_name__dynamic_view
111+
:security: YES
112+
:safety: ASIL_B
113+
:status: invalid
114+
:belongs_to: comp__component_name_template
115+
:fulfils: comp_req__component_name__some_title
109116
110-
Put here a sequence diagram
117+
Put here a sequence diagram
111118
112119
113120
Interfaces
@@ -125,15 +132,38 @@ Interfaces
125132
Internal Components
126133
-------------------
127134

128-
.. comp_arc_sta:: Component Name Static View
129-
:id: comp_arc_sta__component_name__2
130-
:status: invalid
131-
:safety: ASIL_B
132-
:security: YES
133-
:fulfils: comp_req__component_name__some_title
134-
:belongs_to: comp__component_example_2
135+
.. code-block:: rst
135136
136-
No architecture but detailed design
137+
.. comp_arc_sta:: Component Name Static View
138+
:id: comp_arc_sta__component_name__2
139+
:status: invalid
140+
:safety: ASIL_B
141+
:security: YES
142+
:fulfils: comp_req__component_name__some_title
143+
:belongs_to: comp__component_name_template
144+
145+
No architecture but detailed design
146+
147+
.. comp:: Internal Component 1
148+
:id: comp__component_name_internal_1
149+
:status: invalid
150+
:safety: ASIL_B
151+
:security: YES
152+
:belongs_to: feat__feature_name
153+
154+
.. comp:: Internal Component 2
155+
:id: comp__component_name_internal_2
156+
:status: invalid
157+
:safety: ASIL_B
158+
:security: YES
159+
:belongs_to: feat__feature_name
160+
161+
.. comp:: Internal Component 3
162+
:id: comp__component_name_internal_3
163+
:status: invalid
164+
:safety: ASIL_B
165+
:security: YES
166+
:belongs_to: feat__feature_name
137167
138168
.. note::
139169
Architecture can be split into multiple files. At component level the public interfaces to be used by the user and tester to be shown.

0 commit comments

Comments
 (0)