EdgePort
An edge port is created along an edge defining the boundary between two sets of faces.
Example
app = cf.GetApplication() project = app:NewProject() corner = cf.Point(-0.25, -0.25, 0) cube = project.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.Ports:AddEdgePort({cube.Faces[1]},{cube.Faces[2]})
Inheritance
Property List
- Faulty
- True if the port is faulty. (Read only boolean)
- Label
- The port label. (Read/Write string)
- NegativeFaces
- The collection of negative faces connected to the port. (Read/Write List of Face)
- 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 List of Face)
- PositiveTerminalGrounded
- The option to connect the positive side of the port to ground. (Read/Write boolean)
- Suspect
- True if the port is suspect. (Read only boolean)
- Terminal
- The port terminal. (Read only Terminal)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the port must be shown or hidden. (Read/Write boolean)
Method List
- Delete ()
- Delete the port.
- 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 table)
- 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
- Faulty
- True if the port is faulty.
- Type
- boolean
- Access
- Read only
- Label
- The port label.
- Type
- string
- Access
- Read/Write
- NegativeFaces
- The collection of negative faces connected to the port.
- 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.
- Access
- Read/Write
- PositiveTerminalGrounded
- The option to connect the positive side of the port to ground.
- Type
- boolean
- Access
- Read/Write
- Suspect
- True if the port is suspect.
- Type
- boolean
- Access
- Read only
- Terminal
- The port terminal.
- Type
- Terminal
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Visible
- Specifies whether the port must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
Method Details
- Delete ()
- Delete the port.
- 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 properties table.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.