Holarch
Course chapters

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

9.2 Ports and Interfaces 3:44

Define ports and interfaces, connect parts in text, and draw an interface in a view.

Shows Holarch 2.22.

What you’ll learn

  • Define a port with directed attributes and conjugate it with `~`
  • Define an interface whose ends are typed by ports
  • Connect parts with an interface usage and bind a boundary port to an inner part's port
  • Create an Interconnection View and draw an interface between two ports

Define SysML v2 ports and interfaces in Holarch, following the SysML v2 tutorial Ports and Interfaces on a small Hybrid Car project: a port definition with directions, a conjugated port, an interface definition with two ends, a powertrain whose parts are connected by interfaces and a binding, an Interconnection View of it, and an interface drawn in the view that Holarch writes into the text. 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 Vehicles.
  2. Below interface def HighVoltageBus, add interface def ControlLink { end commander : ~ControlPort; end unit : ControlPort; }.
  3. In part def Powertrain, replace connect controller.engineCtl to engine.ecu; with interface engineControl : ControlLink connect controller.engineCtl to engine.ecu;, and add part auxBattery : Battery; after part battery : Battery;.
  4. Open Architecture → Interconnection Views and the view powertrainConnections. Drag from the handle of auxBattery's port powerOut to the motor's port powerIn and choose Interface : HighVoltageBus.
  5. Select the new line and enter auxBus as its Name in the inspector. Then open Model → Editor and find the line Holarch wrote in Powertrain.

You're done when Powertrain holds interface engineControl : ControlLink … and the auxBus interface from the view, and the status under the editor reports no problems.

Check yourself

  1. The engine has port fuelIn : ~FuelPort;. What does the tilde change?
  2. What is the difference between bind output = transmission.output; and interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;?
  3. Why does the view offer Interface : HighVoltageBus when you drag from a battery's powerOut to the motor's powerIn?
Show the answers
  1. The engine has port fuelIn : ~FuelPort;. What does the tilde change?

    It conjugates the port: the engine's port has the same features as FuelPort with the directions reversed, so FuelPort's out attribute flowRate arrives at the engine as an input.

  2. What is the difference between bind output = transmission.output; and interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;?

    A binding says the two features are the same: the powertrain's boundary port is the transmission's output. An interface usage connects two different ports, and its interface definition says which ports its ends accept.

  3. Why does the view offer Interface : HighVoltageBus when you drag from a battery's powerOut to the motor's powerIn?

    Holarch offers the interface definitions whose ends fit both ports. HighVoltageBus has the ends source : PowerPort and load : ~PowerPort, which match the two ports.

Read more

Transcript

Show the transcript (narration and what is on screen)

Introduction

Chapter two: ports and interfaces. A port is where a part meets the world outside it. An interface says which ports may connect.

In this chapter you define a port and an interface, connect parts in a powertrain, and draw an interface in a view.

Start the tutorial

Start the tutorial Ports and Interfaces from Project Files, Start a Tutorial. Its starter project holds the car's components with their torque and power ports, two interface definitions, and nothing yet for fuel.

On screen: Project Files ▾ → Start a Tutorial… → SysML v2: Ports and Interfaces → Start.

Ports

Above the torque port, define the fuel port. A port definition lists what crosses the port. Out means the flow rate leaves the part that owns the port.

On screen: Below FuelKind; type port def FuelPort.

The tank owns a fuel port. The engine takes fuel in, so its port is conjugated with a tilde: the same features, with in and out reversed.

On screen: FuelTank: port fuelOut : FuelPort; Engine: port fuelIn : ~FuelPort;

Interfaces

An interface definition says which ports may connect. Below the high voltage bus, define the fuel line, with a supply end and a conjugated consumer end.

On screen: Below HighVoltageBus; type interface def FuelLine.

Connect the parts

Now the powertrain: a part definition made of parts. Its own output port is bound to the transmission's output, so the two are one and the same.

On screen: After Transmission; type part def Powertrain with five parts, a port and bind.

Connect the tank to the engine with a fuel line. A dotted name reaches into a part: from the tank's fuel out, to the engine's fuel in.

On screen: In Powertrain after part transmission: interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;

The engine and the motor both drive the transmission, through a shaft each.

On screen: Two shaft interfaces.

The status under the editor says the text is applied, with no problems.

On screen: Applied, No problems.

The Interconnection View

Now see the powertrain as a view. Open Architecture, then Interconnection Views, and click New Diagram. Keep Interconnection View, choose the powertrain under Shows, and click Create.

On screen: Architecture → Interconnection Views → + New Diagram; Shows: Vehicles::Powertrain; Create.

The parts sit inside the frame with their ports on their sides. Each line is an interface from the text, and the output port on the frame is bound to the transmission.

On screen: The view.

Draw an interface

The battery does not feed the motor yet. Drag from the battery's power out port to the motor's power in. Holarch offers what fits both ports: choose Interface, High Voltage Bus.

On screen: Select battery.powerOut; drag its handle to motor.powerIn → Interface : HighVoltageBus.

Select the new line, and name it H V Bus in the inspector.

On screen: Click the new line; inspector Name: hvBus.

Close the inspector and open the text again. Holarch wrote the interface into the powertrain, with its name, its type and both ends.

On screen: Inspector ×; Model → Editor: the interface hvBus line in Powertrain.

Recap

Every step is ticked off. Click Mark as Done.

On screen: Step panel → Mark as Done.

Let's recap. You defined a port with a direction, conjugated it for the engine, defined an interface with two ends, connected the powertrain's parts in text, and drew an interface that Holarch wrote back into the text.

Next, actions and flows describe what the car does.