WireMeshPort
A port on a wire mesh segment or vertex.
Example
app = cf.GetApplication() project = app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MeshPorts.cfx]]) union1 = project.Geometry['Union1'] -- Unlink the Mesh. 'WireMeshPorts' are generated automatically from 'WirePorts' union1:UnlinkMesh() -- Get the 'WireMeshPort' associated with the 'WirePort' labelled 'WirePort1' wireMeshPort = project.Ports['WirePort1_1'] -- -- Query if the mesh port is faulty isFaulty = wireMeshPort.Faulty
Inheritance
The WireMeshPort object is derived from the Port object.
Property List
- DefinitionMethod
- The wire mesh port type definition. (Read/Write WirePortDefinitionMethodEnum)
- Faulty
- True if the port is faulty. (Read only boolean)
- Label
- The port label. (Read/Write string)
- PolarityReversed
- The option to reverse polarity of the port. (Read/Write boolean)
- Segment
- The mesh segment the port is connected to. Only valid if DefinitionMethod is UsingSegment. (Read/Write MeshElement)
- 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)
- Vertex
- The mesh vertex the port is connected to. Only valid if DefinitionMethod is UsingVertex. (Read/Write MeshVertex)
- 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
- DefinitionMethod
- The wire mesh port type definition.
- Type
- WirePortDefinitionMethodEnum
- Access
- Read/Write
- Faulty
- True if the port is faulty.
- Type
- boolean
- Access
- Read only
- Label
- The port label.
- Type
- string
- Access
- Read/Write
- PolarityReversed
- The option to reverse polarity of the port.
- Type
- boolean
- Access
- Read/Write
- Segment
- The mesh segment the port is connected to. Only valid if DefinitionMethod is UsingSegment.
- Type
- MeshElement
- 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
- Vertex
- The mesh vertex the port is connected to. Only valid if DefinitionMethod is UsingVertex.
- Type
- MeshVertex
- Access
- Read/Write
- 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.