Electrical Package in Knowledge Expert              

An Electrical package is supported by Knowledge Expert.
 

To be able to use it, you need to activate the Electrical package.

To do so:

  1. Select Tools > Options... > General > Parameters and Measure and go to the Knowledge Environment tab.

  2. Select Electrical from the list of available packages and click the Down arrow to load this package:

  3. Click OK to validate.
  This package can be accessed via the object browser and objects, attributes and methods in the package can be used in expert relations.
You can, for example, write a rule to report in a file all the bundle segments with a diameter greater than a specified value.

The package contains the following objects:
BackShell ExternalSplice Signal
BundlePositionPoint FillerPlug SignalRoute
Bundle FunctionalConnector Stud
BundleSegment FunctionalEquipment System
BundleSegmentExtremity GroundSignal Tape
Cavity GroupSignal TerminalBlock
CommandSignal InternalSplice TerminalStrip
ConnectorShell OffSheet Termination
Contact PowerSignal Termination_GeoConstraint
ContactPoint Protection VideoSignal
CorrugatedTube ShieldingSignal Wire
Equipment SingleConnector InternalAdaptiveProtection
InternalCorrrugatedProtection InternalFixedProtection InternalTapeProtection
InternalProtection Branchable MultiInsertConnector
GeometricalBundle Mounting Equipment  

BackShell  

Description
Describes an electrical feature of Back Shell type that you create when you select Define Back Shell in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

The back shell is a physical component used to guide the bundle segment extremity to the single insert connector, and to protect the crimping area.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Extra_Length Type: Double

Defines the cable extra-length to be added to take into account the wire length inside the back shell.
Elec_Ref_Des Type: String

Defines the back shell reference designator attribute, which is the unique identifier for the back shell in the project.
Elec_Sub_Type Type: String

Defines the back shell subtype (User defined subtype).
Elec_Fmbd_Modify Type: Boolean

Defines the back shell attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command.
Is True if modified.
Elec_External_Reference Type: String

Defines the back shell external reference attribute.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_FullConnected Type: Boolean

Is True if the back shell is connected to a single insert connector and a bundle segment.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.

Branchable 

 

Description

  
Describes an electrical feature of a branch when you click Branch Definition .
For more information, refer to the Electrical Harness Installation User's Guide.

The Branchable type defines the electrical properties of a branch.

Inheritance path: Standard - Feature

  

Attributes

Elec_ConstructionMode Type: String
Defines the construction mode.
 
Elec_BranchableSlack Type: Real
Defines the slack mode of the branch.
 
Elec_Length Type: Length
Defines the electrical branch length.
 
Elec_Creation_Mode Type: Boolean

Defines the creation mode.
Is True if the Branchable is created/edited with Bend Radius Ratio mode.
Is False if the Branchable is created/edited with Bend Radius mode.
Elec_BendRadiusRatio Type: Double

Defines the value of bend radius ratio for particular Branchable during creation / edition.
The value of this attribute is Unset, if the Elec_Creation_Mode is False.
Elec_AlgoType Type: Integer

Defines the algotype for the branchable curve. 
This attribute is valued during the creation and recomputation of all branchables.
The value of this attribute is 1,if branchable curve is computed with FLEX Algorithm.
If the value is 0, it implies branchable curve is computed with Standard Algorithm.

BundlePositionPoint  

Description
Describes an electrical feature of Bundle Segment Position Point type.
For more information, refer to the Electrical Harness Installation User's Guide.

The Bundle Segment Position Point type defines the point along a bundle segment at which the local slack is applied.

Inheritance path: Standard - Feature

Attributes

Elec_Slack Type: Double

Defines the slack length at the bundle segment position point.

Bundle  

Description
Describes an electrical feature of Bundle type that you create when you click New Bundle in the Electrical Wire Routing workbench.
For more information, refer to the Electrical Wire Routing User's Guide.

The ElecBundle type is an object that contains wires.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Ref_Des Type: String

Defines the bundle reference designator attribute, which is the unique identifier for the bundle in the project.
Elec_Sub_Type Type: String

Defines the bundle subtype (User defined subtype).

BundleSegment  

Description
Describes an electrical feature of Bundle Segment type that you create when you select either Bundle Segment or Multi-Branchable Document   in the Electrical Harness Installation workbench.
For more information, refer to the Electrical Harness Installation User's Guide.

The BundleSegment type is a segment of a geometrical bundle.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Bend_Radius Type: Double

