`CableProbeCollection`

A collection of cable probes.

Example

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

    -- Get an existing 'CableHarness' and 'CablePath'

cableHarness = project.Contents.CableHarnesses["CableHarness1"]
cablePath = project.Definitions.Cables.Paths["CablePath1"]

    -- Create a new 'CableProbe'

cableProbe = cableHarness.Probes:Add(cablePath)

    -- Query the number of probes on 'CableHarness'

numberOfCableProbes = #cableHarness.Probes

Inheritance

The CableProbeCollection object is derived from the Object object.

Usage locations

The CableProbeCollection object can be accessed from the following locations:

Collection lists
- CableHarness object has collection Probes.

Property List

Count: The number of CableProbe 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 probe along a cable path using table of properties. (Returns a CableProbe object.)
Add (path CablePath): Adds a new cable probe along a cable path. (Returns a CableProbe object.)
Delete (): Deletes the entity.
DeleteEntities ( List of Object): Delete the given list of entities from the collection.
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 CableProbe for the given index in the collection. (Returns a CableProbe object.)
Item (label string): Returns the CableProbe for the given label in the collection. (Returns a CableProbe object.)
Items (): Returns a table of CableProbe items. (Returns a UnsupportedType(List of CableProbe) 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 CableProbe 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 probe along a cable path using table of properties.

Input Parameters

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

Return

CableProbe: The new cable probe.

Add (path CablePath)

Adds a new cable probe along a cable path.

Input Parameters

path(CablePath): The cable path to apply the probe on.

Return

CableProbe: The new cable probe.

Delete ()

Deletes the entity.

DeleteEntities ( List of Object)

Delete the given list of entities from the collection.

Input Parameters

(List of Object)

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

Input Parameters

index(number): The index of the CableProbe.

Return

CableProbe: The item in the collection

Item (label string)

Returns the CableProbe for the given label in the collection.

Input Parameters

label(string): The label of the CableProbe.

Return

CableProbe: The item in the collection

Items ()

Returns a table of CableProbe items.

Return

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