Element SysML

class Element

Implementation of Element defined in the KerML specification.

Specification:

An Element is a constituent of a model that is uniquely identified relative to all other Elements. It can have Relationships with other Elements. Some of these Relationships might imply ownership of other Elements, which means that if an Element is deleted from a model, then so are all the Elements that it owns.

For language description, see section 7.2.2 of the KerML specification. For more details on the model, see section 8.3.2.1.2 of the KerML specification.

Element Element syside.Element AstNode AstNode syside.AstNode AstNode->Element
Children
Members defined in Element (24 members)

STD

R

comments

R

The owned Comments related by owned_relationships.

declared_name

RW

The declared name of this Element.

declared_short_name

RW

An optional alternative name for the Element that is intended to be shorter or in some way more succinct than its primary name. It may act as a modeler-specified identifier for the Element, though it is then the responsibility of the modeler to maintain the uniqueness of this identifier within a model or relative to some other context.

documentation

R

The Documentation owned by this Element.

element_id

RW
The globally unique identifier for this Element. This is intended to be

set by tooling, and it must not change during the lifetime of the Element.

is_implied_included

R

Whether all necessary implied Relationships have been included in the owned_relationships of this Element. This property may be true, even if there are not actually any owned_relationships with is_implied = true, meaning that no such Relationships are actually implied for this Element. However, if it is false, then owned_relationships may not contain any implied Relationships. That is, either all required implied Relationships must be included, or none of them.

is_library_element

R

Whether this Element is contained in the ownership tree of a library model.

metadata

R

The owned metadata related by owned_relationships.

name

R

The name to be used for this Element during name resolution within its owning_namespace. This is derived using the effective_name() operation. By default, it is the same as the declared_name, but this is overridden for certain kinds of Elements to compute a name even when the declared_name is null.

owned_annotations

R

The owned_relationships of this Element that are Annotations, for which this Element is the annotated_element.

owned_elements

R

The Elements owned by this Element, derived as the owned_related_elements of the owned_relationships of this Element.

owned_relationships

R

The Relationships for which this Element is the owning_related_element.

owner

R

The owner of this Element, derived as the owning_related_element of the owning_relationship of this Element, if any.

owning_membership

R

The owning_relationship of this Element, if that Relationship is a Membership.

owning_namespace

R

The Namespace that owns this Element, which is the membership_owning_namespace of the owning_membership of this Element, if any.

owning_relationship

R

The Relationship for which this Element is an owned_related_element, if any.

qualified_name

R

The full ownership-qualified name of this Element, represented in a form that is valid according to the KerML textual concrete syntax for qualified names (including use of unrestricted name notation and escaped characters, as necessary). The qualified_name is null if this Element has no owning_namespace or if there is not a complete ownership chain of named Namespaces from a root Namespace to this Element.

scoped_owner

R

The owner of this Element as the parent of owning_membership or owning_relationship otherwise.

sema_state

RW

The state of semantic resolution for this Element. Based on this, sema may skip elements to avoid duplicate work, e.g. when resolving elements in a group of related documents.

short_name

R

The short name to be used for this Element during name resolution within its owning_namespace. This is derived using the effective_short_name() operation. By default, it is the same as the declared_short_name, but this is overridden for certain kinds of Elements to compute a short_name even when the declared_name is null.

textual_representations

R

The TextualRepresentations that annotate this Element.

__str__

matches_qualified_name
Members inherited from AstNode (7 members)

cst_node

R

document

R

parent

R

__hash__

cast

isinstance

try_cast

Attributes

STD: tuple[type[syside.Element], ...] = ()
property comments: syside.LazyIterator[syside.Comment]

The owned Comments related by owned_relationships.

property declared_name: str | None

The declared name of this Element.

property declared_short_name: str | None

An optional alternative name for the Element that is intended to be shorter or in some way more succinct than its primary name. It may act as a modeler-specified identifier for the Element, though it is then the responsibility of the modeler to maintain the uniqueness of this identifier within a model or relative to some other context.

property documentation: syside.LazyIterator[syside.Documentation]

The Documentation owned by this Element.

property element_id: uuid.UUID
The globally unique identifier for this Element. This is intended to be

set by tooling, and it must not change during the lifetime of the Element.

Note that element_id may be deprecated in a future release to improve performance as it has no use outside of serialization. In such cases, we may instead create and store element_ids only during serialization. Otherwise __hash__ is guaranteed to remain stable while the Element is alive, however it may be reused on Document rebuilds.

property is_implied_included: bool

Whether all necessary implied Relationships have been included in the owned_relationships of this Element. This property may be true, even if there are not actually any owned_relationships with is_implied = true, meaning that no such Relationships are actually implied for this Element. However, if it is false, then owned_relationships may not contain any implied Relationships. That is, either all required implied Relationships must be included, or none of them.

property is_library_element: bool

Whether this Element is contained in the ownership tree of a library model.

property metadata: syside.LazyIterator[syside.MetadataFeature | syside.MetadataUsage]

The owned metadata related by owned_relationships.

property name: str | None

The name to be used for this Element during name resolution within its owning_namespace. This is derived using the effective_name() operation. By default, it is the same as the declared_name, but this is overridden for certain kinds of Elements to compute a name even when the declared_name is null.

property owned_annotations: syside.LazyIterator[syside.Annotation]

The owned_relationships of this Element that are Annotations, for which this Element is the annotated_element.

property owned_elements: syside.LazyIterator[syside.Element]

The Elements owned by this Element, derived as the owned_related_elements of the owned_relationships of this Element.

property owned_relationships: syside.LazyIterator[syside.Relationship]

The Relationships for which this Element is the owning_related_element.

property owner: syside.Element | None

The owner of this Element, derived as the owning_related_element of the owning_relationship of this Element, if any.

property owning_membership: syside.OwningMembership | None

The owning_relationship of this Element, if that Relationship is a Membership.

property owning_namespace: syside.Namespace | None

The Namespace that owns this Element, which is the membership_owning_namespace of the owning_membership of this Element, if any.

property owning_relationship: syside.Relationship | None

The Relationship for which this Element is an owned_related_element, if any.

property qualified_name: syside.QualifiedName | None

The full ownership-qualified name of this Element, represented in a form that is valid according to the KerML textual concrete syntax for qualified names (including use of unrestricted name notation and escaped characters, as necessary). The qualified_name is null if this Element has no owning_namespace or if there is not a complete ownership chain of named Namespaces from a root Namespace to this Element.

property scoped_owner: syside.Element | None

The owner of this Element as the parent of owning_membership or owning_relationship otherwise.

property sema_state: syside.SemaState

The state of semantic resolution for this Element. Based on this, sema may skip elements to avoid duplicate work, e.g. when resolving elements in a group of related documents.

property short_name: str | None

The short name to be used for this Element during name resolution within its owning_namespace. This is derived using the effective_short_name() operation. By default, it is the same as the declared_short_name, but this is overridden for certain kinds of Elements to compute a short_name even when the declared_name is null.

property textual_representations: syside.LazyIterator[syside.TextualRepresentation]

The TextualRepresentations that annotate this Element.

Methods

__str__() → str
matches_qualified_name(arg: Sequence[str], /) → bool

Check if the qualified name of this Element matches the provided segments of a qualified name.

Used in