Input data defining the bend radius value that corresponds to the minimum bend radius of the bundle segment curve.
Elec_Bend_Radius_OK Type: Boolean

Is True if the bundle segment real bend radius is greater than the Elec_Bend_Radius attribute.
Elec_Min_Bend_Radius Type: Double

Output data defining the actual minimum bend radius value computed on the bundle segment curve.
Elec_BundleSegmentExtremities Type: Void

Returns the ends of the bundle segment.
Elec_Creation_Mode Type: String
Defines the electrical bundle segment creation mode.
Three modes exist:
  • Slack: Elec_Length is not valuated.
  • Bend: Elec_Slack and Elec_Length are not valuated.

  • Length: Elec_Slack is not valuated.
Elec_Di_Slack Type: Double

Input data defining the percentage of distributed slack along the bundle segment.
This attribute induces the value of the Elec_Length attribute.
Elec_Diameter Type: Double

Defines the bundle segment diameter.
Elec_Fmbd_Modify Type: Boolean

Defines the bundle segment attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_FullConnected Type: Boolean

Is True if both bundle segment extremities are connected.
Elec_Length Type: Double

Gives the bundle segment length.
Elec_Ref_Des Type: String

Defines the bundle reference designator attribute, which is the unique identifier for the bundle in the project.
Elec_Segreg Type: String

Defines the bundle segment separation code used by the routing algorithm.
Elec_Sub_Type Type: String
Defines the bundle segment subtype.
Elec_True_Length Type: Double

Attribute used in the fake length context of the extracted data in Electrical Harness Flattening.
This attribute keeps the bundle segment real length, coming from the 3D data.
In this context, the Elec_Length returns the fake length.
IncludedWires Type: CATIList

Returns a list of wires routed inside the bundle segment.
BendRadius Type: Length
Defines the user input bend radius.
ComputedBendRadius Type: Length
Defines the computed bend radius.
IsElectricalCurve Type: Boolean
Checks if the electrical curve is computed using the electrical algorithm.
IsNotCollapsed Type: Boolean
Checks if segment is collapsed.
BendRadiusOK Type: Boolean
Checks if the input bend radius is greater than the computed bend radius.
IsResultOK Type: Boolean
Checks if the segment is not collapsed AND that is has a good bend radius AND that the curve is computed using the electrical algorithm.
DiameterComputedFromWires Type: Real
Checks whether the assigned diameter of the bundle segment is valid or not.

BundleSegmentExtremity

Description
Describes the end of an electrical feature of Bundle Segment type. When a bundle segment is created, it automatically has two ends.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

NumberOfConnectedBundles Type: Integer

Defines the number of bundle segments connected to the selected end of a bundle segment.
NumberOfConnectedDevices Type: Integer

Defines the number of devices connected to a bundle segment.

Returns 0 if no devices are connected, 1 if a device is connected at one end and 2 if devices are connected at both ends.
IsGeoAndElecConnectionSame:boolean Type: Boolean
Checks whether or not the electrical connection and geometrical connection at the bundle segment extremity coincide.
This is useful where networks are not properly created.
Elec_LocalSlack Type: String
Defines the local slack added to the branch segment extremity.

Cavity  

Description
Describes an electrical feature of Cavity type that you create when you click Define Cavity in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

The cavity defines a reservation for a connector.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Extra_Length Type: Double

Defines the wire length to be added to the wire routing length.
Elec_Id_Number Type: String

Defines a unique identifier for the cavity used to map a functional component and the corresponding physical part.
Elec_Ref_Des Type: String

Defines the cavity reference designator attribute, which is the unique identifier for the cavity in the project.
Elec_Sub_Type Type: String

Defines the cavity subtype.

CommandSignal   

Description
Describes an electrical feature of Command Signal type that you create when you select command signal  in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

The command signal is a logical connection between two or more components. It will be realized by a wire in physical world.

Inheritance path: Standard - Feature > ProductPackage - Product > Electrical - ElecSignal

Attributes

Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the wire that realizes the command signal.
Elec_Recom_Wire_Type Type: String

Defines the attribute of the wire recommended to realize the signal.
Elec_Routing_Priority Type: Double

Defines the priority for the signal routing.
Elec_Sep_Code Type: String

Defines the separation code of the command signal used by the algorithm to find out the wire route.
Elec_Signal_Section Type: Double

Defines the command signal section.
Elec_Sub_Type Type: String

Defines the command signal subtype.

ConnectorShell  

Description
Describes an electrical feature of Connector Shell type that you create when you click Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A connector shell or shell is a non-electrical part which groups one or more electrical connector parts. It may be part of an equipment.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Ref_Des Type: String

