NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::PlacementSolutionsBuilder Class Reference


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreatePlacementSolutionsBuilder

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::Routing::PlacementSolutionsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void ApplyConstraintsAndClear ()
 Commit the solution and apply constraints if needed. More...
 
void ApplyConstraintsAndClear (bool lockEngagement, bool lockRotation)
 Commit the solution and apply constraints if needed. More...
 
void ApplyConstraintsAndClear (bool lockEngagement, bool lockRotation, bool fixPart)
 Commit the solution and apply constraints if needed. More...
 
void ApplyPortRotation (double angle)
 Applies a rotation to the component about the axis of the port being used for placement. More...
 
void FirstSolution ()
 Cycle to the first solution. More...
 
bool GetConsiderPorts ()
 Returns false if the first placement solution maintains the origin and orientation of the original component. More...
 
bool GetLookForAdditionalPlacementSolutions ()
 Is Place Part looking for additional placement solutions? Used for Maintain Origin and Orientation replacement. More...
 
int GetNumberOfSolutions ()
 Returns the total number of solutions based on the placement object. More...
 
bool GetOnlyPrimaryPlacementSolutions ()
 Is Place Part only considering the primary placement solutions? More...
 
int GetSolutionIndex ()
 Returns the current index of the solution. More...
 
void InitializePlacementData (NXOpen::TaggedObject *part, const NXOpen::Point3d &placementPos, NXOpen::TaggedObject *partToPlace)
 Initialize Placement Data
Created in NX7.5.0. More...
 
void NextSolution ()
 Cycle to the next solution. More...
 
void PreviousSolution ()
 Cycle to the previous solution
Created in NX7.5.0. More...
 
void SetConsiderPorts (bool considerPorts)
 Set to false to include a placement solution maintaining the origin and orientation of the component being replaced. More...
 
void SetLookForAdditionalPlacementSolutions (bool lookForAdditionalPlacementSolutions)
 Set to true to look for additional placement solutions. More...
 
void SetOnlyPrimaryPlacementSolutions (bool onlyPrimaryPlacementSolutions)
 True tells Place Part to only consider the primary placement solutions. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description


To create a new instance of this class, use NXOpen::Routing::RouteManager::CreatePlacementSolutionsBuilder

Created in NX7.5.0.


Member Function Documentation

void NXOpen::Routing::PlacementSolutionsBuilder::ApplyConstraintsAndClear ( )

Commit the solution and apply constraints if needed.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PlacementSolutionsBuilder::ApplyConstraintsAndClear ( bool  lockEngagement,
bool  lockRotation 
)

Commit the solution and apply constraints if needed.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

Parameters
lockEngagementLock engagement if applicable.
lockRotationLock Rotation if applicable.
void NXOpen::Routing::PlacementSolutionsBuilder::ApplyConstraintsAndClear ( bool  lockEngagement,
bool  lockRotation,
bool  fixPart 
)

Commit the solution and apply constraints if needed.


Created in NX7.5.2.

License requirements : routing_base ("Routing Basic")

Parameters
lockEngagementLock engagement if applicable.
lockRotationLock Rotation if applicable.
fixPartFix Part if applicable.
void NXOpen::Routing::PlacementSolutionsBuilder::ApplyPortRotation ( double  angle)

Applies a rotation to the component about the axis of the port being used for placement.


Created in NX7.5.2.

License requirements : routing_base ("Routing Basic")

Parameters
angleAngle to apply.
void NXOpen::Routing::PlacementSolutionsBuilder::FirstSolution ( )

Cycle to the first solution.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

bool NXOpen::Routing::PlacementSolutionsBuilder::GetConsiderPorts ( )

Returns false if the first placement solution maintains the origin and orientation of the original component.

Returns
Are ports to be considered when finding the first placement solution?
Created in NX10.3.0.

License requirements : routing_base ("Routing Basic")
bool NXOpen::Routing::PlacementSolutionsBuilder::GetLookForAdditionalPlacementSolutions ( )

Is Place Part looking for additional placement solutions? Used for Maintain Origin and Orientation replacement.

Returns
Are additional placement solutions to be found?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")
int NXOpen::Routing::PlacementSolutionsBuilder::GetNumberOfSolutions ( )

Returns the total number of solutions based on the placement object.

Returns

Created in NX8.5.3.

License requirements : routing_base ("Routing Basic")
bool NXOpen::Routing::PlacementSolutionsBuilder::GetOnlyPrimaryPlacementSolutions ( )

Is Place Part only considering the primary placement solutions?

Returns
Are only the primary placement solutions to be found?
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")
int NXOpen::Routing::PlacementSolutionsBuilder::GetSolutionIndex ( )

Returns the current index of the solution.

For example, index 1 of 10 solutions.

Returns

Created in NX8.5.3.

License requirements : routing_base ("Routing Basic")
void NXOpen::Routing::PlacementSolutionsBuilder::InitializePlacementData ( NXOpen::TaggedObject part,
const NXOpen::Point3d placementPos,
NXOpen::TaggedObject partToPlace 
)

Initialize Placement Data
Created in NX7.5.0.



License requirements : routing_base ("Routing Basic")

Parameters
partThe part which the new part was dropped on.
placementPosLocation the part was placed
partToPlaceThe part being placed.
void NXOpen::Routing::PlacementSolutionsBuilder::NextSolution ( )

Cycle to the next solution.


Created in NX7.5.0.

License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PlacementSolutionsBuilder::PreviousSolution ( )

Cycle to the previous solution
Created in NX7.5.0.



License requirements : routing_base ("Routing Basic")

void NXOpen::Routing::PlacementSolutionsBuilder::SetConsiderPorts ( bool  considerPorts)

Set to false to include a placement solution maintaining the origin and orientation of the component being replaced.

This solution, where ports are not considered in the calculation, will be the first solution.
Created in NX10.3.0.

License requirements : routing_base ("Routing Basic")

Parameters
considerPortsAre ports to be considered when finding the first placement solution?
void NXOpen::Routing::PlacementSolutionsBuilder::SetLookForAdditionalPlacementSolutions ( bool  lookForAdditionalPlacementSolutions)

Set to true to look for additional placement solutions.

Used for Maintain Origin and Orientation replacement.
Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters
lookForAdditionalPlacementSolutionsAre additional placement solutions to be found?
void NXOpen::Routing::PlacementSolutionsBuilder::SetOnlyPrimaryPlacementSolutions ( bool  onlyPrimaryPlacementSolutions)

True tells Place Part to only consider the primary placement solutions.


Created in NX11.0.1.

License requirements : routing_base ("Routing Basic")

Parameters
onlyPrimaryPlacementSolutionsAre only the primary placement solutions to be found?

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.