CableHarness
A cable harness.
Example
app = cf.GetApplication() project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]) -- Access an existing 'CableHarness' cableHarness = project.Cables.Harnesses["CableHarness1"] -- Change the cable coupling property cableHarness.CableCoupling = cf.Enums.CableHarnessCouplingEnum.RadiatingWithIrradiating -- Access a "Connector" on the 'CableHarness' connector = cableHarness.Connectors[1]
Usage locations (object properties)
The following objects have properties using the CableHarness object:
Property List
- CableCoupling
- The cable coupling properties. e.g. Irradiating, Radiating, ... (Read/Write CableHarnessCouplingEnum)
- ConnectorsVisible
- Controls the visibility of cable harness connectors on the 3D View. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- SchematicSettings
- The solution harness schematic settings. (Read only SolutionHarnessSchematicSettings)
- SolutionMethod
- The solution method for the outer cable problem (shielded/external ground). (Read/Write CableHarnessSolutionMethodEnum)
- Type
- The object type string. (Read only string)
Collection List
- CableInstances
- The collection of cable instances in the cable harness. (CableInstanceCollection of CableInstance.)
- Connectors
- The collection of cable connectors in the cable harness. (CableConnectorCollection of CableConnector.)
- Probes
- The collection of cable probes on the cable harness. (CableProbeCollection of CableProbe.)
- SchematicComponents
- The collection of cable schematic components on the cable harness schematic. (CableSchematicComponentCollection of CableSchematicComponent.)
Method List
- Delete ()
- Delete the cable harness.
- 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.)
- RearrangeCrossSections ()
- Randomly rearranges the cable harness cross sections.
- SetProperties (properties table)
- 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
- CableCoupling
- The cable coupling properties. e.g. Irradiating, Radiating, ...
- Type
- CableHarnessCouplingEnum
- Access
- Read/Write
- ConnectorsVisible
- Controls the visibility of cable harness connectors on the 3D View.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- SchematicSettings
- The solution harness schematic settings.
- Type
- SolutionHarnessSchematicSettings
- Access
- Read only
- SolutionMethod
- The solution method for the outer cable problem (shielded/external ground).
- Type
- CableHarnessSolutionMethodEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- CableInstances
- The collection of cable instances in the cable harness.
- Connectors
- The collection of cable connectors in the cable harness.
- Probes
- The collection of cable probes on the cable harness.
- Type
- CableProbeCollection
- SchematicComponents
- The collection of cable schematic components on the cable harness schematic.
Method Details
- Delete ()
- Delete the cable harness.
- 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 properties table.
- RearrangeCrossSections ()
- Randomly rearranges the cable harness cross sections.
- SetProperties (properties table)
- 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(table)
- 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
- The default properties table.