@memoarchitect/ontology 0.7.0 → 0.8.24

package/extensions/ros/src/ros_extension.sysml

@@ -0,0 +1,200 @@
+// ROS 2 (Robot Operating System 2).
+//
+// The acceptance test for MEMO's extension point (plan §10.3): a whole
+// technology stack — nodes, messages, topics, quality of service, services,
+// actions, and
+// containerized deployment — landing without a single change to a base
+// relation. `BuildsInto`, `DeploysTo`, and `ProvidesEnvironment` are reused
+// exactly as the base declares them.
+//
+// Composition is by MODULE LIST, not by chaining. `baseMethodology` is [0..1],
+// but `includedModule` is [0..*], so this extension's methodology names
+// `memo_extension_messaging` and `memo_extension_container` alongside its own
+// module. ROS communication specializes native MEMO item, port, and interface
+// families; it does not invent publish/subscribe relations.
+package memo_extension_ros {
+    private import ScalarValues::*;
+
+    private import memo_core_common::*;
+    private import memo_architecture_functional_behavior::*;
+    private import memo_architecture_logical_interfaces::*;
+    private import memo_architecture_implementation_software_structure::*;
+    private import memo_architecture_implementation_software_runtime::*;
+    private import memo_extension_messaging::*;
+    private import memo_extension_container::*;
+
+    // ── Quality of service ──────────────────────────────────────────────
+    //
+    // QoS is the first real customer for "where do per-technology properties
+    // live" (plan C3, open question §14.6). The answer is a typed
+    // `attribute def` on the extension's own types — NOT the base's
+    // `PropertySet` stub, which was one String field and could not say what a
+    // reliability setting is. A typed profile can be validated, compared
+    // between a publisher and a subscriber, and read by a tool; a property bag
+    // cannot. `PropertySet` is deleted in this session for that reason.
+
+    // ROS 2 RELIABLE resends until delivery; BEST_EFFORT does not. This is
+    // the delivery guarantee, so it maps onto MessagingDeliveryKind:
+    // bestEffort is atMostOnce, reliable is atLeastOnce.
+    enum def RosReliabilityKind {
+        enum bestEffort;
+        enum reliable;
+    }
+    // TRANSIENT_LOCAL replays the last samples to a late-joining subscriber;
+    // VOLATILE does not. The difference decides whether a node that restarts
+    // sees the current state or waits for the next publication — which is a
+    // safety-relevant fact when the topic carries a latched mode or setpoint.
+    enum def RosDurabilityKind {
+        enum volatile;
+        enum transientLocal;
+    }
+
+    attribute def RosQosProfile {
+        attribute reliability : RosReliabilityKind;
+        attribute durability : RosDurabilityKind;
+        // The QoS contract: a sample is expected at least this often.
+        attribute deadlineMs : Real;
+        // How long a publisher may be silent before subscribers treat it as
+        // lost — ROS 2 liveliness lease duration.
+        attribute livelinessLeaseMs : Real;
+        // Depth of the history buffer, KEEP_LAST(n) / KEEP_ALL.
+        attribute historyDepth : Integer;
+    }
+
+    // ── Nodes, messages, topics, and endpoint roles ────────────────────
+
+    // A ROS node. `runtimeKind` is deliberately NOT bound: a node may run as
+    // its own process or be composed with others into a single container
+    // process, and which one it is is a design decision the model should
+    // record rather than a fact the type can assert.
+    part def RosNode specializes SoftwareComponent {
+        attribute nodeNamespace : String;
+        // Whether the node implements the managed-node lifecycle
+        // (unconfigured / inactive / active / finalized). A lifecycle-managed
+        // node can be brought up in a defined order and held inactive until
+        // its preconditions hold, which is how a robot reaches a safe state.
+        attribute lifecycleManaged : Boolean;
+        attribute executorModel : String;
+    }
+
+    // A definition is the ROS message contract (`LaserScan`, `Twist`, ...).
+    // A named item usage of that definition is a deployed topic (`/scan`).
+    // Individual deliveries are native flows/messages between ports that
+    // reference the same topic usage.
+    abstract item def RosMessage specializes MessagingMessage {
+        attribute rosTypeName : String;
+    }
+
+    port def RosPublisher specializes MessagingPublisher {
+        attribute offeredQos : RosQosProfile;
+    }
+
+    port def RosSubscriber specializes MessagingSubscriber {
+        attribute requestedQos : RosQosProfile;
+    }
+
+    interface def RosTopicInterface specializes MessagingTopicInterface {
+        end rosPublisher : RosPublisher :>> publisher;
+        end rosSubscriber : RosSubscriber :>> subscriber;
+    }
+
+    // ── Services: one correlated request/reply contract ────────────────
+    abstract item def RosServiceRequest specializes RosMessage;
+    abstract item def RosServiceResponse specializes RosMessage;
+
+    port def RosServiceClient specializes SoftwarePort {
+        out item request : RosServiceRequest;
+        in item response : RosServiceResponse;
+        attribute serviceName : String;
+        attribute timeoutMs : Real;
+    }
+
+    port def RosServiceServer specializes SoftwarePort {
+        in item request : RosServiceRequest;
+        out item response : RosServiceResponse;
+        attribute serviceName : String;
+    }
+
+    interface def RosServiceInterface specializes SoftwareInterface {
+        end client : RosServiceClient :>> source;
+        end server : RosServiceServer :>> target;
+        flow of RosServiceRequest from client.request to server.request;
+        flow of RosServiceResponse from server.response to client.response;
+    }
+
+    // ── Actions: long-running goal protocol ─────────────────────────────
+    // ROS 2 realizes an action through goal/result/cancel services plus
+    // feedback/status topics. The port exposes those distinct native message
+    // features, so an action cannot be mistaken for a two-message service.
+    abstract item def RosActionGoal specializes RosMessage;
+    abstract item def RosActionAcceptance specializes RosMessage;
+    abstract item def RosActionFeedback specializes RosMessage;
+    abstract item def RosActionResult specializes RosMessage;
+    abstract item def RosActionCancel specializes RosMessage;
+    abstract item def RosActionStatus specializes RosMessage;
+
+    port def RosActionClient specializes SoftwarePort {
+        out item goal : RosActionGoal;
+        in item acceptance : RosActionAcceptance;
+        in item feedback : RosActionFeedback;
+        in item result : RosActionResult;
+        out item cancel : RosActionCancel;
+        in item actionStatus : RosActionStatus;
+        attribute actionName : String;
+    }
+
+    port def RosActionServer specializes SoftwarePort {
+        in item goal : RosActionGoal;
+        out item acceptance : RosActionAcceptance;
+        out item feedback : RosActionFeedback;
+        out item result : RosActionResult;
+        in item cancel : RosActionCancel;
+        out item actionStatus : RosActionStatus;
+        attribute actionName : String;
+    }
+
+    interface def RosActionInterface specializes SoftwareInterface {
+        end client : RosActionClient :>> source;
+        end server : RosActionServer :>> target;
+        flow of RosActionGoal from client.goal to server.goal;
+        flow of RosActionAcceptance from server.acceptance to client.acceptance;
+        flow of RosActionFeedback from server.feedback to client.feedback;
+        flow of RosActionCancel from client.cancel to server.cancel;
+        flow of RosActionResult from server.result to client.result;
+        flow of RosActionStatus from server.actionStatus to client.actionStatus;
+    }
+
+    abstract state def RosActionExecution specializes MemoState;
+    state def RosActionAccepted specializes RosActionExecution;
+    state def RosActionExecuting specializes RosActionExecution;
+    state def RosActionCanceling specializes RosActionExecution;
+    state def RosActionSucceeded specializes RosActionExecution;
+    state def RosActionCanceled specializes RosActionExecution;
+    state def RosActionAborted specializes RosActionExecution;
+
+    // ── Deployment ──────────────────────────────────────────────────────
+    //
+    // Nothing below declares a relation. The base's three deployment
+    // relations already say everything a ROS deployment needs:
+    //   BuildsInto          SoftwareModule -> RosContainerImage
+    //   DeploysTo           RosContainerImage -> ProcessingNode
+    //   ProvidesEnvironment ProcessingNode -> RosContainerRuntime
+    // That is the proof the base is factored correctly.
+    part def RosContainerImage specializes ContainerImage {
+        // humble, iron, jazzy, rolling.
+        attribute rosDistribution : String;
+        // The workspace overlay the image was built from.
+        attribute workspaceOverlay : String;
+    }
+
+    part def RosContainerRuntime specializes ContainerRuntime {
+        attribute rosDistribution : String;
+        // The RMW implementation below ROS 2 — rmw_fastrtps_cpp,
+        // rmw_cyclonedds_cpp. QoS is enforced here, so it is part of any
+        // argument that a QoS profile is actually honoured.
+        attribute rmwImplementation : String;
+        // ROS_DOMAIN_ID. Two robots sharing a domain see each other's topics,
+        // which is a hazard on a shared network and not visible in any node.
+        attribute rosDomainId : Integer;
+    }
+}

