Operations¶

FORMAT · OPERATIONS

The operations: field declares callable operations (synchronous) or receptions (asynchronous) on a definition element. It maps directly to SysMLv2 OperationDef (synchronous) and ReceptionDef (asynchronous) owned by the enclosing definition.

Where it is valid¶

operations: is valid on any definition element. The primary use cases are:

• PortDef — operations exposed through this port
• InterfaceDef — operations spanning both ends of the interface
• ConnectionDef — operations on the connection itself
• PartDef — operations on the structural component

Operation entry schema¶

Parameter entry schema¶

Rules¶

• isAsync: true and returnType: are mutually exclusive. An async reception cannot return a value.
• typedBy on a parameter and returnType at the operation level are checked against the model resolver. Unresolved types fire W404 (warning, not error — standard library types such as ScalarValues::Boolean and ScalarValues::Integer are common unregistered external namespaces).

Example — PortDef with sync query and async reception¶

---
type: PortDef
name: TelemetryPortDef
supertype: Ports::Port
features:
  - name: packet
    typedBy: Items::TelemetryPacket
    direction: out
    multiplicity: "0..*"
operations:
  - name: requestLatest
    doc: "Return the most recent telemetry packet synchronously."
    isQuery: true
    parameters: []
    returnType: Items::TelemetryPacket
  - name: subscribe
    doc: "Register for periodic telemetry push at the given interval."
    isAsync: true
    parameters:
      - name: intervalMs
        typedBy: ScalarValues::Integer
        direction: in
---
Port definition for outgoing telemetry data.

Example — InterfaceDef with operations spanning both ends¶

---
type: InterfaceDef
name: CommandInterface
ends:
  - name: commander
    typedBy: Interfaces::ControlPortDef
  - name: executor
    typedBy: Interfaces::ControlPortDef
    isConjugated: true
operations:
  - name: executeCommand
    parameters:
      - name: cmd
        typedBy: Items::ControlCommand
        direction: in
    returnType: ScalarValues::Boolean
  - name: abort
    isAsync: true
    parameters: []
---
Interface definition for command dispatch between a commander and an executor.

Realisation by an action¶

realizedBy: <ActionDef> ties the contract to the behaviour. The action's parameters must match the operation's:

• every operation parameter has an action parameter of the same name and direction (default in), with the same typedBy and the same unit when both give one;
• the action has no parameter the operation lacks, apart from its one direction: return parameter, which is the operation's returnType (both or neither, the same type when both give one); an isAsync operation has no return.

Each difference is one E672 on the element that declares the operation. Operations that declare neither errors nor realizedBy are not looked at.

operations:
  - name: compute
    parameters:
      - {name: x, typedBy: ScalarValues::Integer, direction: in}
    returnType: ScalarValues::Boolean
    errors: [Items::Fault]
    realizedBy: Behaviour::Compute     # an ActionDef with parameters x (in) and one return

Calling an operation¶

A SendAction or PerformAction in an ActionDef's subActions: (at any depth, including then/else/body) names the operation it calls with operation: <owner>::<name>; its parameters: entries (name, value) are the arguments.

subActions:
  - name: sample
    kind: PerformAction
    operation: Sensors::Adc::read
    parameters:
      - {name: channel, value: "1"}

The owner must resolve and declare that operation, else E673. An argument that is not an in/inout parameter of the operation, or an in/inout parameter with no argument, is E674. The value of each argument is typed statically (a number with an optional unit such as 2 s, a boolean, a string) and compared with its parameter's typedBy and unit: a different kind or unit dimension is E675 (dimensions are compared, so 2 ms fills a parameter in s). Names and parameters of other types are not checked. A sub-action without operation: is not looked at.

Validation¶