Electrical Feature Types

The Quality Rules Reuse language is designed to create expert checks and rules relying on types and functions. You can describe electrical features by defining the knowledge ware attributes.

This page gives you information about the electrical package supported by Quality Rules Reuse. This package can be accessed via the object browser. The 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 segments with a diameter greater than a specified value.

Some electrical attributes can be modified by the user through the Quality Rules Reuse app. To check which attributes are readable and /or writable, see the Right access cells in the tables below.

Note: For more information about metadata types (PLM types from the PLMElectricalDictionary), see Electrical Types and Equipment Types in the Configuration and Development: 3DEXPERIENCE Open: Unified Typing Configuration Tools: Unified Typing Reference Dictionary Guide.

Activate the ElectricalMeasure package.

  • Select Me > Preferences > General > Parameters and Measures.
  • Select the Knowledge Environment tab.
  • Select Electrical Functions from the list of available packages and click the Down arrow to load this package.
  • Click OK to validate.

This page discusses:

Branch

This type describes an electrical feature of branch type that you create when you click Branch from the Branch section of the action bar, in the Electrical 3D Part Design app.

For more information, see Electrical 3D Part Design User's Guide.

Inheritance Path

ObjectType
 Feature
  Branch

Attributes

Name Type Comment Access rights
BendRadius_OK Boolean Returns True if the branch real bend radius is greater than the Elec_BendRadius attribute. Read only
ComputedBendRadius LENGTH Output data defining the actual minimum bend radius value computed on the segment curve. Read only
Elec_BendRadius LENGTH Input data defining the bend radius value that corresponds to the minimum bend radius of the branch curve. Read/Write
Elec_BranchSlack Real Input data defining the percentage of distributed slack along the branch.

This attribute induces the value of the Elec_Length attribute.

Read/Write
Elec_ConstructionMode String Defines the segment creation mode. Four modes exist:

  • Slack: Elec_Length is not valuated.
  • Bend: Elec_BranchSlack and Elec_Length are not valuated.
  • Length: Elec_BranchSlack is not valuated.
  • StraightBend: Elec_BranchSlack and Elec_Length are not valuated.

Read/Write
Elec_EhfStatusShape EleFlattenStatusType Defines the flatten status of a branch. Four status exist:
  • CanBeFlattened
  • CannotBeFlattened
  • AlreadyFlattened
  • RigidFlattened
Read only
Elec_Length LENGTH Defines the length when Elec_ConstructionMode is Slack or Bend.

Returns the length when Elec_ConstructionMode is Length.

Read/Write
IsAFlatCable Boolean Is True if the branch curve is a flat cable. Read only
IsElectricalCurve Boolean Is True if the branch curve is built using an electrical algorithm or is defined on an external curve.

Is False if the branch curve is switched to a standard spline.

Read only
IsNotCollapsed Boolean Is True if there is no self-intersecting geometry. Read only

Methods

The following methods are associated with this type:

BranchPoint

This type describes an electrical feature of branch point that you create when you select Add Branch Point in the Segments Definition dialog box accessible from the Branch Definition window (available from the Branch section of the action bar when you click Branch , in the Electrical 3D Part Design app).

For more information, see Electrical 3D Part Design User's Guide.

Inheritance Path

ObjectType
 Feature
  BranchPoint

ConductorGroup

This type describes an electrical feature of Conductor Group type that you create when you click Conductor Group from the Conductors section of the action bar, in the Electrical 3D Design app.

For more information, see Electrical 3D Design User's Guide.

Inheritance Path

ObjectType
 Feature
  ConductorGroup

Attributes

Name Type Comment Access rights
Elec_Bend_Radius LENGTH Defines the bend radius. Read/Write
Elec_Color String Defines the color of the conductor group. Read/Write
Elec_Diameter LENGTH Defines the conductor group diameter. Read/Write
Elec_Length LENGTH Defines the length of conductor group. Read only
Elec_LinkedInstance VPMInstance Read only
Elec_Sep_Code String Defines the separation code of the conductor group used by the algorithm to find out the conductor group route. Read/Write
Elec_SubType String Defines the conductor group subtype. Read/Write
Elec_WireGroup_Type String Returns the type of conductor group. Possible types are Shielded and Generic. Read only
Elec_Wire_Length_Coeff Real Returns a coefficient for conductors in a conductor group. When computing conductor length, this coefficient takes into account the twisting of conductors (conductor length = conductor group length x conductor length coefficient). It can be greater than or equal to 1. Read/Write
SpecificationId String Returns the specification Id. Read only
SpecificationPartNumber String Returns the specification part number. Read only