package/extensions/template/src/extension.sysml

@@ -0,0 +1,37 @@
+// Skeleton for a new MEMO extension. Copy the directory, rename the packages,
+// and replace the prefix.
+//
+// Two conventions this file follows and every extension must (extensions/README.md):
+//
+//   1. Every definition an extension declares is prefixed with the PascalCase
+//      form of the extension's directory name — `template/` gives `Template`.
+//      Extension names share one flat namespace with the base and with each
+//      other, so the prefix is what keeps two independent extensions from both
+//      declaring `Node`.
+//   2. A relation an extension declares specializes a base relation. It never
+//      roots independently.
+//
+// This package used to bind `baseMethodName = "MedicalDeviceLightDefault"` — a
+// pre-flip spelling that resolves to nothing. It went unnoticed for as long as
+// extensions lived under `examples/`, where the build did not check them; the
+// build checks `extensions/` now, and reported it on the first run.
+package memo_extension_template {
+    private import ScalarValues::*;
+    private import memo_core_enumerations::*;
+    private import memo_methodology_core::*;
+    private import memo_methodology_profiles::*;
+
+    part extensionMethod : MethodologyDefinition {
+        attribute :>> id = "EXT-METH-001";
+        attribute :>> name = "ExtensionMethod";
+        attribute :>> version = "0.1.0";
+        attribute :>> domain = "project extension";
+        attribute :>> description = "Adds a project or domain package to the selected MEMO methodology.";
+        // The base is a typed SysML reference, not a name held in sync by hand.
+        ref :>> baseMethodology = mdDefaultDefinition;
+        // An extension adds its own module to whatever its base selected;
+        // saying so explicitly is required now that an empty list means empty.
+        attribute :>> scopeMode = ScopeModeKind::explicit;
+        attribute :>> includedModule = "replace_with_extension_package";
+    }
+}

