`MeshSegmentWireCollection`

A collection of wires meshed with segments.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Settings for normal meshing

project.Mesher.Settings.WireRadius = "0.01"
advancedMeshSettings = project.Mesher.Settings.Advanced
advancedMeshSettings.CurvilinearSegments = cf.Enums.MeshCurvilinearOptionsEnum.Disabled

project.SolutionConfigurations[1].Frequency.Start = "1e08"

    -- Create geometry and mesh

project.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false)
project.Mesher:Mesh()
project.Geometry["Helix1"]:UnlinkMesh()

    -- Obtain a handle to the 'MeshSegmentWireCollection'

meshSegmentWires = project.Meshes["Helix1_1"].SegmentWires    

    -- Store the number of mesh segment wires
    
meshSegmentWiresCount = meshSegmentWires.Count

Usage locations (collections)

The following objects contain the MeshSegmentWireCollection collection:

Mesh(.SegmentWires)

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.