Example

/* Check  created by CVV 8/18/2011 */ 
Let Instance (VPMInstance)
Let Reference (VPMReference)
Let WireGrpRef (PLMEleRefWireGroup)
Let sMessage (STRING)
Let sInst (STRING)
Let sPartNum (STRING)
Let sType (STRING)

set sType = "Unset"
set sInst = "Unset"
set sPartNum = "Unset"
set sMessage = ConductorGrp.Name
if( (sMessage == "ConductorGroup01") or (sMessage == "Conductor04") )
{
      set Instance = ConductorGrp.Elec_LinkedInstance
      if( NULL <> Instance)
{
            set sInst = Instance.V_Name (Title)
	          	set Reference = Instance.Reference
		          if( NULL <> Reference)
            {
	                 set sPartNum = Reference.V_Name (Title)
                  set WireGrpRef = Reference
                  if( NULL <> WireGrpRef)
                  {
		                    		set sType = WireGrpRef.V_Elec_WireGroup_Type
                  }
         			}        
		    }  
}	
sMessage = sMessage + " Linked to = " + sInst + "( Part Number = " + sPartNum + " Type = " + sType + ") "
Message (sMessage)
Expected Messsage : ConductorGroup01
"ConductorGroup01 Linked to = ConductorGroup01 ( Part Number = ConductorGroupRef1-1 + Type = Generic) "
Expected Messsage : ConductorGroup02
"ConductorGroup02 Linked to = Unset( Part Number = Unset + Type = Unset) "

Conductor

This type describes an electrical feature of conductor type that you create when you insert Conductor Reference in the Electrical 3D Design app via the Add > New menu of the top bar.

For more information, see Electrical 3D Design User's Guide.

Inheritance Path

ObjectType
 Feature
  Conductor

Attributes

Name Type Comment Access rights
Elec_Bend_Radius LENGTH Defines the bend radius. Read/Write
Elec_Catalog String Defines the catalog from which the conductor is selected. Read only
Elec_Color String Defines the color of the conductor. Read/Write
Elec_Diameter LENGTH Defines the conductor diameter. Read/Write
Elec_FromConnectionPoint String Returns the reference designator value of the connection point to which the from-end of the conductor is connected. Read only
Elec_FromContactPartNumber String Returns the part number of the contact in the device cavity to which the from-end of the conductor is connected. Read only
Elec_FromDevice String Returns the reference designator value of the device to which the from-end of the conductor is connected. Read only
Elec_FullConnected Boolean Is True if both conductor extremities are connected. Read only
Elec_IsNetworkConnex Boolean Is True if a route exists between whatever nodes only using the network connected branches. Read only
Elec_IsRouted Boolean Is True if the conductor is routed. Read only
Elec_Length LENGTH Defines the conductor length. Read only
Elec_Line_Weight Real Defines the conductor linear mass. Read/Write
Elec_LinkedInstance VPMInstance Read only
Elec_OutsideDiameter LENGTH Defines the conductor outside diameter. Read/Write
Elec_Sep_Code String Defines the separation code of the conductor used by the algorithm to find out the conductor route. Read/Write
Elec_Signal_Id String Defines the identifier of the signal used during the conductor routing. Read/Write
Elec_SubType String Defines the conductor subtype. Read/Write
Elec_ToConnectionPoint String Returns the reference designator value of the connection point to which the to-end of the conductor is connected. Read only
Elec_ToContactPartNumber String Returns the part number of the contact in the device cavity to which the to-end of the conductor is connected. Read only
Elec_ToDevice String Returns the reference designator value of the device to which the to-end of the conductor is connected. Read only
Elec_WireGroup ConductorGroup Returns the parent Conductor Group. Read only
IsSingleInBundleSegment Boolean Is True when the conductor route follows at least one segment containing only this conductor. Read only
RoutedThrough List Returns the elements in the path of route. Read only
SpecificationId String Returns the specification Id. Read only
SpecificationPartNumber String Returns the specification part number. Read only

