NamespaceImport SysML

class NamespaceImport

Implementation of NamespaceImport defined in the KerML specification.

Specification:

A NamespaceImport is an Import that imports Memberships from its imported_namespace into the import_owning_namespace. If is_recursive = false, then only the visible Memberships of the imported_namespace are imported. If is_recursive = true, then, in addition, Memberships are recursively imported from any owned_members of the imported_namespace that are Namespaces.

For language description, see section 7.2.5.4 of the KerML specification. For more details on the model, see section 8.3.2.4.6 of the KerML specification.

 Children

• NamespaceExpose

Members defined in NamespaceImport (2 members)

	STD	R	All subtypes of NamespaceImport according to the specification.
	imported_namespace	R SysML	Implementation of imported_namespace defined in the KerML specification.

Members inherited from Import (10 members)

	children	R	The elements enclosed by curly brackets in textual syntax.
	import_owning_namespace	R SysML	Implementation of import_owning_namespace defined in the KerML specification.
	import_target	R	The target element of this Import.
	imported_element	R SysML	Implementation of imported_element defined in the KerML specification.
	is_import_all	RW SysML	Implementation of is_import_all defined in the KerML specification.
	is_recursive	RW SysML	Implementation of is_recursive 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.
	try_set_is_import_all		Try setting is_import_all. For Expose elements, this will return False instead of throwing TypeError when using is_import_all setter.

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	The source CST node of self if one exists.
	document	R	The document that owns this node.
	parent	R	The parent node of self.
	__hash__		Identity based hash of this node.
	cast		cast(self, *type: type[TNode]) -> TNode
	isinstance		Chainable equivalent to isintance(self, type)
	try_cast		Checked cast to type.

 Attributes

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

All subtypes of NamespaceImport 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 NamespaceImport.Std.

When working with standard metamodel types, use:

if isinstance(element, NamespaceImport.STD):
    ...

For type hints, instead use NamespaceImport.Std:

def function(element: Element) -> NamespaceImport.Std:
    ...

Note that NamespaceImport.Std is only defined during TYPE_CHECKING, depending on the Python version used either from __future__ import annotations or def function(...) -> "NamespaceImport.Std" may be required to ensure that annotations are resolved lazily without an actual object present.

property imported_namespace: syside.Namespace | None

Implementation of imported_namespace defined in the KerML specification.

Specification:

The Namespace whose visible Memberships are imported by this NamespaceImport.

See section 8.3.2.4.6 of the KerML specification for more details.

 Used in

• syside.NamespaceImport

  • STD