Defines the connector shell reference designator attribute, which is the unique identifier for the connector shell in the project.

Elec_Sub_Type Type: String

Defines the connector shell subtype.
Elec_Fmbd_Modify Type: Boolean

Defines the connector shell attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_External_Reference Type: String

Defines the connector shell external reference attribute.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.

Contact  

Description
Describes an electrical feature of Contact type that you create when you click Define Contact in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A contact is an electrical component used within a termination and a cavity or between bundle segments.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Barrel_Diameter Type: Double

Defines the hole diameter which lets the wire through.
Elec_External_Reference Type: String

Defines the contact reference from an external library.
Elec_FullConnected Type: Boolean

Is True if all the contacts are connected.
Elec_Ref_Des Type: String

Defines the contact reference designator attribute, which is the unique identifier for the contact in the project.
Elec_Sub_Type Type: String

Defines the contact subtype.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

CorrugatedTube  

Description
Describes an electrical feature of Corrugated Tube type that you create when you click Define Protective Covering in the Electrical Library workbench. The corrugated tube is then instantiated using the Electrical Harness Installation workbench.
For more information, refer to the Electrical Library and Electrical Harness Installation User's Guides.

A corrugated tube is an electrical component applied onto bundle segments as a protection.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Bend_Radius Type: Double

Defines the bend radius value, which corresponds to the minimum bend radius of the corrugated tube curve.
Elec_Bend_Radius_Protection_OK Type: Boolean

Is True if the Elec_Bend_Radius attribute is smaller than the real value of bend radius of the largest bundle segment linked to the corrugated tube.
Elec_Fmbd_Modify Type: Boolean

Defines the single connector attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Inner_Diameter Type: Double

Defines the corrugated tube inner diameter.
Elec_Length Type: Double

Defines the corrugated tube length.
Elec_Line_Type Type: Double

Defines the corrugated tube line type.
Elec_Line_Weight Type: Double

Defines the corrugated tube linear mass, used for the flattened representation.
Elec_Ref_Des Type: String

Defines the corrugated tube reference designator attribute, which is the unique identifier for the corrugated tube in the project.
Elec_Ref_PartNumber Type: String

Defines the corrugated tube reference part number.
Elec_Sub_Type Type: String

Defines the protection subtype.
Elec_Thickness Type: Double

Defines the corrugated tube thickness.

Equipment  

Description
Describes an electrical feature of Equipment type that you create when you click Define Equipment in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

An equipment is an electrical device with one or more associated components: connectors, shells, contacts, filler plugs, placed in cavities. An equipment can also comprise terminations and bundle connection points.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the equipment reference from an external library.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_Fmbd_Modify Type: Boolean

Defines the equipment attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Ref_Des Type: String

Defines the equipment reference designator attribute, which is the unique identifier for the equipment in the project.
Elec_Sub_Type Type: String

Defines the equipment subtype.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

ExternalSplice  

Description
Describes an electrical feature of External Splice type that you create when you click Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

An external splice is an electrical connector receiving bundle segments from different geometrical bundles.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the external splice reference from an external library.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_Fmbd_Modify Type: Boolean

Defines the external splice attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Ref_Des Type: String

Defines the external splice reference designator attribute, which is the unique identifier for the external splice in the project.
Elec_Sub_Type Type: String

Defines the external splice subtype.
Elec_FullConnected Type: Boolean

Is True if all the bundle connection points and terminations of the external splice are connected.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

FillerPlug  

Description
Describes an electrical feature of Filler Plug type that you create when you click Define Filler Plug in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A filler plug is an electrical component used to block up an unused cavity.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Ref_Des Type: String

Defines the filler plug reference designator attribute, which is the unique identifier for the filler plug in the project.
Elec_Sub_Type Type: String

Defines the filler plug subtype.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.

ContactPoint  

Description
Describes an electrical feature of Contact Point type that you create when you select Contact Points in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

This contact point is a functional electrical component that defines the point of contact or attachment for an electrical signal.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Id_Number Type: String

Defines the contact point Id number.
Elec_Number Type: Integer

Defines a unique identifier for the contact point used to map a functional component and the corresponding physical part.
Elec_Ref_Des Type: String

Defines the contact point reference designator attribute, which is the unique identifier for the contact point in the project.
Elec_Signal_IO Type: String

Defines if the signal is input or output.
Elec_Signal_Unicity Type: Boolean

Defines the unicity of the signal: True if the signal is unique.
Elec_Sub_Type Type: String