Methods

The following methods are associated with this type:

Example

/* Check  created by CVV 8/18/2011 */ 
Let Instance (VPMInstance)
Let Reference (VPMReference)
Let WireRef (PLMEleRefWire)
Let sMessage (STRING)
Let sInst (STRING)
Let sPartNum (STRING)

set sInst = "Unset"
set sPartNum = "Unset"
set sMessage = Conductor.Name
if( (sMessage == "Conductor01") or (sMessage == "Conductor04")Elec3DBackShell )
{
      set Instance = Conductor.Elec_LinkedInstance
	     if( NULL <> Instance)  
      {
            set sInst = Instance.V_Name (Title)
		          set Reference = Instance.Reference
		          if( NULL <> Reference)
            {
		               	set sPartNum = Reference.V_Name (Title)
		          }
 	    }
}  
sMessage = sMessage + " Linked to = " + sInst + "( Part Number = " + sPartNum + ") "	        
Message (sMessage)

Expected Messsage : Conductor01
"Conductor01 Linked to = Conductor01 ( Part Number = ConductorRef1-1) "

Expected Messsage : Conductor04
"Conductor04 Linked to = Unset ( Part Number = Unset) "

EleFlattenStatusType

This type describes an electrical type for the Branch feature that defines the flatten status of a branch.

Inheritance Path

ObjectType
 Literal
  Enumere
   EleFlattenStatusType

Enumerated Values

Value NLS Value Comment
CanBeFlattened Can Be Flattened None
CannotBeFlattened Cannot Be Flattened None
AlreadyFlattened Already Flattened None

Elec3DCableOccurrence

A type that identifies an electrical cable occurrence.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   Elec3DCableOccurrence

Elec3DConductorEnd

A type that identifies a conductor in the graph's network. This object includes the connected device and the cavity. It may include a backshell device if this device belongs to the conductor route.

Inheritance Path

ObjectType
 Feature
  Elec3DConductorEnd

Methods

The following methods are associated with this type:

ConductorRouteStatus

Inheritance Path

ObjectType
 Literal
  Enumere
   ConductorRouteStatus

Enumerated Values

Value NLS Value Comment
Not_Routed Not Routed -
Routed Routed -
Broken Broken -
Not_In_Session Not In Session -

ConductorValidationStatus

Inheritance Path

ObjectType
 Literal
  Enumere
   ConductorValidationStatus

Enumerated Values

Value NLS Value Comment
Not_Validated Not Validated -
Fully_Validated Fully Validated -
Partially_Validated Partially Validated -
In_Revision In Revision -

CuttingLengthMode

Inheritance Path

ObjectType
 Literal
  Enumere
   CuttingLengthMode

Enumerated Values

Value NLS Value Comment
Automatic Automatic -
Manual Manual -

Elec3DDeviceNode

A type that identifies a specialized node in the graph's network. This object includes a device occurrence connected to a segment extremity or to a segment by a distant connection and through an electrical port.

Inheritance Path

ObjectType
 Feature
  Elec3DNetworkNode
   Elec3DDeviceNode

Method

The following method is associated with this type: Elec3DDeviceNode.GetComponents.

Elec3DDeviceRouteElement

A type that identifies an Elec3DRouteElement defined by a Device (ProductOccurence) and an Elec3DSegmentConnectionPoint or an Elec3DCavity.

For more information, see Elec3DRouteElement.

Inheritance Path

ObjectType
 Feature
  Elec3DRouteElement
   Elec3DDeviceRouteElement

Function

The function CreateDeviceRouteElement is associated with this type.

Elec3DJunctionDeviceNode

A type that identifies a specialized node in the graph's network. This object represents the junction (electrical device) that can belong to the path of a cable's route.

Inheritance Path

ObjectType
 Feature
  Elec3DNetworkNode
   Elec3DJunctionDeviceNode

Methods

The following methods are associated with this type: Elec3DNetworkArc.GetNodes, SegmentExtremity.GetNode.

Functions

The following functions are associated with this type: ListElectricalConnectedObjects, ListConnectedNodes, GetConnectedArcs.

