Featuring SysML

class Featuring

Implementation of Featuring defined in the KerML specification.

Specification:

Featuring is a Relationship between a Type and a Feature that is featured by that Type. It asserts that every instance in the domain of the feature must be classified by the type.

Featuring is abstract and does not commit to which of feature or type are the source or target of the Relationship. This commitment is made in the subclasses of Featuring, TypeFeaturing and FeatureMembership, which have opposite directions.

For language description, see section 7.3.4.8 of the KerML specification. For more details on the model, see section 8.3.3.3.8 of the KerML specification.

Featuring Featuring syside.Featuring Relationship Relationship syside.Relationship Relationship->Featuring Element Element syside.Element Element->Relationship AstNode AstNode syside.AstNode AstNode->Element
Children
Members defined in Featuring (6 members)

STD

R

children

R

The elements enclosed by curly brackets in textual syntax.

feature

R

The Feature that is featured by the featuring_type.

feature_target

R

SysIDE specific accessor for manipulating the target of feature.

type

R

The Type that features the feature_of_type.

type_target

R

SysIDE specific accessor for manipulating the target of type.

Members inherited from Relationship (12 members)

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.

owning_related_element

R

The related_element of this Relationship that owns the Relationship, if any.

related_elements

R

The Elements that are related by this Relationship, derived as the union of the source and target Elements of the Relationship.

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.

visibility

RW

The visibility level of the related elements from this Relationship relative to the owning_related_element.

reset_visibility

try_set_visibility

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

Members inherited from AstNode (7 members)

cst_node

R

document

R

parent

R

__hash__

cast

isinstance

try_cast

Attributes

STD: tuple[Union[type[syside.Featuring], type[syside.FeatureMembership]], ...] = ()
property children: syside.RelationshipBody

The elements enclosed by curly brackets in textual syntax.

property feature: syside.Feature | None

The Feature that is featured by the featuring_type.

featuring
property feature_target: syside.FeatureReference

SysIDE specific accessor for manipulating the target of feature.

property type: syside.Type | None

The Type that features the feature_of_type.

featuring_of_type
property type_target: syside.TypeReference

SysIDE specific accessor for manipulating the target of type.

Used in