Defines the contact point subtype.

FunctionalConnector  

Description
Describes an electrical feature of Functional Connector type that you create when you select Functional Connectors in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

This connector is a functional electrical component with one or more associated contact points, for example, a power or signal transmission connector.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the functional connector reference to an external library.
Elec_Id_Number Type: String

Defines a unique identifier for the functional connector used to map a functional component and the corresponding physical part.
Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the physical connector that realizes the functional connector.
Elec_Ref_Des Type: String

Defines the functional connector reference designator attribute, which is the unique identifier for the connector in the project.
Elec_Sub_Type Type: String

Defines the functional connector subtype.

FunctionalEquipment  

Description
Describes an electrical feature of Functional Equipment type that you create when you select Functional Equipment in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

This equipment is a functional electrical component with one or more associated connectors, for example a lamp or a battery.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the functional equipment reference to an external library.
Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the physical equipment that realizes the functional equipment.
Elec_Ref_Des Type: String

Defines the functional equipment reference designator attribute, which is the unique identifier for the equipment in the project.
Elec_Sub_Type Type: String

Defines the functional equipment subtype.

Geometrical Bundle  

Description
Describes an electrical feature of a geometrical bundle when you click Geometrical Bundle in the Electrical Harness Assembly workbench.
For more information, refer to the Electrical Harness Installation User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

GroundSignal  

Description
Describes an electrical feature of Ground Signal type that you create when you select Ground Signal in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

The ground signal is a logical connection between two or more components. It will be realized by a wire in physical world.

Inheritance path: Standard - Feature > ProductPackage - Product > Electrical - ElecSignal

Attributes

Elec_Ground_Unicity Type: Boolean

Defines the unicity of the ground signal: True if the signal is unique.
Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the wire that realizes the ground signal.
Elec_Recom_Wire_Type Type: String

Defines the attribute of the wire recommended to realize the signal.
Elec_Routing_Priority Type: Double

Defines the priority for the signal routing.
Elec_Sep_Code Type: String

Defines the separation code of the ground signal used by the algorithm to find out the wire route.
Elec_Signal_Section Type: Double

Defines the ground signal section.
Elec_Sub_Type Type: String

Defines the ground signal subtype.

Internal Protection 

Description

  
Describes the internal protective covering when you click Define Protective Product in the Electrical Assemble Design workbench.
For more information, refer to the Electrical Library User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

  
Attributes
Elec_Length Type: Double
Defines the protection length.
 
Elec_Ref_Part_Number Type: String
Defines the protection reference part number.
 
Elec_Sub_Type Type: string
Defines the protection subtype.
 
CoveredBundleSegments Type List
Returns the list of bundle segments covered by the protection.
 
Elec_Line_Type Type: Double
Defines the protection line type.
 
Elec_Line_Weight Type: Double
Defines the protection linear mass, used for flattened representation.
 
Elec_Inner_Diameter Type: Double
Defines the adaptive protection inner diameter. Attribute in read only for adaptive protection and tape.
 
 
   

Internal Fixed Protection

Description

  
Describes the fixed protection thickness when you click Define Protective Product in the Electrical Assemble Design workbench.
For more information, refer to the Electrical Library User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

  
Attributes
Elec_Thickness Type: Double
Defines the fixed diameter protection thickness.
 
Elec_Bend_Radius Type: Double
Defines the fixed diameter protection bend radius.
 
 

Internal Adaptive Protection

Description

  
Describes the adative protection thickness when you click Define Protective Product in the Electrical Assemble Design workbench.
For more information, refer to the Electrical Library User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

  

Attributes

Elec_Thickness Type: Double
Describes the adative protection thickness.
 
 

Internal  Corrugated Protection

Description

  
Describes the adative protection thickness when you click Define Protective Product in the Electrical Assemble Design workbench.
For more information, refer to the Electrical Library User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

  
Attributes
Elec_Thickness Type: Double
Defines the corrugated tube protection thickness.
 
Elec_Bend_Radius Type: Double
Defines the corrugated tube protection bend radius.
 
 

Internal  Tape Protection

Description  
Describes the adative protection thickness when you click Define Protective Product in the Electrical Assemble Design workbench.
For more information, refer to the Electrical Library User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

  
Attributes
Elec_Tape_Thickness Type: Double
Defines the tape protection thickness.
 
Elec_Tape_Width Type: Double
Defines the tape protection thickness.
 
Elec_Taping_Angle Type: Double
Defines the tape protection thickness.
 
