`CableSignalCollection`

A collection of cable signals.

Example

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

    -- Get an existing 'CableHarness' and 'CableInstance'

cableHarness = project.Contents.CableHarnesses["CableHarness1"]
cableInstance = cableHarness.CableInstances["Cable1"]

    -- Get the 'CableSignalSettings' of the 'CableInstance'

cableSignalSettings = cableInstance.Signals[1]

    -- Get the number of signals on the cable instance

count = cableInstance.Signals.Count

Inheritance

The CableSignalCollection object is derived from the Object object.

Usage locations

The CableSignalCollection object can be accessed from the following locations:

Collection lists
- CableInstance object has collection Signals.

Property List

Count: The number of CableSignal items in the collection. (Read only number)
Label: The object label. (Read/Write string)
Type: The object type string. (Read only string)

Method List

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 CableSignal for the given index in the collection. (Returns a CableSignal object.)
Item (label string): Returns the CableSignal for the given label in the collection. (Returns a CableSignal object.)
Items (): Returns a table of CableSignal items. (Returns a UnsupportedType(List of CableSignal) 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.

Static Function List

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

Property Details

Count

The number of CableSignal 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

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 CableSignal for the given index in the collection.

Input Parameters

index(number): The index of the CableSignal.

Return

CableSignal: The item in the collection

Item (label string)

Returns the CableSignal for the given label in the collection.

Input Parameters

label(string): The label of the CableSignal.

Return

CableSignal: The item in the collection

Items ()

Returns a table of CableSignal items.

Return

UnsupportedType(List of CableSignal): 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.

Static Function Details

GetDefaultProperties ()

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

Return

table: A table containing the default properties.