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


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

Created in NX7.5.0. More...

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

Public Member Functions

std::vector
< NXOpen::Routing::Path * > 
CreateValidPointsOnPaths (const std::vector< NXOpen::Point3d > &pointLocs, std::vector< NXOpen::Point * > &validPoints)
 This function will get all the paths stored in NXOpen::Routing::ManualRouteBuilder and will create point for any location which lies on any of the paths. More...
 
void CyclePaths ()
 Cycle paths through filter paths array to enable user select path for routing. More...
 
std::vector
< NXOpen::Routing::Path * > 
FindPathsFromMultiplePoints (const std::vector< NXOpen::Point * > &points, bool *foundPath)
 This function returns all possible paths which are passing through all the given points. More...
 
std::vector
< NXOpen::Routing::Path * > 
GetFilterPaths ()
 This function gets filter paths from builder. More...
 
NXOpen::Routing::PathGetHighlightPath ()
 This function returns currently highlighted path stored in builder. More...
 
std::vector
< NXOpen::Routing::Path * > 
GetPaths ()
 This function returns all possible paths for stockDevice stored in builder. More...
 
NXOpen::PointListPointList ()
 Returns the point list
Created in NX7.5.0. More...
 
void SetFilterPaths (const std::vector< NXOpen::Routing::Path * > &filterPaths)
 
Created in NX7.5.0. More...
 
void SetHighlightPath (NXOpen::Routing::Path *path)
 This function sets highlight path amongst all paths, and this highlight path only will be used for routing the stock device
Created in NX7.5.0. More...
 
bool UpdateFilterPaths (NXOpen::Point *point)
 This function updates the filter paths in builder, using the given selected point. 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::CreateManualRouteBuilder

Created in NX7.5.0.


Member Function Documentation

std::vector<NXOpen::Routing::Path *> NXOpen::Routing::ManualRouteBuilder::CreateValidPointsOnPaths ( const std::vector< NXOpen::Point3d > &  pointLocs,
std::vector< NXOpen::Point * > &  validPoints 
)

This function will get all the paths stored in NXOpen::Routing::ManualRouteBuilder and will create point for any location which lies on any of the paths.

Newly created points will be returned as result. It will also return the filter paths found using given locations.

Returns

Created in NX7.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
pointLocspointlocs
validPointsvalidpoints
void NXOpen::Routing::ManualRouteBuilder::CyclePaths ( )

Cycle paths through filter paths array to enable user select path for routing.


Created in NX7.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

std::vector<NXOpen::Routing::Path *> NXOpen::Routing::ManualRouteBuilder::FindPathsFromMultiplePoints ( const std::vector< NXOpen::Point * > &  points,
bool *  foundPath 
)

This function returns all possible paths which are passing through all the given points.

Returns

Created in NX7.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
pointspoints
foundPathfoundpath
std::vector<NXOpen::Routing::Path *> NXOpen::Routing::ManualRouteBuilder::GetFilterPaths ( )

This function gets filter paths from builder.

These paths are those which passes through selected points in point list.

Returns

Created in NX7.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::Routing::Path* NXOpen::Routing::ManualRouteBuilder::GetHighlightPath ( )

This function returns currently highlighted path stored in builder.

Returns

Created in NX7.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
std::vector<NXOpen::Routing::Path *> NXOpen::Routing::ManualRouteBuilder::GetPaths ( )

This function returns all possible paths for stockDevice stored in builder.

Returns

Created in NX7.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
NXOpen::PointList* NXOpen::Routing::ManualRouteBuilder::PointList ( )

Returns the point list
Created in NX7.5.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

void NXOpen::Routing::ManualRouteBuilder::SetFilterPaths ( const std::vector< NXOpen::Routing::Path * > &  filterPaths)


Created in NX7.5.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
filterPathsfilterpaths
void NXOpen::Routing::ManualRouteBuilder::SetHighlightPath ( NXOpen::Routing::Path path)

This function sets highlight path amongst all paths, and this highlight path only will be used for routing the stock device
Created in NX7.5.0.



License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters
pathpath
bool NXOpen::Routing::ManualRouteBuilder::UpdateFilterPaths ( NXOpen::Point point)

This function updates the filter paths in builder, using the given selected point.

It checks all the filter paths stored in builder, and finds paths passing through given point. Then it updates filter paths accordingly in builder.

Returns

Created in NX7.5.0.

License requirements : routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")
Parameters
pointpoint

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