package/memo.manifest.yaml

@@ -19,5 +19,16 @@ examples:
   standard-sysml-diagrams: ./examples/sysml-diagram-samples
   ui-screen-regions: ./examples/ui-screen-regions
   nested-architecture-dsm: ./examples/nested-architecture-dsm
-  extension-template: ./examples/extensions/template
-  clinical-extension: ./examples/extensions/clinical
+  ros-mobile-robot: ./examples/ros-mobile-robot
+# Extensions are a way to MODEL, not a thing to copy. They are reusable
+# ontology packages that specialize the base, selected by a methodology or a
+# project binding — so they sit beside the ontology, not under examples/.
+# `examples/ros-mobile-robot` demonstrates using one; it is not the extension.
+extensions:
+  template: ./extensions/template
+  clinical: ./extensions/clinical
+  aadl: ./extensions/aadl
+  cloud: ./extensions/cloud
+  container: ./extensions/container
+  messaging: ./extensions/messaging
+  ros: ./extensions/ros

package/methodologies/default/memo.package.yaml

@@ -7,7 +7,7 @@
 # (`type`, `extends`, `usage`, `ontologies`, `methodology`, `modules`) were
 # removed at the native semantic flip and are now rejected if present.
 name: '@memoarchitect/methodology-default'
-version: 0.7.0
+version: 0.8.24
 description: "MEMO default medical-device methodology \u2014 selects viewpoints/views/DHF documents from @memoarchitect/ontology and adds rules, gates, patterns, profiles, and workflow."
 license: MIT
 tags:

package/methodologies/gpca/memo.package.yaml

@@ -7,7 +7,7 @@
 # (`type`, `extends`, `usage`, `ontologies`, `methodology`, `modules`) were
 # removed at the native semantic flip and are now rejected if present.
 name: '@memoarchitect/methodology-gpca'
-version: 0.7.0
+version: 0.8.24
 description: "GPCA infusion pump methodology \u2014 subtraction-based tailoring of @memoarchitect/methodology-default for the non-networked prototype variant. Excludes cybersecurity and SOUP."
 license: MIT
 tags:

package/ontology/memo.package.yaml

@@ -7,7 +7,7 @@
 # (`type`, `extends`, `usage`, `ontologies`, `methodology`, `modules`) were
 # removed at the native semantic flip and are now rejected if present.
 name: '@memoarchitect/ontology'