Elec_Covering_Length Type: Double
Defines the tape protection thickness.
 
Elec_Number_Layer Type: Double
Defines the tape protection thickness.
 
Elec_Total_Thickness Type: Double
Defines the tape protection thickness.
 
Elec_Total_Tape_Length Type: Double
Defines the tape protection thickness.
 
Elec_Bend_Radius_Delta Type: Double
Defines the tape protection thickness.
 
 

GroupSignal  

Description
Describes an electrical feature of Group Signal type that you create when you select Grouped electrical signal in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

Grouped signals will be routed together, for example shielded or twisted signals.

Inheritance path: Standard - Feature > ProductPackage - Product > Electrical - ElecSignal

Attributes

Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the wire that realizes the group signal.
Elec_Recom_Wire_Type Type: String

Defines the attribute of the wire recommended to realize the signal.
Elec_Routing_Priority Type: Double

Defines the priority for the signal routing.
Elec_Sep_Code Type: String

Defines the separation code of the group signal used by the algorithm to find out the wire route.
Elec_Signal_Section Type: Double

Defines the group signal section.
Elec_Fmbd_Modify Type: Boolean

Defines the internal splice attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Sub_Type Type: String

Defines the group signal subtype.

InternalSplice  

Description
Describes an electrical feature of Internal Splice type that you create when you click Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

An internal splice is a type of connector used to connect two or more wires belonging to the same bundle.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the internal splice reference to an external library.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_Mass Type: Double

Defines the internal splice mass.
Elec_Offset Type: Double

Defines the distance to the bundle segment extremity selected to place the internal splice.
Elec_Ref_Des Type: String

Defines the internal splice reference designator attribute, which is the unique identifier for the internal splice in the project.
Elec_Sub_Type Type: String

Defines the internal splice subtype.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

Mounting Equipment

Description

 
Describes an electrical feature of Mounting Equipment type that you create when you click Define Mounting Equipment in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A Mounting Equipment

Inheritance path: Standard - Feature > ProductPackage - Product 

  

Attributes

 
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.

 

Multi Insert Connector

Description
Describes an electrical feature of Multi Insert Connector type that you create when you click Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_reference Type: String
Defines the multi insert connector reference to an external library.
 
Elec_Sub_Type Type: String
Defines the multi insert connector subtype.
 
Elec_Ref_Des Type: String
Defines the multi insert connector reference designator attribute, which is the unique identifier for the multi insert connector in the project.
 
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

OffSheet  

Description
Describes an electrical feature of Off Sheet Connector type that you create when you select Offsheet Connector in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

An off sheet connector is a marker in the functional definition that is used to establish connections between different systems.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Name Type: String

Defines the off sheet connector name.
Elec_Number Type: Integer

Defines the off sheet connector number.
Elec_Signal_IO Type: String

Defines if the signal is input or output.
Elec_Sub_Type Type: String

Defines the off sheet connector subtype.

Stud  

Description
Describes an electrical feature of Stud type that you create when you click Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A stud is an electrical connector receiving bundle segments with one or more wires connected through a termination. It is used to ground bundle segments or pieces of equipment.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the stud reference to an external library.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_Ref_Des Type: String

Defines the stud reference designator attribute, which is the unique identifier for the stud in the project.
Elec_Sub_Type Type: String

Defines the stud subtype.
Elec_FullConnected Type: Boolean

Is True only if all the stud bundle connection points  are connected.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

PowerSignal  

Description
Describes an electrical feature of Power Signal type that you create when you select Power Signal in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

The power signal is a logical connection between two or more components. It will be realized by a wire in physical world.

Inheritance path: Standard - Feature > ProductPackage - Product > Electrical - ElecSignal

Attributes

Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the wire that realizes the power signal.
Elec_Nominal_Voltage Type: Double

Defines the power signal nominal voltage.
Elec_Recom_Wire_Type Type: String

Defines the attribute of the wire recommended to realize the signal.
Elec_Routing_Priority Type: Double

Defines the priority for the signal routing.
Elec_Sep_Code Type: String

Defines the separation code of the power signal used by the algorithm to find out the wire route.
Elec_Sub_Type Type: String

Defines the power signal subtype.
Elec_Signal_Section Type: Double

Defines the power signal section.

Protection  

Description
Describes an electrical feature of protection type from which both the corrugated tube and the tape derives.
For more information, refer to the Electrical Library and Electrical Harness Installation User's Guides.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

CoveredBundleSegments Type: CATIList

Returns the list of bundle segments covered by the protection.
Elec_Fmbd_Modify Type: Boolean

