Comment SysML

class Comment

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.

 Children

• Documentation

Members defined in Comment (3 members)

	STD	R
	body	RW	The annotation text for the Comment.
	locale	RW	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]].

Members inherited from AnnotatingElement (5 members)

	about	R	Container for owned annotations.
	annotated_elements	R	The Elements that are annotated by this AnnotatingElement. If annotation is not empty, these are the annotated_elements of the annotations. If annotation is empty, then it is the owning_namespace of the AnnotatingElement.
	annotations	R	The Annotations that relate this AnnotatingElement to its annotated_elements. This includes the owning_annotating_relationship (if any) followed by all the owned_annotating_relationships.
	owned_annotating_relationships	R	The owned_relationships of this AnnotatingElement that are Annotations, for which this AnnotatingElement is the annotating_element.
	owning_annotating_relationship	R	The owning_relationship of this AnnotatingRelationship, if it is an Annotation

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[type[syside.Comment], ...] = ()

property body: str

The annotation text for the Comment.

property locale: str | None

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]].

 Used in

• syside.Comment

  • STD

• syside.Element

  • comments