syside.Model

class Model

A SysMLv2 model represented using abstract syntax.

result: syside.ExecutionResult = None

The model build result as returned by core module.

environment: syside.Environment = None

The environment this model was built in

documents: list[syside.SharedMutex[syside.Document]] = None

Documents as part of this model.

lib: syside.Stdlib = None

Standard library cache

index: syside.StaticIndex = None

Index of exported symbols

property all_docs: list[syside.SharedMutex[syside.Document]]

All built documents, including standard library.

property stdlib_docs: list[syside.SharedMutex[syside.Document]]

Environment documents as part of this model. Prefer accessing documents through ‘environment’ instead

property user_docs: list[syside.SharedMutex[syside.Document]]

User documents built as part of this model. Prefer ‘documents’ instead.

uris(considered_document_kinds: syside.DocumentKind = DocumentKind.MODEL) → Iterable[str]

Return URIs of documents.

Parameters:

considered_document_kinds – What document kinds to consider. By default returns only documents created for this model.

nodes(node_kind: type[syside.TElement], include_subtypes: bool = False, considered_document_kinds: syside.DocumentKind = DocumentKind.MODEL) → Iterable[syside.TElement]

Iterate over all nodes of the given kind.

Parameters:

  • node_kind – What kind of nodes to return.

  • include_subtypes – Whether to consider subtypes.

  • considered_document_kinds – What document kinds to consider. By default returns only documents created for this model.

elements(node_kind: type[syside.TElement], include_subtypes: bool = False, considered_document_kinds: syside.DocumentKind = DocumentKind.MODEL) → Iterable[syside.TElement]

An alias for nodes.

to_environment() → syside.Environment

Convert this model to Environment for building other dependent models.