Holarch
Course chapters

Training · Track 9. SysML v2 Fundamentals · Chapter 9.4 of 8

9.4 States and Transitions 3:51

Write a state machine with triggers, guards and state actions, and draw a timed transition.

Shows Holarch 2.22.

What you’ll learn

  • Define signals and a state definition with an initial state
  • Write transitions with a trigger, a guard and a target, in the short form and as named transitions
  • Give a state entry, do and exit actions
  • Draw a transition in a State Transition View and set its name and trigger
  • Let a part exhibit a state definition

Write a SysML v2 state machine in Holarch, following the SysML v2 tutorial States and Transitions on a small Hybrid Car project: signals as definitions, a state definition with an initial state, transitions with triggers and guards, entry, do and exit actions, named transitions, a State Transition View with a timed transition drawn on it, and a car that exhibits the states. SysML is a registered trademark of Object Management Group, Inc.

Project files

  • Finished project (.holarch.json; Manage Projects → Project Files ▾ → Import Project (.json)…)

The video plays from holarch.app; see the Privacy Policy.

Practice

Do this yourself in Holarch, on the Hybrid Car demo project (SysML v2).

  1. Open your Hybrid Car demo project (create it if needed: Manage Projects → Project Files ▾ → New Demo Project → Hybrid Car (SysML v2)), open Model → Editor and the package VehicleBehavior.
  2. After attribute def Unplug;, add attribute def FaultDetected;.
  3. Before the closing brace of state def PowertrainStates, add state limpHome { entry action warnDriver; do action driveLimited; } and transition limpStop first limpHome accept StopRequest then off;.
  4. Open Behavior → State Machines, click + New Diagram, choose PowertrainStates under Shows and click Create.
  5. Select electric and drag from its handle to limpHome; drop on Transition. In the transition panel, enter the Name electricFault and the Trigger FaultDetected, then click Show in Text.

You're done when PowertrainStates holds limpHome, limpStop and the transition electricFault that accepts FaultDetected, and the status under the editor reports no problems.

Check yourself

  1. What makes off the initial state of PowertrainStates?
  2. After state off; comes accept StartRequest if charge > 20 then electric;. Name its trigger, guard, source and target.
  3. When do a state's entry, do and exit actions run?
  4. What does exhibit state powertrainStates : PowertrainStates; in DrivenCar say?
Show the answers
  1. What makes off the initial state of PowertrainStates?

    entry; then off;: the entry is followed by a succession to off, so the state machine starts there. The view draws it as the dot.

  2. After state off; comes accept StartRequest if charge > 20 then electric;. Name its trigger, guard, source and target.

    Trigger: the signal StartRequest. Guard: charge > 20. Target: electric. The short form starts at the state it follows, off.

  3. When do a state's entry, do and exit actions run?

    The entry action runs when the state is entered, the do action while the state is active, and the exit action when the state is left.

  4. What does exhibit state powertrainStates : PowertrainStates; in DrivenCar say?

    That the car exhibits this state machine: the car owns a usage of PowertrainStates, so its states are the car's states.

Read more

Transcript

Show the transcript (narration and what is on screen)

Introduction

Chapter four: states and transitions. A state machine says how a system reacts to events, and what it does in each state.

In this chapter you write signals and a state machine with triggers, guards and state actions, draw a timed transition in a view, and let the car exhibit the states.

Start the tutorial

Start the tutorial States and Transitions from Project Files, Start a Tutorial. Its starter project holds the powertrain package with the car, and nothing else yet.

On screen: Project Files ▾ → Start a Tutorial… → SysML v2: States and Transitions → Start; Model → Editor.

The state machine

A state machine reacts to signals, and in SysML v2 they are plain definitions. After the imports, define four: start request, stop request, plug in and unplug.

On screen: After the imports: four attribute defs.

Below the signals, write the state definition. Charge is an input that the transitions read. Entry, then off, makes off the initial state.

On screen: Below Unplug: state def PowertrainStates with three states.

Transitions and state actions

A transition has a trigger, a guard and a target. After the off state, a start request goes to electric when the charge is above twenty, and to hybrid otherwise. This short form starts at the state it follows.

On screen: After state off;: accept StartRequest if charge > 20 then electric; accept StartRequest then hybrid;

Now give the electric state its actions. Replace its line with a body: the entry action runs when the state is entered, the do action while it is active, and the exit action when it is left.

On screen: Select state electric; and type its body.

After the electric state, the powertrain switches to hybrid when the charge drops below fifteen, and turns off on a stop request. The hybrid state turns off on a stop request too.

On screen: After electric's closing brace: if charge < 15 then hybrid; accept StopRequest then off; after state hybrid;: accept StopRequest then off;

Before the closing brace of the state definition, add the charging state and two named transitions. A named transition says where it starts, with first.

On screen: After hybrid's stop transition: state charging; transition plugIn; transition unplugged.

The State Transition View

Open Behavior, then State Machines, and click New Diagram. Keep State Transition View, choose the powertrain states under Shows, and click Create.

On screen: Behavior → State Machines → + New Diagram; Shows: PowertrainBehavior::PowertrainStates; Create.

States show their entry, do and exit actions, and the dot marks the initial state. Each transition reads its trigger, the guard in square brackets, then a slash and the effect.

On screen: The view.

Draw a timed transition

A full charge takes half an hour, then the car switches off. Select the charging state, and drag from its handle to the off state. The drop makes a transition.

On screen: Select charging; drag its handle onto off.

In the transition panel, name it charged, and set its trigger to after thirty minutes.

On screen: Transition panel: Name charged; Trigger after 30 [min].

Open the Editor. The new transition is in the state definition: named charged, it accepts after thirty minutes, and goes to off.

On screen: Model → Editor: the transition charged.

Exhibit

Last, let the car exhibit the states. Inside the car, after its doc line, add an exhibit state usage. The state machine now belongs to the car.

On screen: In part def Car after doc: exhibit state powertrainStates : PowertrainStates;

Recap

Every step is ticked off. Click Mark as Done.

On screen: Step panel → Mark as Done.

Let's recap. You defined signals, wrote a state definition with an initial state, transitions with triggers and guards, and state actions, drew a timed transition that Holarch wrote into the text, and let the car exhibit the states.

Next, requirements say what the car must do, in a form the model can check.