Skip to main content

Description

Ports specify interaction points on system components that define how parts interface with their environment and with each other. In SysML v2, ports are essential modeling elements that facilitate communication and interaction between system components, defining the interfaces through which information, energy, or material flows. Ports encapsulate the interaction details of a component, hiding internal implementation while exposing only the necessary interface points. They specify what flows in and out of a component, what protocols are used, and what properties characterize the interactions. This enables modular system design where components can be developed independently as long as they satisfy their port specifications, ensuring proper integration and interoperability. Nesting a port can be used to model a connector housing with the children ports as the specific pinouts. At this time only one level of nesting is supported in the block render view.
Ports should be defined at the lowest level of logical decomposition where the interface is actually implemented. They represent the physical or logical connection points where components interact with the system or with each other.

View Types

ViewDescription
PropertiesEdit the object’s properties, attributes, and metadata.
TableDisplay the object and its children in a tabular format.
RelationshipsExplore the network of connections to other objects.
HistoryTrack changes and revisions to the object.

Properties Fields

Name
string
Name of the object.
Short Name
string
Short name of the object.
Documentation
string
Description of the object.
Kind
enum
Specifies the direction of flow through the port. Options:
  • in - Input port (flows into the component)
  • out - Output port (flows out of the component)
  • inout - Bidirectional port (flows in both directions, default)
Attributes
object
A list of all Attribute objects owned by this port.Attribute Equations, Units and Type can be editied here, as well as recalculated and deleted entirely.Read more about Attributes
Relationships
connection
A list of all Relationships this object has with other model objects.Read more about Relationships