-version: 0.7.0
+version: 0.8.24
 description: "MEMO \u2014 the single canonical medical-device ontology: core semantics, the Arcadia-inspired architecture layers (context, requirements, behavior, structure, interfaces, risk, cybersecurity,\
   \ assurance, \u2026), compliance, viewpoints, views, and invariant rules. One namespace (memo::), one src/ tree."
 license: MIT

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@memoarchitect/ontology",
-  "version": "0.7.0",
+  "version": "0.8.24",
   "packageManager": "pnpm@9.15.0",
   "description": "MEMO \u2014 Medical Engineering Modelling Ontology. Pure SysML v2 medical-device ontology with native constraints, portable to any conformant SysML v2 tool (SysIDE, SysON, sysand).",
   "scripts": {
     "build": "bash scripts/build-kpar.sh",
-    "check": "bash scripts/build-kpar.sh",
+    "check": "bash scripts/build-kpar.sh && npm run lint",
+    "lint": "node ../memo-tools/packages/tools/lib/bin/memo.js dhf lint",
     "test": "node --test test/package.test.mjs",
     "docs:api": "node scripts/generate-sysml-api.mjs",
     "docs:diagrams": "node scripts/generate-reference-diagrams.mjs",
@@ -69,6 +70,7 @@
     "src/viewpoints/",
     "src/memo_namespaces.sysml",
     "templates/",
-    "examples/"
+    "examples/",
+    "extensions/"
   ]
 }

package/profile/memo.package.yaml

@@ -7,7 +7,7 @@
 # (`type`, `extends`, `usage`, `ontologies`, `methodology`, `modules`) were
 # removed at the native semantic flip and are now rejected if present.
 name: '@memoarchitect/medical-modeling-profile'
-version: 0.7.0
+version: 0.8.24
 description: Closure rules and viewpoints for medical device modeling
 license: MIT
 tags:

package/src/architecture/decisions/memo_decisions.sysml

@@ -1,4 +1,5 @@
 package memo_architecture_decisions {
+    private import Metaobjects::SemanticMetadata;
     private import ScalarValues::*;
 
     private import memo_core_common::*;
@@ -13,7 +14,27 @@ package memo_architecture_decisions {
     }
 
     connection def DecisionRecordedInADR :> MemoRelationship {
-        end decision : DesignDecision;
-        end adr : ADRArtifact;
+        end decision : DesignDecision :>> source;
+        end adr : ADRArtifact :>> target;
+    }
+    abstract connection decisionRecordedInADRLinks : DecisionRecordedInADR[*];
+    metadata def <decisionRecordedInADR> DecisionRecordedInADRMetadata :> SemanticMetadata {
+        :> annotatedElement : SysML::ConnectionDefinition;
+        :> annotatedElement : SysML::ConnectionUsage;
+        :>> baseType = decisionRecordedInADRLinks meta SysML::Usage;
+    }
+
+    // ── Relations owned by this package ─────────────────────────────
+    // Moved out of memo_core_relationships: their ends are typed against
+    // types declared here, and core must not depend on a domain package.
+    connection def Decides :> MemoRelationship {
+        end decision : DesignDecision :>> source;
+        end affectedElement : MemoPart :>> target;
+    }
+    abstract connection decidesLinks : Decides[*];
+    metadata def <decides> DecidesMetadata :> SemanticMetadata {
+        :> annotatedElement : SysML::ConnectionDefinition;
+        :> annotatedElement : SysML::ConnectionUsage;
+        :>> baseType = decidesLinks meta SysML::Usage;
     }
 }

package/src/architecture/functional/behavior/memo_behavior.sysml

