Implementation of Comment defined in the KerML specification.
Specification:
A Comment is an AnnotatingElement whose body in some way
describes its annotated_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.
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.
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.
All subtypes of Comment according 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 Comment.Std.
Note that Comment.Std is only defined during TYPE_CHECKING, depending
on the Python version used either from__future__importannotations or
deffunction(...)->"Comment.Std" may be required to ensure that annotations
are resolved lazily without an actual object present.
Implementation of locale defined in the KerML specification.
Specification:
Identification of the language of the body text 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.
Comment SysML
Implementation of
Commentdefined in the KerML specification.Specification:
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
DocumentationMembers defined in
Comment(3 members)
STDRAll subtypes of
Commentaccording to the specification.
bodyRWSysMLImplementation of
bodydefined in the KerML specification.
localeRWSysMLImplementation of
localedefined in the KerML specification.Members inherited from
AnnotatingElement(5 members)
aboutRContainer for owned annotations.
annotated_elementsRSysMLImplementation of
annotated_elementdefined in the KerML specification.
annotationsRSysMLImplementation of
annotationdefined in the KerML specification.
owned_annotating_relationshipsRSysMLImplementation of
owned_annotating_relationshipdefined in the KerML specification.
owning_annotating_relationshipRSysMLImplementation of
owning_annotating_relationshipdefined in the KerML specification.Members inherited from
Element(25 members)
alias_idsRSysMLImplementation of
alias_idsdefined in the KerML specification.
commentsRThe owned
Commentsrelated byowned_relationships.
declared_nameRWSysMLImplementation of
declared_namedefined in the KerML specification.
declared_short_nameRWSysMLImplementation of
declared_short_namedefined in the KerML specification.
documentationRSysMLImplementation of
documentationdefined in the KerML specification.
element_idRWSysMLImplementation of
element_iddefined in the KerML specification.
is_implied_includedRSysMLImplementation of
is_implied_includeddefined in the KerML specification.
is_library_elementRSysMLImplementation of
is_library_elementdefined in the KerML specification.
metadataRThe owned metadata related by
owned_relationships.
nameRSysMLImplementation of
namedefined in the KerML specification.
owned_annotationsRSysMLImplementation of
owned_annotationdefined in the KerML specification.
owned_elementsRSysMLImplementation of
owned_elementdefined in the KerML specification.
owned_relationshipsRSysMLImplementation of
owned_relationshipdefined in the KerML specification.
ownerRSysMLImplementation of
ownerdefined in the KerML specification.
owning_membershipRSysMLImplementation of
owning_membershipdefined in the KerML specification.
owning_namespaceRSysMLImplementation of
owning_namespacedefined in the KerML specification.
owning_relationshipRSysMLImplementation of
owning_relationshipdefined in the KerML specification.
pathRReturn 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.
qualified_nameRSysMLImplementation of
qualified_namedefined in the KerML specification.
scoped_ownerRThe owner of this
Elementas the parent ofowning_membershiporowning_relationshipotherwise.
sema_stateRWThe 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_nameRSysMLImplementation of
short_namedefined in the KerML specification.
textual_representationsRSysMLImplementation of
textual_representationdefined in the KerML specification.
__str__
matches_qualified_nameCheck if the qualified name of this
Elementmatches the provided segments of a qualified name.Members inherited from
AstNode(7 members)
cst_nodeRThe source CST node of
selfif one exists.
documentRThe
documentthat owns this node.
parentRThe parent node of
self.
__hash__Identity based hash of this node.
castcast(self, *type: type[TNode]) -> TNode
isinstanceChainable equivalent to
isintance(self, type)
try_castChecked cast to
type. Attributes
All subtypes of
Commentaccording 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
Comment.Std.When working with standard metamodel types, use:
For type hints, instead use
Comment.Std:Note that
Comment.Stdis only defined duringTYPE_CHECKING, depending on the Python version used eitherfrom __future__ import annotationsordef function(...) -> "Comment.Std"may be required to ensure that annotations are resolved lazily without an actual object present.Implementation of
bodydefined in the KerML specification.Specification:
See section 8.3.2.3.4 of the KerML specification for more details.
Implementation of
localedefined in the KerML specification.Specification:
See section 8.3.2.3.4 of the KerML specification for more details.
Used in
syside.CommentSTDsyside.Elementcomments