NXOpen::Routing::OffsetPathCollection Class Reference

The Routing OffsetPath object is a list of segments in a route. More...

Inheritance diagram for NXOpen::Routing::OffsetPathCollection:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Types
enum	BendType { BendTypeMaintainRadius, BendTypeMaintainCenter, BendTypeMaximumBendTypes }
	Bend types for offset path creation. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element.
void	ConvertOffsetPaths (NXOpen::Routing::OffsetPath *masterOffsetPath)
	Converts an offset path into Positioning::Constraint objects applied to the copied routing objects.
NXOpen::Routing::OffsetPath *	CreateCircularOffsetPath (const std::vector< NXOpen::Routing::ISegment * > &segments, bool allStock, const std::vector< NXOpen::Routing::Stock * > &specStocks, bool maintainStock, bool copyBendCorners, NXOpen::Routing::OffsetPathCollection::BendType maintain, bool useMinimumBendRatio, double minimumBendRatio, double minimumBendRadius, bool deleteAllDuplicates, bool createAssociativePaths, const NXOpen::Vector3d &patternXVector, const NXOpen::Vector3d &patternYVector, const NXOpen::Point3d &patternAxisEndPoint, double patternStartAngle, double radialOffset, int nPaths, double totalAngle, std::vector< NXOpen::Routing::OffsetPath * > &slavePathsCreated)
	Creates a circular offset path.
NXOpen::Routing::OffsetPath *	CreateRectangularOffsetPath (const std::vector< NXOpen::Routing::ISegment * > &segments, bool allStock, const std::vector< NXOpen::Routing::Stock * > &specStocks, bool maintainStock, bool copyBendCorners, NXOpen::Routing::OffsetPathCollection::BendType maintain, bool useMinimumBendRatio, double minimumBendRatio, double minimumBendRadius, bool deleteAllDuplicates, bool createAssociativePaths, const NXOpen::Vector3d &patternXVector, const NXOpen::Vector3d &patternYVector, const NXOpen::Point3d &patternAxisEndPoint, double patternStartAngle, double rowOffset, double columnOffset, int nRows, int nColumns, int masterRow, int masterColumn, std::vector< NXOpen::Routing::OffsetPath * > &slavePathsCreated)
	Creates a rectangular offset path.
iterator	end ()
	Returns an iterator addressing one past the last element.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

The Routing OffsetPath object is a list of segments in a route.

It also contains the beginning and ending control point for the path.
To obtain an instance of this class, refer to Routing::RouteManager

Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Routing::OffsetPathCollection::BendType

Bend types for offset path creation.

Enumerator:

BendTypeMaintainRadius	Maintain Radius.
BendTypeMaintainCenter	Maintain Center.
BendTypeMaximumBendTypes	maximum bend types

Member Function Documentation

iterator NXOpen::Routing::OffsetPathCollection::begin

(

)

Returns an iterator addressing the first element.

void NXOpen::Routing::OffsetPathCollection::ConvertOffsetPaths

(

NXOpen::Routing::OffsetPath *

masterOffsetPath

)

Converts an offset path into Positioning::Constraint objects applied to the copied routing objects.

Converts the input master offset path as well as all of the children offset paths of the input master offset path.

The Routing::OffsetPath is incompatible with segments created using the Routing::SegmentManager::CreateConstrainedSegment or to any segments that have Positioning::Constraint objects applied to them. This routine makes the path parallel and associative to each other using constraints rather than the Routing::OffsetPath objects. The converted offset path objects are logged for delete, the next call to Update::DoUpdate will delete the offset path objects.

Created in NX5.0.0.

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

Parameters

masterOffsetPath

master offset path