Defines the bundle segment attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Length Type: Double

Defines the protection length.
Elec_Line_Type Type: Double

Defines the protection line type.
Elec_Line_Weight Type: Double

Defines the protection linear mass, used for the flattened representation.
Elec_Ref_Des Type: String

Defines the protection reference designator attribute.
Elec_Ref_PartNumber Type: String

Defines the protection reference part number.
Elec_Sub_Type Type: String

Defines the protection subtype.

ShieldingSignal  

Description
Describes an electrical feature of Shielding Signal type that you create when you select Shielding Signal in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

The shielding signal is a logical connection between two or more components. It will be realized by a wire in physical world.

Inheritance path: Standard - Feature > ProductPackage - Product > Electrical - ElecSignal

Attributes

Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the wire that realizes the shielding signal.
Elec_Recom_Wire_Type Type: String

Defines the attribute of the wire recommended to realize the signal.
Elec_Routing_Priority Type: Double

Defines the priority for the signal routing.
Elec_Sep_Code Type: String

Defines the separation code of the shielding signal used by the algorithm to find out the wire route.
Elec_Sub_Type Type: String

Defines the shielding signal subtype.
Elec_Signal_Section Type: Double

Defines the shielding signal section.
Elec_Nominal_Voltage Type: Double

Defines the shielding signal nominal voltage.

SingleConnector  

Description
Describes an electrical feature of Single Insert Connector type that you create when you click Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A single insert connector is an electrical connector male or female. It's the physical representation for both the plugs and the sockets.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the single insert connector reference to an external library.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_Ref_Des Type: String

Defines the single insert connector reference designator attribute, which is the unique identifier for the single insert connector in the project.
Elec_Sub_Type Type: String

Defines the single insert connector subtype.
Elec_Fmdb_Modify Type: Boolean

Defines the single connector attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_FullConnected Type: Boolean
Is True in only two cases:
  • if the single insert connector is integrated into an equipment and connected to another single insert connector,

  • if the single insert connector is connected to a bundle segment or a back shell and connected to another single insert connector.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

Signal  

Description
Describes an electrical feature of Signal type that you create when you select Signal in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

A signal is a logical connection between two or more components. May be of the following types: ground, shielding, video, power, command or grouped.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the physical wire that realizes the signal.
Elec_Recom_Wire_Type Type: String

Defines the attribute of the wire recommended to realize the signal.
Elec_Routing_Priority Type: Double

Defines the priority for the signal routing.
Elec_Sep_Code Type: String

Defines the separation code of the signal used by the algorithm to find out the wire route.
Elec_Signal_Section Type: Double

Defines the signal section.
Elec_ListPhysical Type: CATIList

Contains the list of ElecWire objects that realize the signal.

SignalRoute  

Description
Describes an electrical feature of Signal Route type that you create when you click Automatic Wire Routing in the Electrical Wire Routing workbench.
For more information, refer to the Electrical Wire Routing User's Guide.

The signal route is computed to find out the optimized way between two or more extremities of a signal.

Inheritance path: Standard - Feature

Attributes

Elec_Length Type: Double

Defines the signal route length.
Elec_Nominal_Part_Num Type: String

Defines the nominal part number of the wire that realizes the signal.
Elec_Section Type: Double

Defines the signal route section.
Elec_Sub_Type Type: String

Defines the signal route subtype.

System  

Description
Describes an electrical feature of System type that you create when you select System in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

A system consists of equipments, connectors and signals. It is an electrical unit, which accomplishes a specific function.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Ref_Des Type: String

Defines the system reference designator attribute, which is the unique identifier for the system in the project.
Elec_Sub_Type Type: String

Defines the system subtype.

Tape  

Description
Describes an electrical feature of Tape type that you create when you click Define Protective Covering in the Electrical Library workbench. The tape is then instantiated using the Electrical Harness Installation workbench.
For more information, refer to the Electrical Library and Electrical Harness Installation User's Guides.

A tape is an electrical component applied onto bundle segments as a protection.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Bend_Radius_Delta Type: Double

Defines the bend radius value, which corresponds to the minimum bend radius of the tape curve.
This value takes into account the bundle segment and tape bend radius rule and ends up to an increased rigidity due to the tape.
Elec_Bend_Radius_Protection_OK Type: Boolean

Is True if the Elec_Bend_Radius attribute is smaller than the real value of bend radius of the largest bundle segment linked to the tape protection.
Elec_Covering_Length Type: Double

