Comment
- class Comment
Implementation of
Commentdefined in the KerML specification.Specification:
A
Commentis anAnnotatingElementwhosebodyin some way describes itsannotated_elements.For language description, see section 7.2.4.2 of the KerML specification. For more details on the model, see section 8.3.2.3.4 of the KerML specification.
Children
Members defined in
Comment(3 members)Members inherited from
AnnotatingElement(5 members)
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.
Members inherited from
AstNode(7 members) Attributes
- STD: tuple[type[syside.Comment], ...] = ()
- property body: str
Implementation of
bodydefined in the KerML specification.Specification:
The annotation text for the
Comment.See section 8.3.2.3.4 of the KerML specification for more details.
- property locale: str | None
Implementation of
localedefined in the KerML specification.Specification:
Identification of the language of the
bodytext and, optionally, the region and/or encoding. The format shall be a POSIX locale conformant to ISO/IEC 15897, with the format[language[_territory][.codeset][@modifier]].See section 8.3.2.3.4 of the KerML specification for more details.