v2.42
 
IPort Interface Reference

Represents a port. More...

Public Member Functions

HRESULT ConnectedRouteId ([out, retval] int *pId)
 Returns the id of the connected route object.
 
HRESULT HasConnectionWithRoute ([out, retval] VARIANT_BOOL *pConnected)
 Checks the port is connected to a route.
 

Properties

SAFEARRAY AvailableSystemCategories [get]
 The array of all available system categories for the port.
 
FlowDirectionType FlowDirection [get]
 The flow direction type of the port.
 
BSTR Name [get]
 The name of the port.
 
Placement3D Placement [get]
 The global coordinate system of the port in three-dimensional space.
 
IDispatch PortConnectionParams [get]
 Returns port parameters.
 

Detailed Description

Represents a port.

A port is an object that defines the parameters and position of the connection point of a model object to the system. This interface can be obtained from IObjectWithPorts.

Property Documentation

◆ Placement

Placement3D Placement
get

The global coordinate system of the port in three-dimensional space.

Description of the returned placement components:

  • origin - The global position of the port in three-dimensional space.
  • xAxis - The direction vector defining the orientation of the connection geometry. Makes sense when the port is rectangular.
  • zAxis - The direction vector pointing in the direction away from the port - towards Route.

◆ PortConnectionParams

IDispatch PortConnectionParams
get

Returns port parameters.

Parameters
[out]ppParamsThe port parameters. Can be either IPortDuctParams or IPortPipeParams interface.