Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Standard Library

Generated from the sysml-rs language pack — see the Language Reference index for provenance, licensing, and the raw JSON. 33 cards.

Boolean Evaluation

KerML — kerml.library.boolean-evaluation

The Kernel Semantic Library predicate that is the most general class of Boolean-valued evaluations (a specialization of Evaluation). It is the base that the Systems Library ConstraintCheck specializes.

Normative clauses: KerML §9.2.6

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Constraint Check

FlowTransfer

KerML — kerml.library.flow-transfer

The concrete Transfer that names the source output feature and the target input feature the payload flows between — what an ordinary structural flow connection lowers to. Carries move/push semantics.

Normative clauses: KerML §9.2.7

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Transfer, MessageTransfer

HappensBefore

KerML — kerml.library.happens-before

The Kernel association asserting that one occurrence completely finishes before another begins, with no overlap in time — the semantic backbone of succession (then) ordering.

Normative clauses: KerML §9.2.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Occurrence, HappensDuring

HappensDuring

KerML — kerml.library.happens-during

The Kernel association asserting that one occurrence’s whole time interval falls inside another’s — used for containment timing, e.g. a substate being active during its enclosing state.

Normative clauses: KerML §9.2.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Occurrence, HappensBefore

head (Sequence Function)

KerML — kerml.library.head

The Kernel sequence function returning the first element of an ordered collection (equivalent to indexing position 1), or nothing when it is empty.

Normative clauses: KerML §9.4.14

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: tail (Sequence Function), last (Sequence Function)

includes (Sequence Function)

KerML — kerml.library.includes

The Kernel sequence predicate that is true when every element of one collection is also present in another — a membership/containment test.

Normative clauses: KerML §9.4.14

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: size (Sequence Function)

isEmpty (Sequence Function)

KerML — kerml.library.is-empty

The Kernel sequence predicate that is true exactly when a collection contains no elements. Complementary to notEmpty.

Normative clauses: KerML §9.4.14

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: notEmpty (Sequence Function), size (Sequence Function)

last (Sequence Function)

KerML — kerml.library.last

The Kernel sequence function returning the final element of an ordered collection, or nothing when it is empty.

Normative clauses: KerML §9.4.14

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: head (Sequence Function)

MessageTransfer

KerML — kerml.library.message-transfer

The Transfer variant that carries a payload with no named source-output or target-input feature — the transfer underlying send/accept action semantics. It is disjoint from FlowTransfer.

Normative clauses: KerML §9.2.7

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Transfer, FlowTransfer

notEmpty (Sequence Function)

KerML — kerml.library.not-empty

The Kernel sequence predicate that is true when a collection holds at least one element — the negation of isEmpty.

Normative clauses: KerML §9.4.14

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: isEmpty (Sequence Function)

Occurrence

KerML — kerml.library.occurrence

The Kernel root classifier for anything with identity that exists or happens across time and space. Actions, states, and individual parts ultimately specialize it; it anchors the timing (start/end snapshots) and transfer features every temporal element uses.

Normative clauses: KerML §9.2.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: HappensBefore, HappensDuring, Transfer

max (Scalar Function)

KerML — kerml.library.scalar-max

The Kernel scalar function returning whichever of its two ordered scalar operands is the greater. Invoked as max(a, b) in expressions.

Normative clauses: KerML §9.4.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: min (Scalar Function)

min (Scalar Function)

KerML — kerml.library.scalar-min

The Kernel scalar function returning whichever of its two ordered scalar operands is the lesser. Invoked as min(a, b) in expressions.

Normative clauses: KerML §9.4.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: max (Scalar Function)

size (Sequence Function)

KerML — kerml.library.size

The Kernel sequence function counting how many elements a collection holds, returning a Natural. col->size() is the idiomatic length query.

Normative clauses: KerML §9.4.14

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: includes (Sequence Function), isEmpty (Sequence Function)

State Performance

KerML — kerml.library.state-performance

The Kernel Semantic Library performance of being in a state (a specialization of DecisionPerformance) with entry/do/exit substeps. On entry, the transfer/event that triggered the entry is recorded on the state’s performance via its incomingTransitionTrigger feature.

Normative clauses: KerML §9.2.11

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: State Action (Library Definition)

tail (Sequence Function)

KerML — kerml.library.tail

The Kernel sequence function returning every element of an ordered collection except the first — the complement of head, used for recursive traversal.

Normative clauses: KerML §9.4.14

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: head (Sequence Function)

Transfer

KerML — kerml.library.transfer

The Kernel interaction that moves a payload from a source occurrence to a target occurrence. It is the abstract base every flow and message transfer specializes; a transfer may be instantaneous or take time.

Normative clauses: KerML §9.2.7

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: FlowTransfer, MessageTransfer, Occurrence

Analysis Case (Library Definition)

SysML — sysml.library.analysis-case