Elec3DJunctionNode

A type that identifies a specialized node in the graph's network. This object represents the connection point of several segments at a branch point or at a branch extremity.

Inheritance Path

ObjectType
 Feature
  Elec3DNetworkNode
   Elec3DJunctionNode

Method

The following method is associated with this type: Elec3DJunctionNode.GetComponents.

Elec3DNetworkArc

A type that identifies an arc in the graph's network. This linear object links two nodes and corresponds to a segment, a subpart of a segment, or a distant connection.

Inheritance Path

ObjectType
 Feature
  Elec3DNetworkArc

Attributes

Name used in EKL NLS Name Type Comment
SegregationCode Segregation code String -

Methods

The following methods are associated with this type:

Elec3DPointRouteElement

A type that identifies an Elec3DRouteElement defined by a point.

For more information, see Elec3DRouteElement.

Inheritance Path

ObjectType
 Feature
  Elec3DRouteElement
   Elec3DPointRouteElement

Function

The function CreatePointRouteElement is associated with this type.

Elec3DProxyNode

A type that identifies a specialized node in the graph's network. This object represents the connection point of a proxy branch point or a distant connection on a segment.

Inheritance Path

ObjectType
 Feature
  Elec3DNetworkNode
   Elec3DProxyNode

Method

The following method is associated with this type: Elec3DProxyNode.GetComponents.

Elec3DSpliceNode

A type that identifies a specialized node in the graph's network. This object includes a splice device connected to a branch point and the segment extremities connected to the branch point.

Inheritance Path

ObjectType
 Feature
  Elec3DNetworkNode
   Elec3DSpliceNode

Method

The following method is associated with this type: Elec3DSpliceNode.GetComponents.

Elec3DSupportRouteElement

A type that identifies an Elec3DRouteElement defined by a Support (ProductOccurence) and a section's index.

For more information, see Elec3DRouteElement.

Inheritance Path

ObjectType
 Feature
  Elec3DRouteElement
   Elec3DSupportRouteElement

Function

The function CreateSupportRouteElement is associated with this type.

ElecCircularProfile

This type identifies the profile of a segment of Circle type.

Inheritance Path

ObjectType
 Feature
  ElecProfile
   ElecCircularProfile

Attributes

Name Type Comment Access rights
Elec_Diameter LENGTH Identifies the diameter of the circular profile. Read only

Method

The Segment.GetProfile() method is associated with this type.

ElecConductorOccurrence

A type that identifies Elec3DConductorOccurrence and Elec3DConductorGroupOccurrence. To know more, see Elec3DConductor.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   ElecConductorOccurrence

ElecDimPath

This type describes an electrical feature that defines the dimension along a path in an electrical network.

Inheritance Path

ObjectType
 Feature
  ElecDimPath

Attributes

Name Type Comment Access rights
Elec_Length LENGTH None Read only
_AlgoError String None Read only

ElecEllipticalProfile

This type identifies the profile of a segment of Ellipse type.

Inheritance Path

ObjectType
 Feature
  ElecProfile
   ElecEllipticalProfile

Attributes

Name Type Comment Access rights
Elec_MinorAxis LENGTH Identifies the magnitude of the minor axis of the elliptical profile. Read only
Elec_MajorAxis LENGTH Identifies the magnitude of the major axis of the elliptical profile. Read only

Method

The Segment.GetProfile() method is associated with this type.

ElecItinerary

This type provides the itinerary information of a cable route.

Inheritance Path

ObjectType
 Feature
  ElecItinerary

Attributes

Name Type Comment
Elec_ItineraryElements List -
Elec_ItineraryLengths List -

Methods

The following method is associated with this type:

ElecPartOccurrence

A type that identifies all electrical device occurrences whose super type is ElecPartOccurrence. To know more, see ElecPart.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   ElecPartOccurrence

ElecProfile

This type identifies the profile type of a segment.

Inheritance Path

ObjectType
 Feature
  ElecProfile

Available subtypes are: ElecCircularProfile, ElecEllipticalProfile, ElecRectangularProfile, and ElecTruncatedRectangularProfile.

Attributes

Name Type Comment Access rights
Elec_ProfileType String Values can be NoProfile, Circle, Ellipse, Rectangle, or Truncated Rectangle. Read only
Elec_ProfileArea Area None Read only

