Metadata

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

Comment

KerML — kerml.metadata.comment

A comment carries free-form explanatory text about model elements. Its body is a note; an optional about list names the elements it annotates, and an optional locale tags the natural language.

package P { comment About /* explains the package */ part def Widget; }

Normative clauses: KerML §8.3.2.3.4

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

Documentation

KerML — kerml.metadata.documentation

Documentation is comment text owned by the element it documents, giving that element a human-readable description. Its body is required; an optional locale tags the natural language.

package P { part def Widget { doc /* the primary component */ } }

Normative clauses: KerML §8.3.2.3.5

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

Textual Representation

KerML — kerml.metadata.textual-representation

A textual representation (rep <name> language "L" /* body */, or the unnamed language "L" /* body */) is an AnnotatingElement whose comment body represents its owning element in a named language. It lowers to a distinct TextualRepresentation carrying the language string and the body text; the grammar admits it inside constraint/requirement bodies.

package P { constraint c { rep r language "html" /* <b>hi</b> */ } }

Normative clauses: KerML §8.3.2.3.6

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

Metadata Definition

SysML — sysml.metadata.metadata-definition

A metadata definition defines a kind of annotation that carries structured data about model elements — semantic tags a tool or process can read. Usages of it attach that data to the elements they annotate.

package P { metadata def Priority; }

Normative clauses: SysML §8.3.27.2

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

Metadata Usage

SysML — sysml.metadata.metadata-usage

A metadata usage attaches an instance of a metadata definition to one or more model elements. The prefix form @Name annotates the element it precedes with metadata of that kind.

package P { metadata def Priority; part def Widget { @Priority; } }

Normative clauses: SysML §8.3.27.3

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