CableHarnessCollection

A collection of cable harnesses.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]])

    -- Add an empty 'CableHarness'

createTable = {}
createTable.Label = "EmptyCableHarness"
emptyCableHarness = project.Cables.Harnesses:Add(createTable)

    -- Retrieve an existing 'CableHarness'

cableHarness1 = project.Cables.Harnesses:Item("CableHarness1")

Usage locations (collections)

The following objects contain the CableHarnessCollection collection:

Property List

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

Method List

Add ()
Create a cable harness request. (Returns a CableHarness object.)
Add (properties table)
Create a cable harness request using the table of properties. (Returns a CableHarness object.)
Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the CableHarness at the given index. (Returns a CableHarness object.)
Item (label string)
Returns the CableHarness with the given label. (Returns a CableHarness object.)
Items ()
Returns a table of CableHarness. (Returns a List of CableHarness 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 CableHarness at the given index in the collection. (Read CableHarness)
[string]
Returns the CableHarness with the given name in the collection. (Read CableHarness)

Property Details

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

Method Details

Add ()
Create a cable harness request.
Return
CableHarness
The cable harness.
Add (properties table)
Create a cable harness request using the table of properties.
Input Parameters
properties(table)
The table of properties.
Return
CableHarness
The cable harness.
Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the CableHarness.
Return
boolean
The success of the check.
Item (index number)
Returns the CableHarness at the given index.
Input Parameters
index(number)
The index of the CableHarness.
Return
CableHarness
The CableHarness at the given index.
Item (label string)
Returns the CableHarness with the given label.
Input Parameters
label(string)
The label of the CableHarness.
Return
CableHarness
The CableHarness with the given label.
Items ()
Returns a table of CableHarness.
Return
List of CableHarness
A table of CableHarness.
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 CableHarness.