Method

The Segment.GetProfile() method is associated with this type.

ElecRectangularProfile

This type identifies the profile of a segment of Rectangle type.

Inheritance Path

ObjectType
 Feature
  ElecProfile
   ElecRectangularProfile

Attributes

Name Type Comment Access rights
Elec_Width LENGTH Identifies the magnitude of the width of the rectangular profile. Read only
Elec_Height LENGTH Identifies the magnitude of the height of the rectangular profile. Read only

Method

The Segment.GetProfile() method is associated with this type.

ElecRoute

A type that identifies the route of an electrical cable.

Inheritance Path

ObjectType
 Feature
  ElecRoute

Attributes

Name Type Comment
Elec_ValidatedItinerary ElecItinerary -
Elec_ValidatedLength LENGTH The validated length of the cable's route.
Elec_ValidatedRouteStatus RouteStatus The status can be:
  • Fully validated
  • In Revision
  • Not Validated
Elec_ValidationStatus RouteValidationStatus The status can be:
  • Not Routed
  • Routed
  • Broken

ElecRouteImpactInfo

This type identifies the impacts on the route of an electrical cable.

Inheritance Path

ObjectType
 Feature
  ElecRouteImpactInfo

Attributes

Name Type Comment
Elec_ComputedItinerary ElecItinerary Computed itinerary elements and computed itinerary lengths of the current cable route.
Elec_ComputedLength LENGTH Computed length of the current cable route.
Elec_ComputedRouteStatus RouteStatus Computed route status of current cable route.
Elec_ImpactDetails String Details of the impact.

Information provided in Elec_ImpactDetails is exported in the report.
Elec_IsImpacted Integer
  • False (0): the cable is not impacted.
  • True (1): the cable is impacted.
Elec_Route ElecRoute Current route of the cable under analysis

ElecTruncatedRectangularProfile

This type identifies the profile of a segment of Truncated Rectangle type.

Inheritance Path

ObjectType
 Feature
  ElecProfile
   ElecTruncatedRectangularProfile

Attributes

Name Type Comment Access rights
Elec_MajorWidth LENGTH Identifies the magnitude of the major width of the truncated rectangular profile. Read only
Elec_MajorHeight LENGTH Identifies the magnitude of the major height of the truncated rectangular profile. Read only
Elec_MinorWidth LENGTH Identifies the magnitude of the minor width of the truncated rectangular profile. Read only
Elec_MinorHeight LENGTH Identifies the magnitude of the minor height of the truncated rectangular profile. Read only
Elec_CornerPosition String Identifies the position of the truncated corner.

Values can be TOP_LEFT, TOP_RIGHT, BOTTOM_LEFT, or BOTTOM_RIGHT.

Read only

Method

The Segment.GetProfile() method is associated with this type.

Electrical3DSystemOccurrence

A type that identifies an electrical physical system occurrence. To know more, see Electrical3DSystem.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   Electrical3DSystemOccurrence

ElectricalBranchGeometryOccurrence

A type that identifies an electrical branch geometry occurrence. To know more, see ElectricalBranchGeometry.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   ElectricalBranchGeometryOccurrence

ElectricalGeometryOccurrence

A type that identifies an electrical geometry occurrence. To know more, see ElectricalGeometry.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   ElectricalGeometryOccurrence

Fold

This type describes an electrical feature of fold type that you create when you click Fold from the Branch section of the action bar, in the Electrical 3D Part Design app.

For more information, see Electrical 3D Part Design User's Guide.

Inheritance Path

ObjectType
 Feature
  Visualizable
   Fold

Attributes

Name Type Comment Access rights
Fold_Angle ANGLE None Read only
Fold_BendRadius LENGTH None Read only
Fold_ConductorsExtraLength LENGTH None Read only
Fold_Radius LENGTH None Read only
IsAngleWithinUserDefinedRange Boolean Returns Boolean to know if the fold angle is inside the fold angle range defined in the Me > Preferences. Read only
IsInterferingWithPointsOnBranch Boolean Returns Boolean to know if a construction element of the branch is interfering with the fold (inside the fold area). Read only

GreenLine

