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.

Members inherited from Element (23 members)

	`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`

 Attributes

STD: tuple[type[syside.Membership], ...] = ()

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: The Element that becomes a member of the membership_owning_namespace due to this Membership.

property member_element_id: uuid.UUID: The element_id of the member_element.

property member_name: str | None: The name of the member_element relative to the membership_owning_namespace.

property member_short_name: str | None: The short name of the member_element relative to the membership_owning_namespace.

property membership_owning_namespace: syside.Namespace | None: The Namespace of which the member_element becomes a member due to this Membership.

property owning_related_element: syside.Element | None: The related_element of this Relationship that owns the Relationship, if any.

property sources: syside.ContainerView[syside.Element]: The related_elements from which this Relationship is considered to be directed.

property targets: syside.ContainerView[syside.Element]: The related_elements to which this Relationship is considered to be directed.

Membership SysML

Feedback

Legal

Company

	`STD`	`R`
	`children`	`R`	The elements enclosed by curly brackets in textual syntax.
	`is_initial_node`	`RW`	Returns `True` if this `Membership` was parsed from `InitialNode` syntax rule.
	`member_element`	`R`	The `Element` that becomes a `member` of the `membership_owning_namespace` due to this `Membership`.
	`member_element_id`	`R`	The `element_id` of the `member_element`.
	`member_name`	`R`	The name of the `member_element` relative to the `membership_owning_namespace`.
	`member_short_name`	`R`	The short name of the `member_element` relative to the `membership_owning_namespace`.
	`membership_owning_namespace`	`R`	The `Namespace` of which the `member_element` becomes a `member` due to this `Membership`.
	`owning_related_element`	`R`	The related_element of this Relationship that owns the Relationship, if any.
	`sources`	`R`	The `related_elements from which this Relationship is considered to be directed.`
	`targets`	`R`	The `related_elements` to which this Relationship is considered to be directed.

	`first_source`	`R`	Convenience method for sources[0].
	`first_target`	`R`	Convenience method for targets[0].
	`is_implied`	`RW`	Whether this Relationship was generated by tooling to meet semantic rules, rather than being directly created by a modeler.
	`is_visibility_implied`	`R`	Returns `True` if this `Relationship` is using implicit visibility.
	`owned_related_elements`	`R`	The related_elements of this Relationship that are owned by the Relationship.
	`related_elements`	`R`	The Elements that are related by this Relationship, derived as the union of the `source` and `target` Elements of the Relationship.
	`visibility`	`RW`	The visibility level of the related elements from this `Relationship` relative to the `owning_related_element`.
	`reset_visibility`
	`try_set_visibility`

	`cst_node`	`R`
	`document`	`R`
	`parent`	`R`
	`__hash__`
	`cast`
	`isinstance`
	`try_cast`