`Port`

A port.

Example

local application = cf.Application.GetInstance()
local project = application:NewProject()

line = project.Contents.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.Contents.Ports:AddWirePort(line.Wires[1])

    -- Delete the port again

port:Delete()

Inheritance

The Port object is derived from the Object object.

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

Usage locations

The Port object can be accessed from the following locations:

Properties
- PortProperties object has property Terminal.
Methods
- PortCollection collection has method Item(number).
- PortCollection collection has method Item(string).

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
GetProperties (): Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties Object): Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

GetProperties ()

Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.

Return

table: A table defining the properties.

SetProperties (properties Object)

Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Input Parameters

properties(Object): A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.