Skip to content

Commit 46bccad

Browse files
committed
[doc] Update Flashlight tutorial in documentation
Bug: #1551 Signed-off-by: Axel RICHARD <axel.richard@obeo.fr>
1 parent 64c249d commit 46bccad

1 file changed

Lines changed: 18 additions & 17 deletions

File tree

doc/content/modules/user-manual/pages/hands-on/tutorials/flashlight.adoc

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ image::flashlight-model-organization.png[Flashlight Model Organization]
2828

2929
== Step 3: Flashlight Requirements Tree
3030

31-
. In the explorer, select the `Requirements` package, click the "more" menu, and choose `New representation`
31+
. In the `Explorer` view, select the `Requirements` package, click the "more" menu, and choose `New representation`
3232
. Set the name of the representation to `Requirements General View`.
3333
. Create a new `General View` and open it.
3434
. In the main editor area, right-click on the diagram background to open the palette.
3535
. Click on `Requirements` -> `New Requirement` to create a new requirement.
3636
. Rename it to `flashlightSpecification`.
3737
. Right-click on the `flashlightSpecification` requirement, then select `Requirements` -> `New Requirement` to create a nested requirement.
3838
. Rename the new requirement to `userInterface`.
39-
. In the explorer, select `flashlightSpecification`, click the "more" menu, and choose `New objects from text`.
39+
. In the `Explorer` view, select `flashlightSpecification`, click the "more" menu, and choose `New objects from text`.
4040
. In the modal input box, paste the following content:
4141
[source, sysml]
4242
----
@@ -58,7 +58,7 @@ requirement physical{
5858
requirement reliability;
5959
requirement cost;
6060
----
61-
. Select the newly created elements (`illumination`, `physical`, `reliability`, `cost`, `portability`, `size`, `weight`, `fieldOfView`, `lightPower`) in the explorer (Ctrl + Click), and drag-and-drop them into the diagram.
61+
. Select the newly created elements (`illumination`, `physical`, `reliability`, `cost`, `portability`, `size`, `weight`, `fieldOfView`, `lightPower`) in the `Explorer` view (Ctrl + Click), and drag-and-drop them into the diagram.
6262
. Use the `Arrange all elements` tool from the diagram toolbar to auto layout the diagram.
6363
. Right-click on the `size` requirement and select `Show/Hide -> Show valued content` to display the documentation in the diagram.
6464
. Repeat the operation for the children of `illumination`: `fieldOfView` and `lightPower`.
@@ -69,15 +69,15 @@ requirement cost;
6969
. Right-click on the background of diagram and use the tool `New Namespace Import`.
7070
Then select `SI/Library Package SI` to import it from the standard libraries.
7171
. Use the palette filter to locate the `New Required Constraint` tool, and apply it to the `weight` requirement.
72-
. Edit the constraint to: `actualweight\<=0.25[kg]`
72+
. Edit the constraint to: `actualweight \<= 0.25 [kg]`
7373

7474
image::flashlight-requirements-tree.png[Flashlight Requirements Tree]
7575

7676
== Step 4: Produce Directed Light Action Flow
7777

78-
. In the explorer, select the `ActionTree` package, click the "more" menu, and choose `New representation`.
79-
. Set the name of the representation to `Action Tree General View`.
80-
. Create a new `General View` and open it.
78+
. In the `Explorer` view, select the `ActionTree` package, click the "more" menu, and choose `New representation`.
79+
. Set the name of the representation to `Action Tree ActionFlow View`.
80+
. Create a new `ActionFlow View` and open it.
8181
. In the main editor area, right-click on the diagram background to open the palette.
8282
. Click on `Behavior` -> `New Action` to create a new action.
8383
. Rename it `produceDirectedLight`.
@@ -90,7 +90,7 @@ image::flashlight-requirements-tree.png[Flashlight Requirements Tree]
9090
. Select `fork1` and use the connection tool to create a succession to the `provideDCPwr` action.
9191
. Right-click on `provideDCPwr`, then select `Structure`-> `New Item Out`.
9292
. Rename the item to `outdcPwr`.
93-
. In the explorer, select the `produceDirectedLight` action, click the "more" menu, and choose `New objects from text`.
93+
. In the `Explorer` view, select the `produceDirectedLight` action, click the "more" menu, and choose `New objects from text`.
9494
. In the model input box, paste the following content:
9595
[source,sysml]
9696
----
@@ -112,18 +112,18 @@ action directLight{
112112
----
113113
. In the `action flow` compartment of `produceDirectLight` use the tool `Related Elements -> Add existing element`.
114114
. Create a new transition between `fork1` and `connectDCPwr`.
115-
. Set the value of `connectDCPwr::onOffCmd` by renaming the item `in onOffCmd` of `connectDCPwr` to `in onOffCmd = produceDirectedLight.onOffCmd`
115+
. Set the value of `connectDCPwr::onOffCmd` by renaming the item `in onOffCmd` of `connectDCPwr` to `in onOffCmd = produceDirectedLight.onOffCmd`.
116116
. Create a `Flow Connection (flow)` from `dcPwrOut` of `connectDCPwr` to `dcPwrIn` of `generateLight`.
117117
. Create a `Flow Connection (flow)` between `light` of `generateLight` to `lightIn` of `directLight`.
118118
. Create a `Flow Connection (flow)` between `outdcPwr` of `provideDCPwr` to `dcPwrIn` of `connectDCPwr`.
119-
. Using the eye icon on the `produceDirectLight` action display the `items` compartement
119+
. Using the eye icon on the `produceDirectLight` action display the `items` compartment.
120120
. Set the value of `produceDirectedLight::lightOut` by renaming the item `out lightOut` of `produceDirectedLight` to `out lightOut = directLight.lightOut`.
121121

122122
image::flashlight-action-tree.png[Flashlight Requirements Tree]
123123

124124
== Step 5: Flashlight Interconnection
125125

126-
. In the explorer, select the `PartsTree` package, click the "more" menu, and choose `New representation`.
126+
. In the `Explorer` view, select the `PartsTree` package, click the "more" menu, and choose `New representation`.
127127
. Set the name of the representation to `Parts Tree General View`.
128128
. Create a new `General View` and open it.
129129
. In the main editor area, right-click on the diagram background to open the palette.
@@ -134,9 +134,10 @@ image::flashlight-action-tree.png[Flashlight Requirements Tree]
134134
. Right-click again on `flashlight`, and use the quick access tool `New Attribute` to add `fov:Real`.
135135
. Right-click again on `flashlight`, and use the quick access tool `New Attribute` to add `illuminationLevel:Real`.
136136
. Right-click on `flashlight`, then select the `Behavior` -> `New Perform` and select the action `produceDirectedLight` created earlier.
137-
. In the explorer, select the `flashlight` part, click the "more" menu, and choose `New representation`.
137+
. In the `Explorer` view, select the `flashlight` part, click the "more" menu, and choose `New representation`.
138138
. Set the name of the representation to `Flashlight Interconnection View`.
139139
. Create a new `Interconnection View` and open it.
140+
. Drag and drop `flashlight` from the `Explorer` view to newly created Interconnection View diagram.
140141
. Right-click on `flashlight`, then select the `Structure` -> `New Port`.
141142
. Rename it `cmdPort`.
142143
. Right-click on `flashlight`, then select the `Structure` -> `New Part` to create a nested part.
@@ -155,7 +156,7 @@ image::flashlight-action-tree.png[Flashlight Requirements Tree]
155156
. Right-click on `battery`, then select the `Structure` -> `New Port Out`.
156157
. Rename it `dcPwrOutPort`.
157158
. Select `dcPwrOutPort`, create a flow between `dcPwrOutPort` and `inPort`.
158-
. In the explorer, select the `flashlight` part, click the "more" menu, and choose `New objects from text`.
159+
. In the `Explorer` view, select the `flashlight` part, click the "more" menu, and choose `New objects from text`.
159160
. In the model input box, paste the following content:
160161
[source,sysml]
161162
----
@@ -192,7 +193,7 @@ image::flashlight-interconnection.png[Flashlight Interconnection]
192193

193194
== Step 6: Flashlight States
194195

195-
. In the explorer, select the `flashlight` part, click the "more" menu, and choose `New representation`.
196+
. In the `Explorer` view, select the `flashlight` part, click the "more" menu, and choose `New representation`.
196197
. Set the name of the representation to `Flashlight General View`.
197198
. Create a new `General View` and open it.
198199
. In the main editor area, right-click on the diagram background to open the palette.
@@ -210,13 +211,13 @@ image::flashlight-states.png[Flashlight States]
210211

211212
== Step 7: Flashlight Requirements Allocation
212213

213-
. In the explorer, select the `RequirementsAllocation` package, click the "more" menu, and choose `New representation`.
214+
. In the `Explorer` view, select the `RequirementsAllocation` package, click the "more" menu, and choose `New representation`.
214215
. Create a new `General View` and open it.
215-
. Drag and drop the following elements from the explorer to the diagram :
216+
. Drag and drop the following elements from the `Explorer` view to the diagram :
216217
** *Requirements*:
217218
*** `flashlightSpecification`,
218219
*** `illumination`,
219-
*** `fieldofView`,
220+
*** `fieldOfView`,
220221
*** `lightPower`,
221222
*** `physical`,
222223
*** `weight`;

0 commit comments

Comments
 (0)