NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Routing.OffsetPathCollection Class Reference

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

Inheritance diagram for NXOpen.Routing.OffsetPathCollection:
NXOpen.TaggedObjectCollection NXOpen.Utilities.NXRemotableObject IEnumerable IMessageSink

Public Types

enum  BendType { MaintainRadius, MaintainCenter, MaximumBendTypes }
 Bend types for offset path creation More...
 

Public Member Functions

unsafe void ConvertOffsetPaths (NXOpen.Routing.OffsetPath masterOffsetPath)
 Converts an offset path into NXOpen.Positioning.Constraint objects applied to the copied routing objects. More...
 
unsafe NXOpen.Routing.OffsetPath CreateCircularOffsetPath (NXOpen.Routing.ISegment[] segments, bool allStock, NXOpen.Routing.Stock[] specStocks, bool maintainStock, bool copyBendCorners, NXOpen.Routing.OffsetPathCollection.BendType maintain, bool useMinimumBendRatio, double minimumBendRatio, double minimumBendRadius, bool deleteAllDuplicates, bool createAssociativePaths, NXOpen.Vector3d patternXVector, NXOpen.Vector3d patternYVector, NXOpen.Point3d patternAxisEndPoint, double patternStartAngle, double radialOffset, int nPaths, double totalAngle, out NXOpen.Routing.OffsetPath[] slavePathsCreated)
 Creates a circular offset path. More...
 
unsafe NXOpen.Routing.OffsetPath CreateRectangularOffsetPath (NXOpen.Routing.ISegment[] segments, bool allStock, NXOpen.Routing.Stock[] specStocks, bool maintainStock, bool copyBendCorners, NXOpen.Routing.OffsetPathCollection.BendType maintain, bool useMinimumBendRatio, double minimumBendRatio, double minimumBendRadius, bool deleteAllDuplicates, bool createAssociativePaths, NXOpen.Vector3d patternXVector, NXOpen.Vector3d patternYVector, NXOpen.Point3d patternAxisEndPoint, double patternStartAngle, double rowOffset, double columnOffset, int nRows, int nColumns, int masterRow, int masterColumn, out NXOpen.Routing.OffsetPath[] slavePathsCreated)
 Creates a rectangular offset path. More...
 
NXOpen.Routing.OffsetPath[] ToArray ()
 Returns an array of NXOpen.Routing.OffsetPath objects. More...
 
- Public Member Functions inherited from NXOpen.TaggedObjectCollection
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObjectCollection
new void initialize ()
 <exclude> More...
 
- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

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 NXOpen.Routing.RouteManager

Created in NX4.0.0

Member Enumeration Documentation

Bend types for offset path creation

Enumerator
MaintainRadius 

Maintain Radius

MaintainCenter 

Maintain Center

MaximumBendTypes 

Member Function Documentation

unsafe void NXOpen.Routing.OffsetPathCollection.ConvertOffsetPaths ( NXOpen.Routing.OffsetPath  masterOffsetPath)
inline

Converts an offset path into NXOpen.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 NXOpen.Routing.OffsetPath is incompatible with segments created using the NXOpen.Routing.SegmentManager.CreateConstrainedSegment or to any segments that have NXOpen.Positioning.Constraint objects applied to them. This routine makes the path parallel and associative to each other using constraints rather than the NXOpen.Routing.OffsetPath objects. The converted offset path objects are logged for delete, the next call to NXOpen.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
unsafe NXOpen.Routing.OffsetPath NXOpen.Routing.OffsetPathCollection.CreateCircularOffsetPath ( NXOpen.Routing.ISegment[]  segments,
bool  allStock,
NXOpen.Routing.Stock[]  specStocks,
bool  maintainStock,
bool  copyBendCorners,
NXOpen.Routing.OffsetPathCollection.BendType  maintain,
bool  useMinimumBendRatio,
double  minimumBendRatio,
double  minimumBendRadius,
bool  deleteAllDuplicates,
bool  createAssociativePaths,
NXOpen.Vector3d  patternXVector,
NXOpen.Vector3d  patternYVector,
NXOpen.Point3d  patternAxisEndPoint,
double  patternStartAngle,
double  radialOffset,
int  nPaths,
double  totalAngle,
out NXOpen.Routing.OffsetPath[]  slavePathsCreated 
)
inline

