NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::QuickPathBuilder Class Reference

Builder for creating a collision free path between points. More...

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

List of all members.

Public Member Functions

void AssignExtension (NXOpen::Point *point, const NXOpen::Vector3d &direction, double backValue, double fwdValue)
 Assigns a direction as well as a forward and backward distance to the given point.
NXOpen::ExpressionClearance ()
 Returns the obstacle clearance value.
int MaximumNumberOfBends ()
 Returns the maximum number of bends in a path.
NXOpen::ExpressionMinimumStraightLength ()
 Returns the minimum straight length value.
NXOpen::ErrorListPathErrors ()
 Returns the errors associated with this path.
NXOpen::Routing::LinearPathSettingsPathSettings ()
 Returns the linear path settings for this path.
NXOpen::PointListPointList ()
 Returns the list of goal path points.
int Seed ()
 Returns the seed number to use for the random number generator.
void SetMaximumNumberOfBends (int maximumNumberOfBends)
 Sets the maximum number of bends in a path.
void SetPathSettings (NXOpen::Routing::LinearPathSettings *pathSettings)
 Sets the linear path settings for this path.
void SetSeed (int seed)
 Sets the seed number to use for the random number generator.
void SetStockSettings (NXOpen::Routing::PathStockBuilder *stockBuilder)
 Sets the stock settings for this path.
NXOpen::Routing::PathStockBuilderStockSettings ()
 Returns the stock settings for this path.

Detailed Description

Builder for creating a collision free path between points.

This builder takes a list of points and a stock and builds a collision-free path through those points. The built path is created as linear segments with bend corners (or elbows) depending on the settings chosen by the user (Routing::LinearPathSettings )).

After invoking the commit method, invoke the Routing::QuickPathBuilder::PathErrors method to find out which sections between points contained errors.
To create a new instance of this class, use Routing::RouteManager::CreateQuickPathBuilder
Default values.

Property Value

Clearance.Value

0.0 (millimeters part), 0.0 (inches part)

MaximumNumberOfBends

10

MinimumStraightLength.Value

0.0 (millimeters part), 0.0 (inches part)

PathSettings.LockToSelectedObject

True


Created in NX6.0.0.


Member Function Documentation

void NXOpen::Routing::QuickPathBuilder::AssignExtension ( NXOpen::Point point,
const NXOpen::Vector3d direction,
double  backValue,
double  fwdValue 
)

Assigns a direction as well as a forward and backward distance to the given point.

Quick Path will treat this as a collision-free reserved space and will ensure there is a segment going through the point along the given direction. The forward and backward values define the minimimum starting and ending locations, the path will include those locations but may extend past those locations.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
pointpoint
directiondirection
backValueback value
fwdValuefwd value

Returns the obstacle clearance value.

This value specifies the desired minimum distance between the path and obstacles in the assembly. This is a soft constraint so it is possible that the returned path will have sections that violate the clearance value.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the maximum number of bends in a path.

This value specifies the desired maximum number of bends. This is a soft constraint so it is possible that the returned path may have more than this number of bends. The number must be >= 0.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the minimum straight length value.

This value specifies the desired minimum value between bend corner points. This is a soft constraint so it is possible that the returned path will have sections that violate the minimum straight length.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the errors associated with this path.

The list will be NULL if the commit method has not been invoked yet.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the linear path settings for this path.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the list of goal path points.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Returns the seed number to use for the random number generator.

Quick Path uses the random number generator for finding random sample points in space.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Sets the maximum number of bends in a path.

This value specifies the desired maximum number of bends. This is a soft constraint so it is possible that the returned path may have more than this number of bends. The number must be >= 0.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
maximumNumberOfBendsmaximum number of bends

Sets the linear path settings for this path.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
pathSettingspath settings

Sets the seed number to use for the random number generator.

Quick Path uses the random number generator for finding random sample points in space.
Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
seedseed

Sets the stock settings for this path.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
stockBuilderstock builder

Returns the stock settings for this path.


Created in NX6.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")


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