`CableInstanceCollection`

A collection of cable harnesses.

Example

application = cf.Application.GetInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]})

    -- Add an empty 'CableHarness'

createTable = {}
createTable.Label = "EmptyCableHarness"
emptyCableHarness = project.Contents.CableHarnesses:Add(createTable)

    -- Retrieve an existing 'CableHarness'

cableHarness1 = project.Contents.CableHarnesses:Item("CableHarness1")

Inheritance

The CableInstanceCollection object is derived from the Object object.

Usage locations

The CableInstanceCollection object can be accessed from the following locations:

Collection lists
- CableHarness object has collection CableInstances.

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Count: The number of CableInstance items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

Add (properties table): Adds a new cable instance to the harness using table of properties. (Returns a CableInstance object.)
Add (crosssection CableCrossSection, startconnector CableConnector, endconnector CableConnector): Adds a new cable instance to the harness between two connectors. (Returns a CableInstance object.)
Contains (label string): Checks if the collection contains an item with the given label. (Returns a boolean object.)
Delete (): Deletes the entity.
Duplicate (): Duplicates the entity. (Returns a Object object.)
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.)
Item (index number): Returns the CableInstance for the given index in the collection. (Returns a CableInstance object.)
Item (label string): Returns the CableInstance for the given label in the collection. (Returns a CableInstance object.)
Items (): Returns a table of CableInstance items. (Returns a UnsupportedType(List of CableInstance) object.)
SetProperties (properties Object): 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.
UniqueName (label string): Generates a unique name base 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 string object.)

Static Function List

GetDefaultProperties (): Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

Count

The number of CableInstance items in the collection.

Type: number
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Method Details

Add (properties table)

Adds a new cable instance to the harness using table of properties.

Input Parameters

properties(table): The table of properties defining the cable instance.

Return

CableInstance: The cable instance.

Add (crosssection CableCrossSection, startconnector CableConnector, endconnector CableConnector)

Adds a new cable instance to the harness between two connectors.

Input Parameters

crosssection(CableCrossSection): The cross section for the cable instance.
startconnector(CableConnector): The start connector.
endconnector(CableConnector): The end connector.

Return

CableInstance: The cable instance.

Contains (label string)

Checks if the collection contains an item with the given label.

Input Parameters

label(string): The label of the item.

Return

boolean: The success of the check.

Delete ()

Deletes the entity.

Duplicate ()

Duplicates the entity.

Return

Object: The new (duplicated) entity.

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 table defining the properties.

Item (index number)

Returns the CableInstance for the given index in the collection.

Input Parameters

index(number): The index of the CableInstance.

Return

CableInstance: The item in the collection

Item (label string)

Returns the CableInstance for the given label in the collection.

Input Parameters

label(string): The label of the CableInstance.

Return

CableInstance: The item in the collection

Items ()

Returns a table of CableInstance items.

Return

UnsupportedType(List of CableInstance): The list of items in the collection

SetProperties (properties Object)

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(Object): A table of properties defining the new state of the object.

UniqueName (label string)

Generates a unique name base 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

string: The generated unique name label for the item.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.