MeshSegmentWireCollection

A collection of wires meshed with segments.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.fek]])
sConf = app.Models["Dipole_Example"].Configurations[1]
mesh = sConf.Mesh

    -- Get the label of the specified mesh entity
    
label = mesh.SegmentWires[1].Label

    -- Get the number of SegmentWires in 'SegmentWires' Collection

MoMWireCount = #mesh.SegmentWires

Usage locations

The MeshSegmentWireCollection object can be accessed from the following locations:

Property List

Count
The number of MeshSegmentWire items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the MeshSegmentWire at the given index. (Returns a MeshSegmentWire object.)
Item (label string)
Returns the MeshSegmentWire with the given label. (Returns a MeshSegmentWire object.)
Items ()
Returns a table of MeshSegmentWire. (Returns a List of MeshSegmentWire object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the MeshSegmentWire at the given index in the collection. (Read MeshSegmentWire)
[string]
Returns the MeshSegmentWire with the given name in the collection. (Read MeshSegmentWire)

Property Details

Count
The number of MeshSegmentWire items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the MeshSegmentWire.
Return
boolean
The success of the check.
Item (index number)
Returns the MeshSegmentWire at the given index.
Input Parameters
index(number)
The index of the MeshSegmentWire.
Return
MeshSegmentWire
The MeshSegmentWire at the given index.
Item (label string)
Returns the MeshSegmentWire with the given label.
Input Parameters
label(string)
The label of the MeshSegmentWire.
Return
MeshSegmentWire
The MeshSegmentWire with the given label.
Items ()
Returns a table of MeshSegmentWire.
Return
List of MeshSegmentWire
A table of MeshSegmentWire.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for MeshSegmentWire.