Creates a circular offset path.

Created in NX4.0.0

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

Parameters
segmentsThe list of segments to be associated with the offset path
allStock
specStocks
maintainStockif TRUE: Maintain stock on paths
copyBendCornersif TRUE: Copy the bend corners
maintainMaintain radius or center
useMinimumBendRatioif TRUE: Use Ratio to Stock Diameter
minimumBendRatioMinimum Bend Ratio
minimumBendRadiusMinimum Bend Radius
deleteAllDuplicatesif TRUE: Delete all duplicate paths
createAssociativePathsif TRUE: Create associative paths
patternXVectorX vector to set the pattern reference axis
patternYVectorY vector to set the pattern reference axis
patternAxisEndPointPoint to set the pattern reference axis direction if NULL: Computes reference axis using heuristics
patternStartAngleStart angle of the point
radialOffsetOffset distance
nPathsNumber of paths
totalAngleTotal angle
slavePathsCreatedThe created slave offset paths
Returns
The created master offset path
unsafe NXOpen.Routing.OffsetPath NXOpen.Routing.OffsetPathCollection.CreateRectangularOffsetPath ( NXOpen.Routing.ISegment[]  segments,
bool  allStock,
NXOpen.Routing.Stock[]  specStocks,
bool  maintainStock,
bool  copyBendCorners,
NXOpen.Routing.OffsetPathCollection.BendType  maintain,
bool  useMinimumBendRatio,
double  minimumBendRatio,
double  minimumBendRadius,
bool  deleteAllDuplicates,
bool  createAssociativePaths,
NXOpen.Vector3d  patternXVector,
NXOpen.Vector3d  patternYVector,
NXOpen.Point3d  patternAxisEndPoint,
double  patternStartAngle,
double  rowOffset,
double  columnOffset,
int  nRows,
int  nColumns,
int  masterRow,
int  masterColumn,
out NXOpen.Routing.OffsetPath[]  slavePathsCreated 
)
inline

Creates a rectangular offset path.

Created in NX4.0.0

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

Parameters
segmentsThe list of segments to be associated with the offset path
allStock
specStocks
maintainStockif TRUE: Maintain stock on paths
copyBendCornersif TRUE: Copy the bend corners
maintainMaintain radius or center
useMinimumBendRatioif TRUE: Use Ratio to Stock Diameter
minimumBendRatioMinimum Bend Ratio
minimumBendRadiusMinimum Bend Radius
deleteAllDuplicatesif TRUE: Delete all duplicate paths
createAssociativePathsif TRUE: Create associative paths
patternXVectorX vector to set the pattern reference axis
patternYVectorY vector to set the pattern reference axis
patternAxisEndPointPoint to set the pattern reference axis direction if NULL: Computes reference axis using heuristics
patternStartAngleStart angle of the pattern
rowOffsetOffset distance along the row
columnOffsetOffset distance along the column
nRowsNumber of rows
nColumnsNumber of columns
masterRowRow of the master path
masterColumnColumn of the master path
slavePathsCreatedThe created slave offset paths
Returns
The created master offset path
override int NXOpen.Routing.OffsetPathCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
inlineprotectedvirtual

Advances the enumerator to the next element of the collection.

Implements NXOpen.TaggedObjectCollection.

NXOpen.Routing.OffsetPath [] NXOpen.Routing.OffsetPathCollection.ToArray ( )
inline

Returns an array of NXOpen.Routing.OffsetPath objects.

Property Documentation

Tag NXOpen.Routing.OffsetPathCollection.Tag
get

Returns the tag of this object.


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