Annotation SysML

class Annotation

Implementation of Annotation defined in the KerML specification.

Specification:

An Annotation is a Relationship between an AnnotatingElement and the Element that is annotated by that AnnotatingElement.

For language description, see section 7.2.4 of the KerML specification. For more details on the model, see section 8.3.2.3.3 of the KerML specification.

Members defined in Annotation (9 members)

	STD	R
	annotated_element	R SysML	Implementation of annotated_element defined in the KerML specification.
	annotating_element	R SysML	Implementation of annotating_element defined in the KerML specification.
	owned_annotating_element	R SysML	Implementation of owned_annotating_element defined in the KerML specification.
	owning_annotated_element	R SysML	Implementation of owning_annotated_element defined in the KerML specification.
	owning_annotating_element	R SysML	Implementation of owning_annotating_element defined in the KerML specification.
	owning_related_element	R SysML	Implementation of owning_related_element defined in the KerML specification.
	sources	R SysML	Implementation of source defined in the KerML specification.
	targets	R SysML	Implementation of target defined in the KerML specification.

Members inherited from Relationship (9 members)

	first_source	R	Convenience method for sources[0].
	first_target	R	Convenience method for targets[0].
	is_implied	RW SysML	Implementation of is_implied defined in the KerML specification.
	is_visibility_implied	R	Returns True if this Relationship is using implicit visibility.
	owned_related_elements	R SysML	Implementation of owned_related_element defined in the KerML specification.
	related_elements	R SysML	Implementation of related_element defined in the KerML specification.
	visibility	RW	The visibility level of the related elements from this Relationship relative to the owning_related_element.
	reset_visibility		Reset visibility to its implicit value.
	try_set_visibility		Non-throwing alternative to visibility setter.

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.

Members inherited from AstNode (7 members)

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

 Attributes

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

property annotated_element: syside.Element | None

Implementation of annotated_element defined in the KerML specification.

Specification:

The Element that is annotated by the annotating_element of this Annotation.

See section 8.3.2.3.3 of the KerML specification for more details.

property annotating_element: syside.AnnotatingElement | syside.MetadataFeature | syside.MetadataUsage | None

Implementation of annotating_element defined in the KerML specification.

Specification:

The AnnotatingElement that annotates the annotated_element of this Annotation. This is always either the owned_annotating_element or the owning_annotating_element.

See section 8.3.2.3.3 of the KerML specification for more details.

property owned_annotating_element: syside.AnnotatingElement | syside.MetadataFeature | syside.MetadataUsage | None

Implementation of owned_annotating_element defined in the KerML specification.

Specification:

The annotating_element of this Annotation, when it is an owned_related_element.

See section 8.3.2.3.3 of the KerML specification for more details.

property owning_annotated_element: syside.Element | None

Implementation of owning_annotated_element defined in the KerML specification.

Specification:

The annotated_element of this Annotation, when it is also the owning_related_element.

See section 8.3.2.3.3 of the KerML specification for more details.

property owning_annotating_element: syside.AnnotatingElement | syside.MetadataFeature | syside.MetadataUsage | None

Implementation of owning_annotating_element defined in the KerML specification.

Specification:

The annotating_element of this Annotation, when it is the owning_related_element.

See section 8.3.2.3.3 of the KerML specification for more details.

property owning_related_element: syside.Element | None

Implementation of owning_related_element defined in the KerML specification.

Specification:

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

See section 8.3.2.1.3 of the KerML specification for more details.

property sources: syside.ContainerView[syside.Element]

Implementation of source defined in the KerML specification.

Specification:

The related_elements from which this Relationship is considered to be directed.

See section 8.3.2.1.3 of the KerML specification for more details.

property targets: syside.ContainerView[syside.Element]

Implementation of target defined in the KerML specification.

Specification:

The related_elements to which this Relationship is considered to be directed.

See section 8.3.2.1.3 of the KerML specification for more details.

 Used in

• syside.AnnotatingElement

  • annotations

  • owned_annotating_relationships

  • owning_annotating_relationship

• syside.Annotation

  • STD

• syside.Element

  • owned_annotations

• syside.MetadataFeature

  • annotations

  • owned_annotating_relationships

  • owning_annotating_relationship

• syside.MetadataUsage

  • annotations

  • owned_annotating_relationships

  • owning_annotating_relationship

• syside.RelationshipBody

  • append_annotation