Port

A port.

Example

local app = cf.GetApplication()
local project = app:NewProject()

line = project.Geometry:AddLine(cf.Point(0, 0, 0), cf.Point(1, 1, 1))

    -- Add a wire port and obtain a handle to a 'Port'

port = project.Ports:AddWirePort(line.Wires[1])

    -- Delete the port again

port:Delete()

Inheritance

The following objects are derived (specialisations) from the Port object:

Property List

Faulty
True if the port is faulty. (Read only boolean)
Label
The port label. (Read/Write string)
Suspect
True if the port is suspect. (Read only boolean)
Terminal
The port terminal. (Read only Terminal)
Visible
Specifies whether the port must be shown or hidden. (Read/Write boolean)

Method List

Delete ()
Delete the port.

Property Details

Faulty
True if the port is faulty.
Type
boolean
Access
Read only
Label
The port label.
Type
string
Access
Read/Write
Suspect
True if the port is suspect.
Type
boolean
Access
Read only
Terminal
The port terminal.
Type
Terminal
Access
Read only
Visible
Specifies whether the port must be shown or hidden.
Type
boolean
Access
Read/Write

Method Details

Delete ()
Delete the port.