Defines the tape overlapping used when instantiating the protection.
Elec_Fmbd_Modify Type: Boolean

Defines the bundle segment attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Length Type: Double

Defines the tape length.
Elec_Line_Type Type: Double

Defines the tape line type, used for the flattened representation.
Elec_Line_Weight Type: Double

Defines the tape linear mass.
Elec_Number_Layer Type: Double

Defines the tape number of layers applied onto the bundle segment.
Elec_Ref_Des Type: String

Defines the tape reference designator attribute, which is the unique identifier for the tape in the project.
Elec_Ref_PartNumber Type: String

Defines the tape reference part number.
Elec_Sub_Type Type: String

Defines the protection subtype.
Elec_Tape_Thickness Type: Double

Defines the tape thickness.
Elec_Tape_Width Type: Double

Defines the tape width.
Elec_Taping_Angle Type: Double

Defines the taping angle.
Elec_Total_Tape_Length Type: Double

Defines the tape length considering the overlapping due to the taping angle, and also the number of layers.
Elec_Total_Thickness Type: Double

Defines the tape thickness considering the overlapping due to the taping angle, and also the number of layers.

TerminalBlock  

Description
Describes an electrical feature of Terminal Block type that you create when you select Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A terminal block is an electrical connector receiving bundle segments, each bundle segment being connected to a termination.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_External_Reference Type: String

Defines the terminal block reference to an external library.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_Fmbd_Modify Type: Boolean

Defines the terminal block attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Ref_Des Type: String

Defines the terminal block reference designator attribute, which is the unique identifier for the terminal block in the project.
Elec_Sub_Type Type: String

Defines the terminal block subtype.
Elec_FullConnected Type: Boolean

Is True if all the terminal block terminations are connected.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

Termination  

Description
Describes an electrical feature of Termination type that you create when you click Define Termination in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A termination is a sub-element ensuring the electrical signal conduction between any type of electrical component except the filler plug. It is indissociable from the electrical component and corresponds to a contact crimped into a cavity.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Extra_Length Type: Double

Defines the length to be added to the wire routing length.
Elec_Id_Number Type: String

Defines a unique identifier for the termination used to map a functional component to the corresponding physical part.
Elec_Ref_Des Type: String

Defines the termination reference designator attribute, which is the unique identifier for the termination in the project.
Elec_Sub_Type Type: String

Defines the termination subtype.

Termination_GeoConstraint  

Description
Describes an electrical feature of Termination type that you create when you click Define Termination in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

This type of termination only exists for terminal strip and the stud connectors. It has an associated geometry (a line), which allows the connection to be constrained between the bundle segment and the connector. The bundle segment can only be connected via this associated geometry (the line).

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Extra_Length Type: Double

Defines the length to be added to the wire routing length.
Elec_Id_Number Type: String

Defines a unique identifier for the termination used to map a functional component and the corresponding physical part.
Elec_Ref_Des Type: String

Defines the termination reference designator attribute, which is the unique identifier for the termination in the project.
Elec_Sub_Type Type: String

Defines the termination subtype.

TerminalStrip  

Description
Describes an electrical feature of Terminal Strip type that you create when you click Define Connector in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

A terminal strip is an electrical connector comprising a strip of terminations.

Inheritance path: Standard - Feature

Attributes

Elec_External_Reference Type: String

Defines the terminal strip reference to an external library.
It is used in Electrical Harness Flattening for 2D detail graphic replacement in a drawing.
Elec_Fmbd_Modify Type: Boolean

Defines the terminal strip attribute, which makes it possible to know if the component has been modified during the Electrical Harness Flattening Synchronization command. Is True if modified.
Elec_Ref_Des Type: String

Defines the terminal strip reference designator attribute, which is the unique identifier for the terminal strip in the project.
Elec_Sub_Type Type: String

Defines the terminal strip subtype.
Elec_FullConnected Type: Boolean

Is True if all the terminal strip terminations are connected.
Connect (String ConnectionPointName, Product ToConnectObject, String ToConnectionPointName)  
Connects the current device to another device.
  • String ConnectionPointName is the name of the connection point used on the current device
  • Product ToConnectObject is the instance to connect to
  • String ToConnectionPointName is the name of the connection point used on the destination device.