This type describes an electrical feature of greenline type that you create when you select Green Line from the Protection section of the action bar, in the Electrical 3D Part Design app.

For more information, see Electrical 3D Part Design User's Guide.

Inheritance Path

ObjectType
 Feature
  GreenLine

InternalAdaptiveProtection

This type describes a protective covering of adaptive diameter type that you create when you select Protective Covering from the Branch section of the action bar, in the Electrical 3D Design app. The adaptive protection is then placed using Protective Covering from the Protection section of the action bar, in the Electrical 3D Part Design app.

For more information, see Electrical 3D Design and Electrical 3D Part Design User's Guides.

Inheritance Path

ObjectType
 Feature
  Visualizable
   InternalProtection
    InternalAdaptiveProtection

InternalCorrugatedProtection

This type describes a protective covering of corrugated tube type that you create when you select Protective Covering from the Branch section of the action bar, in the Electrical 3D Design app. The corrugated protection is then placed using Protective Covering from the Protection section of the action bar, in the Electrical 3D Part Design app.

For more information, see Electrical 3D Design and Electrical 3D Part Design User's Guides.

Inheritance Path

ObjectType
 Feature
  Visualizable
   InternalProtection
    InternalCorrugatedProtection

Attributes

Name Type Comment Access rights
Elec_Bend_Radius LENGTH None Read/Write

InternalFixedProtection

This type describes a protective covering of fixed diameter type that you create when you select Protective Covering from the Branch section of the action bar, in the Electrical 3D Design app. The fix diameter protection is then placed using Protective Covering from the Protection section of the action bar, in the Electrical 3D Part Design app.

For more information, see Electrical 3D Design and Electrical 3D Part Design User's Guides.

Inheritance Path

ObjectType
 Feature
  Visualizable
   InternalProtection
    InternalFixedProtection

Attributes

Name Type Comment Access rights
Elec_Bend_Radius LENGTH None Read/Write

InternalProtection

This type describes an electrical feature of protective covering type that you create that you create when you select Protective Covering from the Branch section of the action bar, in the Electrical 3D Design app. The fixed diameter covering is then placed using Protective Covering from the Protection section of the action bar, in Electrical 3D Part Design app.

For more information, see Electrical 3D Design and Electrical 3D Part Design User's Guides.

Inheritance Path

ObjectType
 Feature
  Visualizable
   InternalProtection

Attributes

Name Type Comment Access rights
CoveredBundleSegments List Returns the list of segments covered by the protective covering. Read only
Elec_External_Reference String None Read/Write
Elec_Inner_Diameter LENGTH Defines the inner diameter.

For adaptive diameter and tape coverings, this attribute is read-only.

Read/Write
Elec_Length LENGTH Defines the length. Read/Write
Elec_Line_Type Integer Defines the line type. Read/Write
Elec_Line_Weight Real Defines the linear mass used for the flattened representation. Read/Write
Elec_Preferred_Length LENGTH Defines the preferred length of the protection covering. Read/Write
Elec_Ref_PartNumber String Defines the reference part number. Read/Write
Elec_Sub_Type String Defines the subtype. Read/Write
Elec_Text String Defines the text used as an annotation. Read/Write
Elec_Thickness LENGTH None Read/Write

Methods

The following methods are associated with this type:

InternalTapeProtection

This type describes a protective covering of tape type that you create when you select Protective Covering from the Branch section of the action bar, in the Electrical 3D Design app. The tape is then placed using Protective Covering from the Protection section of the action bar, in the Electrical 3D Part Design app.

For more information, see Electrical 3D Design and Electrical 3D Part Design User's Guides.

Inheritance Path

ObjectType
 Feature
  Visualizable
   InternalTapeProtection

Attributes

Name Type Comment Access rights
Elec_Bend_Radius_Delta LENGTH Defines the bend radius value, which corresponds to the minimum bend radius of the tape curve.

This value takes into account the segment and tape bend radius rule and ends up to an increased rigidity due to the tape.

