`Cables`

Cable definitions and harnesses.

Example

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

    -- Get an existing 'CableHarness'

cableHarness = project.Contents.CableHarnesses["CableHarness1"]

    -- Get an existing 'CablePath'

cablePath = project.Definitions.Cables.Paths["CablePath1"]

Inheritance

The Cables object is derived from the Object object.

Usage locations

The Cables object can be accessed from the following locations:

Properties
- ModelDefinitions object has property Cables.

Property List

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

Collection List

CrossSections: A collection of cable cross sections. (CableCrossSectionCollection of CableCrossSection.)
Paths: The collection of cable paths in the model. (CablePathCollection of CablePath.)
Shields: The collection of cable shields in the model. (CableShieldCollection of CableShield.)

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.)
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

BoundingBox

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

Type: Box
Access: Read only

Label

The object label.

Type: string
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Collection Details

CrossSections

A collection of cable cross sections.

Type: CableCrossSectionCollection

Paths

The collection of cable paths in the model.

Type: CablePathCollection

Shields

The collection of cable shields in the model.

Type: CableShieldCollection

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.

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.