PortConjugation

PortConjugation is defined in SysML specification on page 327. Excerpt from the machine readable specification:

A PortConjugation is a Conjugation Relationship between a PortDefinition and its corresponding ConjugatedPortDefinition. As a result of this Relationship, the ConjugatedPortDefinition inherits all the features of the original PortDefinition, but input flows of the original PortDefinition become outputs on the ConjugatedPortDefinition and output flows of the original PortDefinition become inputs on the ConjugatedPortDefinition.

The following diagram shows the inheritance hierarchy of PortConjugation according to the specification:

// Class: PortConjugation
 digraph {
     PortConjugation [label="PortConjugation (SysML)" shape=plaintext]
     Conjugation -> PortConjugation
     Conjugation [label="Conjugation (KerML)" shape=plaintext]
     Relationship -> Conjugation
     Relationship [label="Relationship (KerML)" shape=plaintext]
     Element -> Relationship
     Element [label="Element (KerML)" shape=plaintext]
 }

The following table shows all attributes defined for PortConjugation according to the specification together with the documentation from the machine readable specification. Note that in SysIDE API, we use snake case for attribute names instead of Pascal case used in the specification.

Attribute

Documentation from machine readable specification

Attributes defined in PortConjugation:

conjugated_port_definition

The ConjugatedPortDefinition that is conjugate to the originalPortDefinition.

original_port_definition

The PortDefinition being conjugated.

Attributes defined in Conjugation:

conjugated_type

The Type that is the result of applying Conjugation to the originalType.

original_type

The Type to be conjugated.

owning_type

The conjugatedType of this Conjugation that is also its owningRelatedElement.

Attributes defined in Relationship:

is_implied

Whether this Relationship was generated by tooling to meet semantic rules, rather than being directly created by a modeler.

owned_related_elements

The relatedElements of this Relationship that are owned by the Relationship.

owning_related_element

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

related_elements

The Elements that are related by this Relationship, derived as the union of the source and target Elements of the Relationship.

sources

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

targets

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

Attributes defined in Element:

declared_name

The declared name of this Element.

declared_short_name

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

The Documentation owned by this Element.

element_id

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

Whether all necessary implied Relationships have been included in the ownedRelationships of this Element. This property may be true, even if there are not actually any ownedRelationships with isImplied = true, meaning that no such Relationships are actually implied for this Element. However, if it is false, then ownedRelationships may not contain any implied Relationships. That is, either all required implied Relationships must be included, or none of them.

is_library_element

Whether this Element is contained in the ownership tree of a library model.

name

The name to be used for this Element during name resolution within its owningNamespace. This is derived using the effectiveName() operation. By default, it is the same as the declaredName, but this is overridden for certain kinds of Elements to compute a name even when the declaredName is null.

owned_annotations

The ownedRelationships of this Element that are Annotations, for which this Element is the annotatedElement.

owned_elements

The Elements owned by this Element, derived as the ownedRelatedElements of the ownedRelationships of this Element.

owned_relationships

The Relationships for which this Element is the owningRelatedElement.

owner

The owner of this Element, derived as the owningRelatedElement of the owningRelationship of this Element, if any.

owning_membership

The owningRelationship of this Element, if that Relationship is a Membership.

owning_namespace

The Namespace that owns this Element, which is the membershipOwningNamespace of the owningMembership of this Element, if any.

owning_relationship

The Relationship for which this Element is an ownedRelatedElement, if any.

qualified_name

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 qualifiedName is null if this Element has no owningNamespace or if there is not a complete ownership chain of named Namespaces from a root Namespace to this Element.

short_name

The short name to be used for this Element during name resolution within its owningNamespace. This is derived using the effectiveShortName() operation. By default, it is the same as the declaredShortName, but this is overridden for certain kinds of Elements to compute a shortName even when the declaredName is null.

textual_representations

The TextualRepresentations that annotate this Element.

The following table lists SysIDE specific attributes available for class PortConjugation:

Python Attribute

CHAINABLE

STD

class PortConjugation
__cpp_name__: str = 'syside::sysml::PortConjugation'
STD: tuple[type[syside.PortConjugation], ...] = ()
CHAINABLE: bool = False
property original_port_definition: syside.PortDefinition | None
property conjugated_port_definition: syside.Type | None
property original_type: syside.Type | None
property conjugated_type: syside.Type | None
property owning_type: syside.Type | None
property children: syside.RelationshipBody
property original_type_target: syside.ChainedTypeReference
property conjugated_type_target: syside.ChainedTypeReference