Membership SysML

class Membership

Implementation of Membership defined in the KerML specification.

Specification:

A Membership is a Relationship between a Namespace and an Element that indicates the Element is a member of (i.e., is contained in) the Namespace. Any member_names specify how the member_element is identified in the Namespace and the visibility specifies whether or not the member_element is publicly visible from outside the Namespace.

If a Membership is an OwningMembership, then it owns its member_element, which becomes an owned_member of the membership_owning_namespace. Otherwise, the member_names of a Membership are effectively aliases within the membership_owning_namespace for an Element with a separate OwningMembership in the same or a different Namespace.

For language description, see section 7.2.5.1 of the KerML specification. For more details on the model, see section 8.3.2.4.3 of the KerML specification.

Inheritance:

Members inherited from Element (25 members)

`alias_ids`	`R` SysML	Implementation of `alias_ids` defined in the KerML specification.
`comments`	`R`	The owned `Comments` related by `owned_relationships`.
`declared_name`	`RW` SysML	Implementation of `declared_name` defined in the KerML specification.
`declared_short_name`	`RW` SysML	Implementation of `declared_short_name` defined in the KerML specification.
`documentation`	`R` SysML	Implementation of `documentation` defined in the KerML specification.
`element_id`	`RW` SysML	Implementation of `element_id` defined in the KerML specification.
`is_implied_included`	`R` SysML	Implementation of `is_implied_included` defined in the KerML specification.
`is_library_element`	`R` SysML	Implementation of `is_library_element` defined in the KerML specification.
`metadata`	`R`	The owned metadata related by `owned_relationships`.
`name`	`R` SysML	Implementation of `name` defined in the KerML specification.
`owned_annotations`	`R` SysML	Implementation of `owned_annotation` defined in the KerML specification.
`owned_elements`	`R` SysML	Implementation of `owned_element` defined in the KerML specification.
`owned_relationships`	`R` SysML	Implementation of `owned_relationship` defined in the KerML specification.
`owner`	`R` SysML	Implementation of `owner` defined in the KerML specification.
`owning_membership`	`R` SysML	Implementation of `owning_membership` defined in the KerML specification.
`owning_namespace`	`R` SysML	Implementation of `owning_namespace` defined in the KerML specification.
`owning_relationship`	`R` SysML	Implementation of `owning_relationship` defined in the KerML specification.
`path`	`R`	Return a unique description of the location of this `Element` in the containment structure rooted in a root `Namespace`. In most cases the segments will be identical to `QualifiedName`.
`qualified_name`	`R` SysML	Implementation of `qualified_name` defined in the KerML specification.
`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` SysML	Implementation of `short_name` defined in the KerML specification.
`textual_representations`	`R` SysML	Implementation of `textual_representation` defined in the KerML specification.
`__str__`
`matches_qualified_name`		Check if the qualified name of this `Element` matches the provided segments of a qualified name.

Attributes

STD: tuple[type[syside.Membership], ...] = Ellipsis

All subtypes of Membership according to the specification.

This is needed because the implementation does not use multiple inheritance like the standard metamodel. However, all would-be inherited attributes are implemented explicitly on classes in Membership.Std.

When working with standard metamodel types, use:

if isinstance(element, Membership.STD):
    ...

For type hints, instead use Membership.Std:

def function(element: Element) -> Membership.Std:
    ...

Note that Membership.Std is only defined during TYPE_CHECKING, depending on the Python version used either from __future__ import annotations or def function(...) -> "Membership.Std" may be required to ensure that annotations are resolved lazily without an actual object present.

property children: syside.RelationshipBody: The elements enclosed by curly brackets in textual syntax.

property is_initial_node: bool: Returns True if this Membership was parsed from InitialNode syntax rule.

property member_element: syside.Element | None

Implementation of member_element defined in the KerML specification.

Specification:

The Element that becomes a member of the membership_owning_namespace due to this Membership.