AnnotatingElement SysML
- class AnnotatingElement
Implementation of
AnnotatingElementdefined in the KerML specification.Specification:
An
AnnotatingElementis anElementthat provides additional description of or metadata on some otherElement. AnAnnotatingElementis either attached to itsannotated_elementsbyAnnotationRelationships, or it implicitly annotates itsowning_namespace.For language description, see section 7.2.4 of the KerML specification. For more details on the model, see section 8.3.2.3.2 of the KerML specification.
Inheritance:
Children
Members defined in
AnnotatingElement(6 members)
RAll subtypes of
AnnotatingElementaccording to the specification.
RContainer for owned annotations.
RSysMLImplementation of
annotated_elementdefined in the KerML specification.
RSysMLImplementation of
annotationdefined in the KerML specification.
RSysMLImplementation of
owned_annotating_relationshipdefined in the KerML specification.
RSysMLImplementation of
owning_annotating_relationshipdefined in the KerML specification.Members inherited from
Element(25 members)
RSysMLImplementation of
alias_idsdefined in the KerML specification.
RThe owned
Commentsrelated byowned_relationships.
RWSysMLImplementation of
declared_namedefined in the KerML specification.
RWSysMLImplementation of
declared_short_namedefined in the KerML specification.
RSysMLImplementation of
documentationdefined in the KerML specification.
RWSysMLImplementation of
element_iddefined in the KerML specification.
RSysMLImplementation of
is_implied_includeddefined in the KerML specification.
RSysMLImplementation of
is_library_elementdefined in the KerML specification.
RThe owned metadata related by
owned_relationships.
RSysMLImplementation of
namedefined in the KerML specification.
RSysMLImplementation of
owned_annotationdefined in the KerML specification.
RSysMLImplementation of
owned_elementdefined in the KerML specification.
RSysMLImplementation of
owned_relationshipdefined in the KerML specification.
RSysMLImplementation of
ownerdefined in the KerML specification.
RSysMLImplementation of
owning_membershipdefined in the KerML specification.
RSysMLImplementation of
owning_namespacedefined in the KerML specification.
RSysMLImplementation of
owning_relationshipdefined in the KerML specification.
RReturn a unique description of the location of this
Elementin the containment structure rooted in a rootNamespace. In most cases the segments will be identical toQualifiedName.
RSysMLImplementation of
qualified_namedefined in the KerML specification.
RThe owner of this
Elementas the parent ofowning_membershiporowning_relationshipotherwise.
RWThe 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.
RSysMLImplementation of
short_namedefined in the KerML specification.
RSysMLImplementation of
textual_representationdefined in the KerML specification.
Check if the qualified name of this
Elementmatches the provided segments of a qualified name.Members inherited from
AstNode(7 members)
RThe source CST node of
selfif one exists.
RThe
documentthat owns this node.
RThe parent node of
self.
Identity based hash of this node.
cast(self, *type: type[TNode]) -> TNode
Chainable equivalent to
isintance(self, type)
Checked cast to
type. Attributes
- STD: tuple[Union[type[syside.AnnotatingElement], type[MetadataFeature], type[MetadataUsage]], ...] = Ellipsis
All subtypes of
AnnotatingElementaccording 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
AnnotatingElement.Std.When working with standard metamodel types, use:
if isinstance(element, AnnotatingElement.STD): ...
For type hints, instead use
AnnotatingElement.Std:Note that
AnnotatingElement.Stdis only defined duringTYPE_CHECKING, depending on the Python version used eitherfrom __future__ import annotationsordef function(...) -> "AnnotatingElement.Std"may be required to ensure that annotations are resolved lazily without an actual object present.
- property about: syside.Annotations
Container for owned annotations.
- property annotated_elements: syside.ContainerView[syside.Element]
Implementation of
annotated_elementdefined in the KerML specification.Specification:
The
Elementsthat are annotated by thisAnnotatingElement. Ifannotationis not empty, these are theannotated_elementsof theannotations. Ifannotationis empty, then it is theowning_namespaceof theAnnotatingElement.See section 8.3.2.3.2 of the KerML specification for more details.
- property annotations: syside.ContainerView[syside.Annotation]
Implementation of
annotationdefined in the KerML specification.Specification:
The
Annotationsthat relate thisAnnotatingElementto itsannotated_elements. This includes theowning_annotating_relationship(if any) followed by all theowned_annotating_relationships.See section 8.3.2.3.2 of the KerML specification for more details.
- property owned_annotating_relationships: syside.ContainerView[syside.Annotation]
Implementation of
owned_annotating_relationshipdefined in the KerML specification.Specification:
The
owned_relationshipsof thisAnnotatingElementthat areAnnotations, for which thisAnnotatingElementis theannotating_element.See section 8.3.2.3.2 of the KerML specification for more details.
- property owning_annotating_relationship: syside.Annotation | None
Implementation of
owning_annotating_relationshipdefined in the KerML specification.Specification:
The
owning_relationshipof thisAnnotatingRelationship, if it is anAnnotationSee section 8.3.2.3.2 of the KerML specification for more details.