NXOpen::Routing::OffsetPath* NXOpen::Routing::OffsetPathCollection::CreateCircularOffsetPath	(	const std::vector< NXOpen::Routing::ISegment * > &	segments,
		bool	allStock,
		const std::vector< NXOpen::Routing::Stock * > &	specStocks,
		bool	maintainStock,
		bool	copyBendCorners,
		NXOpen::Routing::OffsetPathCollection::BendType	maintain,
		bool	useMinimumBendRatio,
		double	minimumBendRatio,
		double	minimumBendRadius,
		bool	deleteAllDuplicates,
		bool	createAssociativePaths,
		const NXOpen::Vector3d &	patternXVector,
		const NXOpen::Vector3d &	patternYVector,
		const NXOpen::Point3d &	patternAxisEndPoint,
		double	patternStartAngle,
		double	radialOffset,
		int	nPaths,
		double	totalAngle,
		std::vector< NXOpen::Routing::OffsetPath * > &	slavePathsCreated
	)

Creates a circular offset path.

Returns

The created master offset path
Created in NX4.0.0.

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

Parameters

segments	The list of segments to be associated with the offset path
allStock	allstock
specStocks	specstocks
maintainStock	if TRUE: Maintain stock on paths
copyBendCorners	if TRUE: Copy the bend corners
maintain	Maintain radius or center
useMinimumBendRatio	if TRUE: Use Ratio to Stock Diameter
minimumBendRatio	Minimum Bend Ratio
minimumBendRadius	Minimum Bend Radius
deleteAllDuplicates	if TRUE: Delete all duplicate paths
createAssociativePaths	if TRUE: Create associative paths
patternXVector	X vector to set the pattern reference axis
patternYVector	Y vector to set the pattern reference axis
patternAxisEndPoint	Point to set the pattern reference axis direction if NULL: Computes reference axis using heuristics
patternStartAngle	Start angle of the point
radialOffset	Offset distance
nPaths	Number of paths
totalAngle	Total angle
slavePathsCreated	The created slave offset paths

NXOpen::Routing::OffsetPath* NXOpen::Routing::OffsetPathCollection::CreateRectangularOffsetPath	(	const std::vector< NXOpen::Routing::ISegment * > &	segments,
		bool	allStock,
		const std::vector< NXOpen::Routing::Stock * > &	specStocks,
		bool	maintainStock,
		bool	copyBendCorners,
		NXOpen::Routing::OffsetPathCollection::BendType	maintain,
		bool	useMinimumBendRatio,
		double	minimumBendRatio,
		double	minimumBendRadius,
		bool	deleteAllDuplicates,
		bool	createAssociativePaths,
		const NXOpen::Vector3d &	patternXVector,
		const NXOpen::Vector3d &	patternYVector,
		const NXOpen::Point3d &	patternAxisEndPoint,
		double	patternStartAngle,
		double	rowOffset,
		double	columnOffset,
		int	nRows,
		int	nColumns,
		int	masterRow,
		int	masterColumn,
		std::vector< NXOpen::Routing::OffsetPath * > &	slavePathsCreated
	)

Creates a rectangular offset path.

Returns

The created master offset path
Created in NX4.0.0.

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

Parameters

segments	The list of segments to be associated with the offset path
allStock	allstock
specStocks	specstocks
maintainStock	if TRUE: Maintain stock on paths
copyBendCorners	if TRUE: Copy the bend corners
maintain	Maintain radius or center
useMinimumBendRatio	if TRUE: Use Ratio to Stock Diameter
minimumBendRatio	Minimum Bend Ratio
minimumBendRadius	Minimum Bend Radius
deleteAllDuplicates	if TRUE: Delete all duplicate paths
createAssociativePaths	if TRUE: Create associative paths
patternXVector	X vector to set the pattern reference axis
patternYVector	Y vector to set the pattern reference axis
patternAxisEndPoint	Point to set the pattern reference axis direction if NULL: Computes reference axis using heuristics
patternStartAngle	Start angle of the pattern
rowOffset	Offset distance along the row
columnOffset	Offset distance along the column
nRows	Number of rows
nColumns	Number of columns
masterRow	Row of the master path
masterColumn	Column of the master path
slavePathsCreated	The created slave offset paths

iterator NXOpen::Routing::OffsetPathCollection::end

(

)

Returns an iterator addressing one past the last element.

tag_t NXOpen::Routing::OffsetPathCollection::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• Routing_OffsetPathCollection.hxx