PlacementSolutionsBuilder Class¶
-
class
NXOpen.Routing.PlacementSolutionsBuilder¶ Bases:
NXOpen.BuilderTo create a new instance of this class, use
NXOpen.Routing.RouteManager.CreatePlacementSolutionsBuilder()New in version NX7.5.0.
Methods¶
| Method | Description |
|---|---|
| ApplyConstraintsAndClear | Commit the solution and apply constraints if needed. |
| ApplyPortRotation | Applies a rotation to the component about the axis of the port being used for placement. |
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| FirstSolution | Cycle to the first solution. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetNumberOfSolutions | Returns the total number of solutions based on the placement object. |
| GetObject | Returns the object currently being edited by this builder. |
| GetSolutionIndex | Returns the current index of the solution. |
| InitializePlacementData | Initialize Placement Data |
| NextSolution | Cycle to the next solution. |
| PreviousSolution | Cycle to the previous solution |
| 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. |
Method Detail¶
ApplyConstraintsAndClear¶
-
PlacementSolutionsBuilder.ApplyConstraintsAndClear¶ Overloaded method ApplyConstraintsAndClear
ApplyConstraintsAndClear()ApplyConstraintsAndClear(lockEngagement, lockRotation)ApplyConstraintsAndClear(lockEngagement, lockRotation, fixPart)
-------------------------------------Commit the solution and apply constraints if needed.
Signature
ApplyConstraintsAndClear()New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Commit the solution and apply constraints if needed.
Signature
ApplyConstraintsAndClear(lockEngagement, lockRotation)Parameters: - lockEngagement (bool) – Lock engagement if applicable.
- lockRotation (bool) – Lock Rotation if applicable.
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
-------------------------------------Commit the solution and apply constraints if needed.
Signature
ApplyConstraintsAndClear(lockEngagement, lockRotation, fixPart)Parameters: - lockEngagement (bool) – Lock engagement if applicable.
- lockRotation (bool) – Lock Rotation if applicable.
- fixPart (bool) – Fix Part if applicable.
New in version NX7.5.2.
License requirements: routing_base (“Routing Basic”)
-------------------------------------
ApplyPortRotation¶
-
PlacementSolutionsBuilder.ApplyPortRotation¶ Applies a rotation to the component about the axis of the port being used for placement.
Signature
ApplyPortRotation(angle)Parameters: angle (float) – Angle to apply. New in version NX7.5.2.
License requirements: routing_base (“Routing Basic”)
FirstSolution¶
-
PlacementSolutionsBuilder.FirstSolution¶ Cycle to the first solution.
Signature
FirstSolution()New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
GetNumberOfSolutions¶
-
PlacementSolutionsBuilder.GetNumberOfSolutions¶ Returns the total number of solutions based on the placement object.
Signature
GetNumberOfSolutions()Returns: Return type: int New in version NX8.5.3.
License requirements: routing_base (“Routing Basic”)
GetSolutionIndex¶
-
PlacementSolutionsBuilder.GetSolutionIndex¶ Returns the current index of the solution.
For example, index 1 of 10 solutions.
Signature
GetSolutionIndex()Returns: Return type: int New in version NX8.5.3.
License requirements: routing_base (“Routing Basic”)
InitializePlacementData¶
-
PlacementSolutionsBuilder.InitializePlacementData¶ Initialize Placement Data
Signature
InitializePlacementData(part, placementPos, partToPlace)Parameters: - part (
NXOpen.TaggedObject) – The part which the new part was dropped on. - placementPos (
NXOpen.Point3d) – Location the part was placed - partToPlace (
NXOpen.TaggedObject) – The part being placed.
New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
- part (
NextSolution¶
-
PlacementSolutionsBuilder.NextSolution¶ Cycle to the next solution.
Signature
NextSolution()New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
PreviousSolution¶
-
PlacementSolutionsBuilder.PreviousSolution¶ Cycle to the previous solution
Signature
PreviousSolution()New in version NX7.5.0.
License requirements: routing_base (“Routing Basic”)
Validate¶
-
PlacementSolutionsBuilder.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.