Read only
Elec_Covering_Length LENGTH Defines the length along the segment center curve covered. Read/Write
Elec_Number_Layer Integer Defines the number of layers applied over the segment. Read/Write
Elec_Tape_Thickness LENGTH Defines the thickness. Read only
Elec_Tape_Width LENGTH Defines the width. Read only
Elec_Taping_Angle ANGLE Defines the taping angle. Read/Write
Elec_Total_Tape_Length LENGTH Defines the tape length; depends on the taping angle, the covered length and the number of layers. Read only
Elec_Total_Thickness LENGTH Defines the total tape thickness; depends on the overlap due to the taping angle and the number of layers. Read only

MountingEquipmentOccurrence

A type that identifies a mounting equipment occurrence. To know more, see MountingEquipment.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   MountingEquipmentOccurrence

RouteRuleSet

A type that identifies a roule rule set. This set comprises the information defining the path of a cable's route.

Inheritance Path

ObjectType
 Feature
  RouteRuleSet

Attributes

Name Type Comment
Elec_AreCompatibilityTablesUsed Boolean -
Elec_AreConstraintsUsed Boolean -
Elec_BusinessRulesNotUsed List -
Elec_BusinessRulesUsed List -
Elec_FillingRatioUsed String -
Elec_IsAlternateRoute Boolean -
Elec_ProjectFillingRatio Real -
Elec_RoutingActionUsed String -
Elec_UserFillingRatio Real -
Elec_IsPriorityRouteRuleActive Boolean -

RouteStatus

This type describes the route status of a cable.

Inheritance Path

ObjectType
 Literal
  Enumere
   RouteStatus

Enumerated Values

Value NLS Value Comment
Not_Routed Not Routed -
Routed Routed -
Broken Broken -

RouteValidationStatus

This type describes the validation status of a cable's route.

Inheritance Path

ObjectType
 Literal
  Enumere
   RouteValidationStatus

Enumerated Values

Value NLS Value Comment
Not_Validated Not Validated -
Fully_Validated Fully Validated -
In_Revision In Revision -

Segment

This type describes an electrical feature of segment type that you create when you select either Branch from the Branch section of the action bar in the Electrical 3D Part Design app or Electrical Branch Geometry from the Branch section of the action bar in the Electrical 3D Part Design.

For more information, see Electrical 3D Design and Electrical 3D Part Design User's Guides.

Inheritance Path

ObjectType
 Feature
  Visualizable
   Segment

Attributes

Name Type Comment Access rights
DiameterComputedFromWires LENGTH Gives the diameter of the branch computed from the wires routed through this branch. Read only
Elec_Bend_Radius LENGTH Returns the bend radius value that corresponds to the minimum bend radius of the segment curve. Same value as the branch bend radius. Read only
Elec_Bend_Radius_OK Boolean Returns True if the segment real bend radius is greater than the Elec_Bend_Radius attribute. Read only
Elec_Diameter LENGTH Defines the segment diameter. Read/Write
Elec_Dimension1 LENGTH

For non circular profiles, returns the first dimension, that is the height for rectangular profile and the major axis for elliptical profile.

For circular profiles, returns the diameter of the segment.

Read only
Elec_Dimension2 LENGTH

For non circular profiles, returns the second dimension, that is the width for rectangular profile and the minor axis for elliptical profile.

For circular profiles, it is 0.0.

Read only
Elec_FullConnected Boolean Is True if both segment extremities are connected. Read only
Elec_Length LENGTH Gives the segment length. Read only
Elec_Length_Tolerance_Apply Boolean None Read only
Elec_Min_Bend_Radius LENGTH Output data defining the actual minimum bend radius value computed on the segment curve. Read only
Elec_NumberOfRoutedConductors Integer None Read only
Elec_ProfileType String

Returns the type of profile for the segment. Possible string types are CIRCLE, ELLIPSE, RECTANGLE, or TRUNCATED RECTANGLE.

Read only
Elec_Segreg String Defines the segment separation code used by the routing algorithm. Read/Write
Elec_SubType String Defines the segment subtype. Read/Write
Elec_TotalWeight MASS None Read only
IncludedWires List Returns a list of wires routed inside the segment. Read only

Example 1

Let sName (STRING)
Let result (BOOLEAN)
Let bFromStart (BOOLEAN)
Let FillingRatio (REAL)
Let startOffset (REAL)
Let endOffset (REAL)
Let sMessage (STRING)
Let index (INTEGER)
Let sNewLine (STRING)

