`EdgePort`

An edge port is created along an edge defining the boundary between two sets of faces.

Example

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

corner = cf.Point(-0.25, -0.25, 0)
cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25)

-- Add an 'EdgePort' to the edge of the cube between face 1 and 2

port = project.Contents.Ports:AddEdgePort({cube.Faces[1]},{cube.Faces[2]})

Inheritance

The EdgePort object is derived from the Port object.

Usage locations

The EdgePort object can be accessed from the following locations:

Methods
- PortCollection collection has method AddEdgePort(table).
- PortCollection collection has method AddEdgePort(List of Face, List of Face).
- PortCollection collection has method AddEdgePortConnectedToGround(List of Face, EdgePortGroundConnectionEnum).

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)
NegativeFaces: The collection of negative faces connected to the port. (Read/Write ObjectReferenceList)
NegativeTerminalGrounded: The option to connect the negative side of the port to ground. (Read/Write boolean)
PositiveFaces: The collection of positive faces connected to the port. (Read/Write ObjectReferenceList)
PositiveTerminalGrounded: The option to connect the positive side of the port to ground. (Read/Write boolean)
Schematic: The schematic associated with this item. (Read only Schematic)
SchematicLocation: The location of the item on the schematic. (Read only GridLocation)
SchematicRotation: The rotation of the item on the schematic. (Read only SymbolRotationEnum)
Terminals: The schematic terminals on this item. (Read only List of Terminal)
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.)
RotateSchematicSymbol (): Rotates the item on the schematic.
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.
SetSchematicLocation (location GridLocation): Sets the location of the item on the schematic.
SetSchematicRotation (rotation SymbolRotationEnum): Sets the rotation of the item on the schematic.

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

NegativeFaces

The collection of negative faces connected to the port.

Type: ObjectReferenceList
Access: Read/Write

NegativeTerminalGrounded

The option to connect the negative side of the port to ground.

Type: boolean
Access: Read/Write

PositiveFaces

The collection of positive faces connected to the port.

Type: ObjectReferenceList
Access: Read/Write

PositiveTerminalGrounded

The option to connect the positive side of the port to ground.

Type: boolean
Access: Read/Write

Schematic

The schematic associated with this item.

Type: Schematic
Access: Read only

SchematicLocation

The location of the item on the schematic.

Type: GridLocation
Access: Read only

SchematicRotation

The rotation of the item on the schematic.

Type: SymbolRotationEnum
Access: Read only

Terminals

The schematic terminals on this item.

Access: Read only

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.

RotateSchematicSymbol ()

Rotates the item on the schematic.

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.

SetSchematicLocation (location GridLocation)

Sets the location of the item on the schematic.

Input Parameters

location(GridLocation): The schematic location the item should be moved to.

SetSchematicRotation (rotation SymbolRotationEnum)

Sets the rotation of the item on the schematic.

Input Parameters

rotation(SymbolRotationEnum): The rotation setting.

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.