VariantMembership

VariantMembership is defined in SysML specification on page 311. Excerpt from the machine readable specification:

A VariantMembership is a Membership between a variation point Definition or Usage and a Usage that represents a variant in the context of that variation. The membershipOwningNamespace for the VariantMembership must be either a Definition or a Usage with isVariation = true.

The following diagram shows the inheritance hierarchy of VariantMembership according to the specification:

// Class: VariantMembership digraph { VariantMembership [label="VariantMembership (SysML)" shape=plaintext] OwningMembership -> VariantMembership OwningMembership [label="OwningMembership (KerML)" shape=plaintext] Membership -> OwningMembership Membership [label="Membership (KerML)" shape=plaintext] Relationship -> Membership Relationship [label="Relationship (KerML)" shape=plaintext] Element -> Relationship Element [label="Element (KerML)" shape=plaintext] }

The following table shows all attributes defined for VariantMembership according to the specification together with the documentation from the machine readable specification. Note that in SysIDE API, we use snake case for attribute names instead of Pascal case used in the specification.

Attribute	Documentation from machine readable specification
Attributes defined in VariantMembership:
owned_variant_usage	The Usage that represents a variant in the context of the owningVariationDefinition or owningVariationUsage.
Attributes defined in OwningMembership:
owned_member_element_id	The elementId of the ownedMemberElement.
owned_member_short_name	The shortName of the ownedMemberElement.
owned_member_name	The name of the ownedMemberElement.
owned_member_element	The Element that becomes an ownedMember of the membershipOwningNamespace due to this OwningMembership.
Attributes defined in Membership:
member_element_id	The elementId of the memberElement.
member_short_name	The short name of the memberElement relative to the membershipOwningNamespace.
member_name	The name of the memberElement relative to the membershipOwningNamespace.
visibility	Whether or not the Membership of the memberElement in the membershipOwningNamespace is publicly visible outside that Namespace.
membership_owning_namespace	The Namespace of which the memberElement becomes a member due to this Membership.
member_element	The Element that becomes a member of the membershipOwningNamespace due to this Membership.
Attributes defined in Relationship:
is_implied	Whether this Relationship was generated by tooling to meet semantic rules, rather than being directly created by a modeler.
related_elements	The Elements that are related by this Relationship, derived as the union of the source and target Elements of the Relationship.
targets	The relatedElements to which this Relationship is considered to be directed.
sources	The relatedElements from which this Relationship is considered to be directed.
owning_related_element	The relatedElement of this Relationship that owns the Relationship, if any.
owned_related_elements	The relatedElements of this Relationship that are owned by the Relationship.
Attributes defined in Element:
element_id	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.
declared_short_name	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.
declared_name	The declared name of this Element.
short_name	The short name to be used for this Element during name resolution within its owningNamespace. This is derived using the effectiveShortName() operation. By default, it is the same as the declaredShortName, but this is overridden for certain kinds of Elements to compute a shortName even when the declaredName is null.
name	The name to be used for this Element during name resolution within its owningNamespace. This is derived using the effectiveName() operation. By default, it is the same as the declaredName, but this is overridden for certain kinds of Elements to compute a name even when the declaredName is null.
qualified_name	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 qualifiedName is null if this Element has no owningNamespace or if there is not a complete ownership chain of named Namespaces from a root Namespace to this Element.
is_implied_included	Whether all necessary implied Relationships have been included in the ownedRelationships of this Element. This property may be true, even if there are not actually any ownedRelationships with isImplied = true, meaning that no such Relationships are actually implied for this Element. However, if it is false, then ownedRelationships may not contain any implied Relationships. That is, either all required implied Relationships must be included, or none of them.
is_library_element	Whether this Element is contained in the ownership tree of a library model.
owning_membership	The owningRelationship of this Element, if that Relationship is a Membership.
owned_relationships	The Relationships for which this Element is the owningRelatedElement.
owning_relationship	The Relationship for which this Element is an ownedRelatedElement, if any.
owning_namespace	The Namespace that owns this Element, which is the membershipOwningNamespace of the owningMembership of this Element, if any.
owner	The owner of this Element, derived as the owningRelatedElement of the owningRelationship of this Element, if any.
owned_elements	The Elements owned by this Element, derived as the ownedRelatedElements of the ownedRelationships of this Element.
documentation	The Documentation owned by this Element.
owned_annotations	The ownedRelationships of this Element that are Annotations, for which this Element is the annotatedElement.
textual_representations	The TextualRepresentations that annotate this Element.

The following table lists SysIDE specific attributes available for class VariantMembership:

Python Attribute

STD

class VariantMembership

__cpp_name__: str = 'syside::sysml::VariantMembership'

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

property owned_variant_usage: syside.Usage | None

property owned_member_element_id: uuid.UUID

property owned_member_short_name: str | None

property owned_member_name: str | None

property owned_member_element: syside.Element | None

property is_initial_node: bool

property owning_related_element: syside.Element | None

property sources: syside.ContainerView[syside.Element]

property targets: syside.ContainerView[syside.Element]

property member_element_id: uuid.UUID

property member_short_name: str | None

property member_name: str | None

property membership_owning_namespace: syside.Namespace | None

property member_element: syside.Element | None

property children: syside.RelationshipBody