Manual

This page gives some basic information on how to use the FW Profile. Note that use of the profiles requires familiarity with the content of the ASSERT technical note D4.2.2-1 . Note also that installation information is provided separately in the download page.

Usage Scenario

This section presents a guide through basic use of the FW Profile Validator. It starts with new UML model, applies the FW Profile and UML Profile to the model, creates couple of UML entities, applies a FwTrigger stereotype, and runs the verification.

Create New Model

  1. Select the File | New | Project... | General | Project , click Next, enter a project name (e.g. FwProfileDemo ) and click Finish.
  2. Right-click the Project folder and select New | UML Diagram . You may keep the default file name ( DefaultName.uml ) and click Finish.
  3. DefaultName.uml file is created and it is automatically opened in the Topcased UML Modeler editor.
  4. Locate the Outline view (Window | Show View | ther | General | Outline) and expand the Model item in the outline view. There is a default package named DefaultName. When you expand the package you can see a class diagram.

Apply the FW Profile

Right-click the Model element in the outline view and choose Load Resource... In the Load Resource dialog do not click any of the Browse... buttons. Instead enter the following text to the text field and click OK:
pathmap://FW_PROFILE/EthFwProfile.profile.uml

PathMap

Figure 1: PathMap

It is crucial to specify the resource location using a path map. If the location of the profile is specified either relative to the workspace of as an absolute path in the file system, the model will not be (reliably) portable.

Once the resource is loaded via the path map, it is possible to apply the FW Profile to the model. Right-click the Model element and select Apply Profile

ApplyProfile

Figure 2: ApplyProfile

In the "Choose the profile to apply" dialogue double-click the EthFwProfile. Make sure that the EthFwProfile item have moved from Choices to Feature and click OK.

ChooseTheProfileToApply

Figure 3: ChooseTheProfileToApply

Now the profile are applied to the model. Note the Profile Application subelement of the Model element in the Outline view.

Apply Stereotypes

  1. Right-click the DefaultName package element and select Create Child and then Owned Type | Class.
  2. A new Class Element has been added to the model. Use the Properties view (Window | Show View | ther | General | Properties) to set the name of the class to Class1.
  3. Right-click the Class1 class element and select Create Child and then Owned Operation | Operation. In Topcased 1.0 it is the last but one item in the "Create Child" submenu and you probably have to sroll down the long list to see the "Owned Operation | Operation".
  4. Locate the newly added operation in the outline view and use the properties view to set a name to operation1.
  5. Right-click the operation1 element in the outline view and choose Apply Stereotype item.

ApplyStereotype1

Figure 4: ApplyStereotype1

In the Choose stereotypes to apply dialogue double-click the EthFwProfile::FwTriggerOperation and make sure it appears on right. Click OK.

ApplyStereotype2

Figure 5: ApplyStereotype2

Finish the editing of the model:

  1. Right-click the Class1 element in the outline view and choose Apply Stereotype item.
  2. In the Choose stereotypes to apply dialogue double-click the EthFwProfile::FwClass and make sure it appears on right. Click OK.
  3. Save the model.

Validate the Model

Click the editor area (the one with tab named DefaultName.umldi). Note that a green button in the tool bar became active. If you hoover the cursor over the button the tool tip says "Validate the model". Click the button.

Validate1

Figure 6: Validate1

An error in the model is reported. Click Details the see the arror message. Then click the OK.

Validate2

Figure 7: Validate2

Select Window | Show View | Problems. In the Problems view you can see the validation error again. If you cannot read the whole error message, right-click it and select Properties. If needed, enlarge the Properties window. Now you can read: "[FW Profile] The trigger operation operation1 is not defined as final". This means that the operation violates FinalModifierConstraint of the FW Profile.

Validate3

Figure 8: Validate3

To fix the error do the following:

  1. Go the Properties view
  2. Locate the operation1 in the Outline view
  3. Select the Advanced tab in the Properties view
  4. Locate the "Is Leaf" property in the property view and change it to true (see the screenshot).
  5. Validate the model again: Click to the editor area first and then the "Validate the model" button.

Validate4

Figure 9: Validate4

Note that the error is fixed:

Validate5

Figure 10: Validate5

This ends the user manual.