Returns TRUE if the connection succeeds, FALSE otherwise.
Disconnect (String ConnectionPointName)
Disconnects a device.
String ConnectionPointName is the name of the connection point where disconnection will be done.
Returns TRUE if disconnection succeeds, FALSE otherwise.
ListConnectedObject (String ConnectionPointName, out Product ToConnectObject, String out ToConnectionPointName)
Retrieves the device connected to the current device.
  • String ConnectionPointName is the name of the connection point queried
  • Product ToConnectObject is the instance name of the device connected
  • String ToConnectionPointName is the name of the connection point used on the connected destination device.

Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListConnectionPoint (out List ListOfNames, out List ListOfTypes
Retrieves all connection points of a device.
Output parameters are two lists of names, the names and the types of the connection points.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
ListWires (out List ListOfWires, out List ListOfNames)
Retrieves all wires connected to a device from a device.
Output parameters are a list of wire instances and a list of connection point names where wires are connected.
Returns TRUE if information retrieval succeeds, FALSE otherwise.
SpecificationId Type: String
Checks and retrieves the ID of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
SpecifiedConnectedId Type: String
Checks and retrieves the ID of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecifiedConnectedPartNumber Type: String
Checks and retrieves the part number of the device connected to the current device in the loaded specification file (using iXFElec file or CAA APIs).
SpecificationPartNumber Type: String
Checks and retrieves the part number of the current device from the loaded specification file (using iXFElec file or CAA APIs).
Returns 'NoSpecificationLink' if not found.
 

VideoSignal  

Description
Describes an electrical feature of Video Signal type that you create when you select video signal in the Electrical System Functional Definition workbench.
For more information, refer to the Electrical System Functional Definition User's Guide.

The video signal is a logical connection between two or more components. It will be realized by a wire in physical world.

Inheritance path: Standard - Feature > ProductPackage - Product > Electrical - ElecSignal

Attributes

Elec_Nominal_Part_Num Type: String

Defines the part number of the wire that realizes the video signal.
Elec_Recom_Wire_Type Type: String

Defines the attribute of the wire recommended to realize the signal.
Elec_Routing_Priority Type: Double

Defines the priority for the signal routing.
Elec_Sep_Code Type: String

Defines the separation code of the video signal used by the algorithm to find out the wire route.
Elec_Signal_Section Type: Double

Defines the video signal section.
Elec_Sub_Type Type: String

Defines the video signal subtype.

Wire  

Description
Describes an electrical feature of Wire type that you create when you click Define Wire in the Electrical Library workbench.
For more information, refer to the Electrical Library User's Guide.

Inheritance path: Standard - Feature > ProductPackage - Product

Attributes

Elec_Bend_Radius Type: Double

Defines the bend radius.
Elec_Catalog Type: String

Defines the catalog from which the wire is selected.
Elec_Color Type: String

Defines the color of the wire.
Elec_Diameter Type: Double

Defines the wire diameter.
Elec_FromConnectionPoint Type: String

Returns the reference designator value of the connection point to which the from-end of the wire is connected.
Elec_FromContactPartNumber Type: String

Returns the part number of the contact in the device cavity to which the from-end of the wire is connected.
Elec_FromDevice Type: String

Returns the reference designator value of the device to which the from-end of the wire is connected.
Elec_FullConnected Type: Boolean

Is True if both wire extremities are connected.
Elec_IsNetworkConnex Type: Boolean

Is True if a route exists between whatever nodes only using the network connected branches.
Elec_IsRouted Type: Boolean

Is True if the wire is routed.
Elec_Length Type: Double

Defines the wire length.
Elec_Line_Weight Type: Double

Defines the wire linear mass.
Elec_Ref_Des Type: String

Defines the wire reference designator.
Elec_Sep_Code Type: String

Defines the separation code of the wire used by the algorithm to find out the wire route.
Elec_Shielding_Signal Type: String

Returns a product of type ElecSignal that realizes the wire.
Elec_Signal Type: ElecSignal

Returns a product of type ElecSignal that realizes the wire.
Elec_Signal_Id Type: String

Defines the identifier of the signal used during the wire routing.
Elec_Sub_Type Type: String

Defines the wire subtype.
Elec_ToConnectionPoint Type: String

Returns the reference designator value of the connection point to which the to-end of the wire is connected.
Elec_ToContactPartNumber Type: String

Returns the part number of the contact in the device cavity to which the to-end of the wire is connected.
Elec_ToDevice Type: String

Returns the reference designator value of the device to which the to-end of the wire is connected.
IsSingleInBundleSegment Type: Boolean

Is True when the wire route follows at least one bundle segment containing only this wire.
Elec_FromConnectionPointName Type: String
Returns the name/part number of the From connection point.
 
Elec_ToConnectionPointName Type: String
Returns the name/part number of the To connection point.