The abstract library base of all analysis cases (a specialization of Case). It carries out an evaluation over its subject, producing a result rather than a pass/fail verdict.

Normative clauses: SysML §7.23

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Case (Library Definition), Analysis Case

Calculation (Library Definition)

SysML — sysml.library.calculation

The abstract library base of all calculations (a specialization of Action and the Kernel Evaluation). A CalculationUsage evaluates an expression over its parameters and returns a result; when an argument is omitted, the declared parameter’s default value (a KerML FeatureValue) is used.

Normative clauses: SysML §7.19

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Feature Value

Case (Library Definition)

SysML — sysml.library.case

The abstract library base of all cases (a specialization of Calculation). A Case has a subject under investigation, actor parts, an objective expressed as a RequirementCheck, and a result that should satisfy that objective.

Normative clauses: SysML §7.22

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Requirement Check, Analysis Case (Library Definition), Verification Case (Library Definition)

Constraint Check

SysML — sysml.library.constraint-check

The abstract library base of all constraint definitions (a specialization of the Kernel BooleanEvaluation predicate). A ConstraintCheck evaluates to a Boolean; asserted and negated constraint checks partition it into the true/false evaluation subsets.

Normative clauses: SysML §7.20

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Boolean Evaluation, Requirement Check, Constraint Definition

DurationValue (ISQ Base Quantity)

SysML — sysml.library.duration-value

The ISQ base quantity kind for duration/time (dimension T). A DurationValue is a scalar quantity measured in a DurationUnit such as second.

Normative clauses: SysML §9.8.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: second (SI Unit)

kilogram (SI Unit)

SysML — sysml.library.kilogram

The SI base unit of mass (short name kg), typing MassValue quantities. Defined by applying the kilo prefix to the gram.

Normative clauses: SysML §9.8.6

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: MassValue (ISQ Base Quantity)

LengthValue (ISQ Base Quantity)

SysML — sysml.library.length-value

The ISQ base quantity kind for length (dimension L). A LengthValue is a scalar quantity measured in a LengthUnit such as metre.

Normative clauses: SysML §9.8.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: metre (SI Unit)

MassValue (ISQ Base Quantity)

SysML — sysml.library.mass-value

The ISQ base quantity kind for mass (dimension M). A MassValue is a scalar quantity measured in a MassUnit such as kilogram.

Normative clauses: SysML §9.8.4

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: kilogram (SI Unit)

metre (SI Unit)

SysML — sysml.library.metre

The SI base unit of length (short name m), typing LengthValue quantities. Imported from the SI library and composed into derived units such as newton.

Normative clauses: SysML §9.8.6

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: LengthValue (ISQ Base Quantity)

Pass If

SysML — sysml.library.pass-if

The library calculation mapping a Boolean to a VerdictKind: it returns VerdictKind::pass when its isPassing argument is true, otherwise VerdictKind::fail.

Normative clauses: SysML §7.24

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Verdict Kind

Requirement Check

SysML — sysml.library.requirement-check

The abstract library base of all requirement definitions (a specialization of RequirementConstraintCheck). It checks whether its subject satisfies the required constraints, given that all assumptions hold: its result is allTrue(assumptions) implies allTrue(constraints).

Normative clauses: SysML §7.21

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Case (Library Definition), Constraint Check, Requirement Definition

second (SI Unit)

SysML — sysml.library.second

The SI base unit of time/duration (short name s), typing DurationValue quantities. The reference unit for rates and time-based dynamics.

Normative clauses: SysML §9.8.6

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: DurationValue (ISQ Base Quantity)

State Action (Library Definition)

SysML — sysml.library.state-action

The abstract library base of all state usages (a specialization of Action and the Kernel StatePerformance). Its mutually-exclusive substates are sequenced by stateSequencing successions: with N exclusive substates there are exactly N-1 such successions.

Normative clauses: SysML §7.18

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: State Performance

Verdict Kind

SysML — sysml.library.verdict-kind

The library enumeration of the possible results of a verification case: pass, fail, inconclusive, and error. A VerificationCase returns a VerdictKind as its result.

Normative clauses: SysML §7.24

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Verification Case (Library Definition), Pass If

Verification Case (Library Definition)

SysML — sysml.library.verification-case

The abstract library base of all verification cases (a specialization of Case). It returns a VerdictKind verdict and records the RequirementChecks of the requirements being verified in its objective.

Normative clauses: SysML §7.24

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Verification Case, Case (Library Definition), Verdict Kind, Verification Method Kind

Verification Method Kind

SysML — sysml.library.verification-method-kind

The library enumeration of the standard methods by which verification can be carried out: inspect, analyze, demo, and test. Used via the VerificationMethod metadata annotating a verification case or action.

Normative clauses: SysML §7.24

Support (sysml-rs): parse unknown · resolve unknown · elaborate unknown · execute unknown

Related: Verification Case (Library Definition)