CableHarness
A cable harness.
Example
application = cf.Application.GetInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Cables.cfx]]}) -- Access an existing 'CableHarness' cableHarness = project.Contents.CableHarnesses["CableHarness1"] -- Change the cable coupling property cableHarness.CableCoupling = cf.Enums.CableHarnessCouplingEnum.RadiatingWithIrradiating -- Access a "Connector" on the 'CableHarness' connector = cableHarness.Connectors[1]
Inheritance
The CableHarness object is derived from the Object object.
Usage locations
The CableHarness object can be accessed from the following locations:
- Properties
- Methods
- CableHarnessCollection collection has method Add().
- CableHarnessCollection collection has method Add(table).
- CableHarnessCollection collection has method Item(number).
- CableHarnessCollection collection has method Item(string).
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- 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)
- 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.)
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.)
- RearrangeCrossSections ()
- Randomly rearranges the cable harness cross sections.
- 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
- 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
- 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
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.
- RearrangeCrossSections ()
- Randomly rearranges the cable harness cross sections.
- 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.