set endOffset = 0.0
set bFromStart = true
set sName = Segment.Name
set sNewLine = "| "
set sMessage = ""
set sMessage = sMessage + "For Segment = " + sName + ":" +  sNewLine 

/* Computation of filling ratio of complete segemnt*/
result = Segment->Elec_FillingRatio(FillingRatio, bFromStart, startOffset)
set sMessage = sMessage + "Filling ratio of segment = " + ToString(FillingRatio) + sNewLine 

/* Computation of segment filling ratio at one section i.e. 0.5 */
set startOffset = 0.5
result = Segment->Elec_FillingRatio(FillingRatio, bFromStart, startOffset)
set sMessage = sMessage + "Filling ratio at 0.5 = " + ToString(FillingRatio) + sNewLine 

/* Computation of segment filling ratio at between two sections*/
set index = 1
for index while index <= 5
{

      set startOffset = endOffset
      set endOffset = startOffset + 0.2
      result = Segment->Elec_FillingRatio(FillingRatio, bFromStart, startOffset, endOffset)
      set sMessage = sMessage + " Filling ratio between " + ToString(startOffset) + " and " + ToString(endOffset) + " = " + ToString(FillingRatio) +sNewLine
                                                                                              
}
Message (sMessage)

Example 2

Let sName (STRING)
Let result (BOOLEAN)
Let bFromStart (BOOLEAN)
Let FillingRatio (REAL)
Let startOffset (REAL)
Let endOffset (REAL)
Let sMessage (STRING)
Let index (INTEGER)
Let sNewLine (STRING)

set endOffset = 0.0
set bFromStart = true /* From End extremity of Segment */
set sName = Segment.Name
set sNewLine = "| "
set sMessage = ""
set sMessage = sMessage + "For Segment = " + sName + ":" +  sNewLine

/* Computation of filling ratio of complete segemnt*/
result = Segment->Elec_FillingRatio(FillingRatio, bFromStart, startOffset)
set sMessage = sMessage + "Filling ratio of segment = " + ToString(FillingRatio) + sNewLine

/* Computation of segment filling ratio at one section i.e. 0.5 */
set startOffset = 0.5
result = Segment->Elec_FillingRatio(FillingRatio, bFromStart, startOffset)
set sMessage = sMessage + "Filling ratio at 0.5 = " + ToString(FillingRatio) + sNewLine 

/* Computation of segment filling ratio at between two sections*/
set index = 1
for index while index <= 5
{

      set startOffset = endOffset
      set endOffset = startOffset + 0.2
      result = Segment->Elec_FillingRatio(FillingRatio, bFromStart, startOffset, endOffset)
	     set sMessage = sMessage + " Filling ratio between " + ToString(startOffset) + " and " + ToString(endOffset) + " = " + ToString(FillingRatio) +sNewLine 
}
Message (sMessage)

Example 3

let Diameter(LENGTH)
let Dimension1(LENGTH)
let Dimension2(LENGTH)
let SegmentProfile(STRING)

SegmentProfile = Obj.Elec_ProfileType
Diameter = Obj.Elec_Diameter
Dimension1 = Obj.Elec_Dimension1
Dimension2 = Obj.Elec_Dimension2

Notify("Segment = #, Profile of the Segment : #, Dimension1 =  #, Dimension2 = #", Obj.Name, SegmentProfile, Dimension1, Dimension2)

SegmentExtremity

This type describes an electrical feature of segment extremity type that is created when you create a segment.

For more information, see Electrical 3D Design and Electrical 3D Part Design User's Guides.

Inheritance Path

ObjectType
 Feature
  SegmentExtremity

Attributes

Name Type Comment Access rights
Elec_Number Integer None Read only
Elec_Parent Segment None Read only
IsGeoAndElecConnectionSame Boolean None Read only
NumberOfConnectedDevices Integer None Read only
NumberOfConnectedSegments Integer None Read only

SharedEquipmentPartOccurrence

A type that identifies an equipment part occurrence.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   SharedEquipmentPartOccurrence

SharedSupportPartOccurrence

A type that identifies a support part occurrence.

Inheritance Path

ObjectType
 Feature
  ProductOccurrence
   SharedSupportPartOccurrence