PathArrangementBuilder Class¶
-
class
NXOpen.Routing.Electrical.PathArrangementBuilder¶ Bases:
NXOpen.BuilderBuilder class to manage Path Arrangements.
To create a new instance of this class, use
NXOpen.Routing.RouteManager.CreatePathArrangementBuilder()New in version NX10.0.3.
Properties¶
| Property | Description |
|---|---|
| HarnessPartOccurrence | Returns or sets the harness component in the context of the part that was used to create the extracted port. |
| PrototypePort | Returns or sets the prototype of the extract port that is used as the reference port. |
| PrototypePortPartOccurrence | Returns or sets the component part that contains the prototype of the extract port that is used as the reference port. |
| ReferencePort | Returns or sets the port on which the offset is based when defining the path arrangement. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| ClearHarnessData | Clears the builder data associated with stored harness, namely the ReferencePort and * the HarnessOccurrence, along with internal data. |
| Commit | Commits any edits that have been applied to the builder. |
| DeletePathArrangement | Deletes path arrangement through builder |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| EstablishPathArrangement | Retrieves the Path Arrangement object based on the data stored in the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| InitializeBuilderFromArrangedPort | Initializes builder from arranged port |
| SetPathArrangementOrigin | Sets a new origin for the point on the harness path. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
HarnessPartOccurrence¶
-
PathArrangementBuilder.HarnessPartOccurrence¶ Returns or sets the harness component in the context of the part that was used to create the extracted port.
-------------------------------------Getter Method
Signature
HarnessPartOccurrenceReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
HarnessPartOccurrenceParameters: partOcc ( NXOpen.Assemblies.Component) –New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
PrototypePort¶
-
PathArrangementBuilder.PrototypePort¶ Returns or sets the prototype of the extract port that is used as the reference port.
-------------------------------------Getter Method
Signature
PrototypePortReturns: Return type: NXOpen.Routing.PortNew in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
PrototypePortParameters: port ( NXOpen.Routing.Port) –New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
PrototypePortPartOccurrence¶
-
PathArrangementBuilder.PrototypePortPartOccurrence¶ Returns or sets the component part that contains the prototype of the extract port that is used as the reference port.
-------------------------------------Getter Method
Signature
PrototypePortPartOccurrenceReturns: Return type: NXOpen.Assemblies.ComponentNew in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
PrototypePortPartOccurrenceParameters: partOcc ( NXOpen.Assemblies.Component) –New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
ReferencePort¶
-
PathArrangementBuilder.ReferencePort¶ Returns or sets the port on which the offset is based when defining the path arrangement.
The port property can be either a port or a port occurrence.
-------------------------------------Getter Method
Signature
ReferencePortReturns: Return type: NXOpen.TaggedObjectNew in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Setter Method
Signature
ReferencePortParameters: port ( NXOpen.TaggedObject) –New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
Method Detail¶
ClearHarnessData¶
-
PathArrangementBuilder.ClearHarnessData¶ Clears the builder data associated with stored harness, namely the ReferencePort and * the HarnessOccurrence, along with internal data.
Note that the PrototypePortPartOccurrence * and the PrototypePort are not cleared with this call.
Signature
ClearHarnessData()New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
DeletePathArrangement¶
-
PathArrangementBuilder.DeletePathArrangement¶ Deletes path arrangement through builder
Signature
DeletePathArrangement()New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
EstablishPathArrangement¶
-
PathArrangementBuilder.EstablishPathArrangement¶ Retrieves the Path Arrangement object based on the data stored in the builder.
If one does not yet exist, a new one will be created. The retrieved object is stored internally in the biuilder. This method is called after setting HarnessPartOccurrence and ReferencePort
Signature
EstablishPathArrangement()New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
InitializeBuilderFromArrangedPort¶
-
PathArrangementBuilder.InitializeBuilderFromArrangedPort¶ Initializes builder from arranged port
Signature
InitializeBuilderFromArrangedPort(port)Parameters: port ( NXOpen.Routing.Port) – Routing port whose associated path arrangement object is used to populate the data in the builderNew in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
SetPathArrangementOrigin¶
-
PathArrangementBuilder.SetPathArrangementOrigin¶ Sets a new origin for the point on the harness path.
This point should be in the context of the current root part.
Signature
SetPathArrangementOrigin(point)Parameters: point ( NXOpen.Point3d) – Origin of the path arrangement in the context of the root part.New in version NX10.0.3.
License requirements: routing_base (“Routing Basic”)
Validate¶
-
PathArrangementBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.