Class Port

Physical connection definition; port names belong to the containing component.

Implements

PortDefinition

Index

Constructors

Properties

connection? internalDiameter nominalSize? outerDiameter?

Methods

Constructors

constructor

new Port(options: PortOptions): Port
Parameters
- options: PortOptions
Returns Port
- Defined in src/connections/Port.ts:41

Properties

`Optional` `Readonly`connection

connection?: string

Open identifier, e.g. "flanged", "threaded", or a user-defined connection.

`Readonly`internalDiameter

internalDiameter: Quantity

Actual internal flow diameter at the connection.

`Optional` `Readonly`nominalSize

nominalSize?: NominalSize

`Optional` `Readonly`outerDiameter

outerDiameter?: Quantity

Methods

`Static`fromPipe

fromPipe(
pipe: Pick<PortDefinition, "internalDiameter" | "outerDiameter">,
options?: Omit<PortDetails, "outerDiameter">,
): Port
Use actual pipe dimensions; nominal designations must be supplied explicitly.
Parameters
- pipe: Pick<PortDefinition, "internalDiameter" | "outerDiameter">
- options: Omit<PortDetails, "outerDiameter"> = {}
Returns Port
- Defined in src/connections/Port.ts:116