@@ -3,29 +3,50 @@ package memo_architecture_functional_behavior {
 
     private import memo_core_common::*;
     private import memo_core_enumerations::*;
+
+    // Typed functional execution step. Project-specific action definitions
+    // specialize this rather than bypassing MemoAction; ActivityFlow remains
+    // the composite route that sequences such steps.
+    abstract action def FunctionalAction specializes MemoAction;
     // State machines and their mode states are SysML v2 states (behaviours), so
     // they derive from the MemoState foundation, not the part-based
-    // ArchitectureElement. Transitions stay part-based (below) to keep their
+    // MemoPart family. Transitions stay part-based (below) to keep their
     // traceable safety attributes.
-    // State-machine vocabulary. ModeState denotes a state owned by this model.
+    // State machines retain their own execution semantics; individual modes
+    // are MemoState usages selected by stateKind.
     state def StateMachine :> MemoState {
         attribute machineKind : String;
         attribute executionSemantics : String;
     }
-    state def ModeState :> MemoState {
-        attribute modeKind : String;
-        attribute entryCondition : String;
-        attribute exitCondition : String;
+    // A configuration is the concrete selection made at a `variation` choice
+    // point. It remains separate from a mode state: it says which mode and
+    // elements are active in one selectable arrangement.
+    // The reference is typed to the shared native state family so a consumer
+    // can navigate from the selected configuration to its governing mode.
+    part def ModeConfiguration specializes MemoPart {
+        ref activeMode : MemoState[1];
+        ref activeElement : MemoPart[0..*];
     }
-    part def Transition specializes ArchitectureElement {
+    // Transitions are native SysML v2 `transition` usages inside the owning
+    // state — there is no `part def Transition`, and its `transition` keyword
+    // collision is why. A transition usage's definition is always implicit, so
+    // it has no MEMO supertype to carry the identification core; this record
+    // carries it instead, applied with `@TransitionRecord`.
+    //
+    // `trigger`, `guardSummary`, and `effectSummary` are prose summaries, not
+    // executable semantics: a guard reading "none in source (MEMO extension
+    // REQ-X-02 additionally gates therapy on POST)" is a citation. Formal
+    // triggers and guards belong in native `accept` and `if`; these stay
+    // records so the two are not confused.
+    metadata def TransitionRecord {
+        attribute id : String;
+        attribute name : String;
         attribute trigger : String;
         attribute guardSummary : String;
         attribute effectSummary : String;
-        attribute priority : Integer;
-        attribute sameStepCritical : Boolean;
-        attribute sourceState : String;
-        attribute targetState : String;
+        attribute sourceReference : String;
     }
+
     // A verifiable behavioural constraint, such as an invariant, transition
     // rule, temporal claim, assumption, or guarantee.
     part def BehaviorProperty specializes VerifiableElement {
@@ -34,8 +55,22 @@ package memo_architecture_functional_behavior {
         attribute formalExpression : String;
     }
     part def Contract specializes VerifiableElement { attribute contractScope : String; }
-    part def PropertySet specializes VerifiableElement { attribute propertySetScope : String; }
-    part def ActivityAction specializes ArchitectureElement {
+    // `part def PropertySet specializes VerifiableElement { attribute
+    // propertySetScope : String; }` stood here and is DELETED (plan C3,
+    // open question §14.6). It was AADL's property-set idea imported as a
+    // name: one String field, no typed content, no binding to whatever it
+    // annotated, and zero usages anywhere in the tree.
+    //
+    // Per-technology properties belong on the extension type that owns them,
+    // typed. ROS QoS was the first real customer and settled it:
+    // `attribute def RosQosProfile` has reliability, durability, deadline,
+    // liveliness and history depth as typed fields, so a publisher's offer and
+    // a subscriber's request can be compared. A `propertySetScope` String
+    // could not have expressed one of them. Where an extension needs to
+    // annotate a BASE element rather than declare its own type, the SysML-
+    // native answer is `metadata def` + `Metaobjects::SemanticMetadata`, which
+    // is what every MEMO relation already carries since A4.
+    part def ActivityAction specializes MemoPart {
         attribute actionKind : ActionKind;
         attribute inputSummary : String;
         attribute outputSummary : String;
@@ -47,20 +82,13 @@ package memo_architecture_functional_behavior {
         attribute guardCondition : String;
         attribute weight : String;
     }
-    // UIScenario now lives in memo_architecture_implementation_ui (:> MemoScenario).
-    part def InteractionMessage specializes MemoPart {
-        attribute messageKind : MessageKind;
-        attribute sequenceOrder : Integer;
-        attribute senderComponent : String;
-        attribute receiverComponent : String;
-        attribute exchangeItem : String;
-        attribute timingConstraintMs : String;
-    }
+    // UI scenarios are OperativeScenario usages with scenarioKind `ui`.
+
     part def TimingConstraint specializes VerifiableElement {
         attribute constraintKind : TimingConstraintKind;
         attribute minMs : String;
         attribute maxMs : String;
-        attribute referenceElement : String;
+        ref referenceElement : MemoPart[1];
         attribute verificationMethod : VerificationMethodKind;
     }
 }

package/src/architecture/functional/constraints/memo_constraints.sysml

@@ -1,13 +1,14 @@
 package memo_architecture_functional_constraints {
     private import ScalarValues::*;
+    private import memo_core_common::*;
 
     doc /* Reusable quantitative constraint definitions. */
 
-    constraint def MaxResponseTimeConstraint {
+    constraint def MaxResponseTimeConstraint :> MemoConstraint {
         attribute responseTimeMs : Real;
         attribute maxAllowedMs : Real;
     }
-    constraint def LockoutIntervalConstraint {
+    constraint def LockoutIntervalConstraint :> MemoConstraint {
         attribute elapsedMs : Real;
         attribute lockoutMs : Real;
     }