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

The Routing OffsetPath object is the set of information needed to define an offset route. More...

Inheritance diagram for NXOpen::Routing::OffsetPath:
NXOpen::NXObject NXOpen::Routing::IPath NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Member Functions

virtual void AddSegmentsToList (const std::vector< NXOpen::Routing::ISegment * > &objs)
 Adds segment(s) to an IPath object.
double BendRadius ()
 Returns the bend radius for an offset object.
double BendRatio ()
 Returns the bend ratio for an offset object.
virtual
NXOpen::Routing::ControlPoint
ControlPointEnd ()
 Returns the end ControlPoint for an IPath object.
virtual
NXOpen::Routing::ControlPoint
ControlPointStart ()
 Returns the start ControlPoint for an IPath object.
bool CopyCornerFlag ()
 Returns the copy corner flag for an offset object.
virtual void DelSegmentsFromList (const std::vector< NXOpen::Routing::ISegment * > &objs)
 Removes segment(s) from the IPath object.
NXOpen::Routing::IPathGetMasterPath ()
 The master path object for this offset object.
std::vector
< NXOpen::Routing::IPath * > 
GetOffsetPaths ()
 Returns the list of all of the offset paths for a master path.
std::vector
< NXOpen::Routing::ISegment * > 
GetOffsetPathSegments ()
 The path segments for an offset object.
void GetOffsetReferenceAxes (NXOpen::Point3d *orgin, NXOpen::Vector3d *xVector, NXOpen::Vector3d *yVector)
 The reference axes for an offset object.
virtual std::vector
< NXOpen::Routing::ISegment * > 
GetSegmentList ()
 Returns the list of all of the segments contained in the IPath.
bool IsMaster ()
 Returns the isMaster state for this offset object.
bool IsSlave ()
 Returns the isSlave state for this offset object.
bool MaintainStockFlag ()
 Returns the use maintain stock flag for an offset object.
NXOpen::Vector3d OffsetVector ()
 Returns the vector for an offset object.
void RemovePathAssociativityFromParent ()
 Breaks the associativity of a child ( slave ) path to its parent ( master ) path.
void RemovePathAssociativityToImmediateChildren ()
 Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths.
void SetBendRadius (double radius)
 Sets the bend radius for an offset object.
void SetBendRatio (double ratio)
 Sets the bend ratio for an offset object.
virtual void SetControlPointEnd (NXOpen::Routing::ControlPoint *end)
 Sets the end ControlPoint for an IPath object.
virtual void SetControlPointStart (NXOpen::Routing::ControlPoint *start)
 Sets the start ControlPoint for an IPath object.
void SetCopyCornerFlag (bool copyCorner)
 Sets the copy corner flag for an offset object.
void SetMaintainStockFlag (bool maintainStock)
 Sets the use maintain stock flag for an offset object.
void SetMaster (bool masterState)
 Sets the isMaster state for this offset object.
void SetMasterPath (NXOpen::Routing::IPath *masterPath)
 The master path object for this offset object.
void SetOffsetPathSegments (const std::vector< NXOpen::Routing::ISegment * > &segments)
 The path segments for an offset object.
void SetOffsetReferenceAxes (const NXOpen::Point3d &orgin, const NXOpen::Vector3d &xVector, const NXOpen::Vector3d &yVector)
 The reference axes for an offset object.
void SetOffsetVector (const NXOpen::Vector3d &vector)
 Sets the vector for an offset object.
void SetSlave (bool masterState)
 Sets the isSlave state for this offset object.
void SetUseBendRatio (bool ratioState)
 Sets the use bend ratio flag for an offset object.
bool UseBendRatio ()
 Returns the use bend ratio flag for an offset object.

Detailed Description

The Routing OffsetPath object is the set of information needed to define an offset route.


To obtain an instance of this class use Routing::OffsetPathCollection

Created in NX4.0.0.


Member Function Documentation

virtual void NXOpen::Routing::OffsetPath::AddSegmentsToList ( const std::vector< NXOpen::Routing::ISegment * > &  objs) [virtual]

Adds segment(s) to an IPath object.


Created in NX4.0.0.

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

Parameters:
objslist of segments that are to be added

Implements NXOpen::Routing::IPath.

Returns the bend radius for an offset object.


Created in NX4.0.0.

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

Returns the bend ratio for an offset object.


Created in NX4.0.0.

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

Returns the end ControlPoint for an IPath object.


Created in NX4.0.0.

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

Implements NXOpen::Routing::IPath.

Returns the start ControlPoint for an IPath object.


Created in NX4.0.0.

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

Implements NXOpen::Routing::IPath.

Returns the copy corner flag for an offset object.


Created in NX4.0.0.

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

virtual void NXOpen::Routing::OffsetPath::DelSegmentsFromList ( const std::vector< NXOpen::Routing::ISegment * > &  objs) [virtual]

Removes segment(s) from the IPath object.


Created in NX4.0.0.

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

Parameters:
objslist of segments that are to be deleted

Implements NXOpen::Routing::IPath.

The master path object for this offset object.

Returns:
master path for this offset object
Created in NX4.0.0.

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

Returns the list of all of the offset paths for a master path.

Returns:
list of all of the offset paths in this master object
Created in NX4.0.0.

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

The path segments for an offset object.

Returns:
segment list for the offset object
Created in NX4.0.0.

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

The reference axes for an offset object.


Created in NX4.0.0.

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

Parameters:
orginorigin for the offset object
xVectorX reference axes for the offset object
yVectorY reference axes for the offset object

Returns the list of all of the segments contained in the IPath.

Returns:
list of all of the segments in this IPath object
Created in NX4.0.0.

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

Implements NXOpen::Routing::IPath.

Returns the isMaster state for this offset object.


Created in NX4.0.0.

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

Returns the isSlave state for this offset object.


Created in NX4.0.0.

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

Returns the use maintain stock flag for an offset object.


Created in NX4.0.0.

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

Returns the vector for an offset object.


Created in NX4.0.0.

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

Breaks the associativity of a child ( slave ) path to its parent ( master ) path.


Created in NX5.0.0.

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

Breaks the associativity of a parent ( master ) path to its immediate children ( slave ) paths.


Created in NX5.0.0.

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

Sets the bend radius for an offset object.


Created in NX4.0.0.

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

Parameters:
radiusradius

Sets the bend ratio for an offset object.


Created in NX4.0.0.

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

Parameters:
ratioratio

Sets the end ControlPoint for an IPath object.


Created in NX4.0.0.

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

Parameters:
endend ControlPoint for the IPath object

Implements NXOpen::Routing::IPath.

Sets the start ControlPoint for an IPath object.


Created in NX4.0.0.

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

Parameters:
startstart ControlPoint for the IPath object

Implements NXOpen::Routing::IPath.

Sets the copy corner flag for an offset object.


Created in NX4.0.0.

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

Parameters:
copyCornercopy corner

Sets the use maintain stock flag for an offset object.


Created in NX4.0.0.

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

Parameters:
maintainStockmaintain stock
void NXOpen::Routing::OffsetPath::SetMaster ( bool  masterState)

Sets the isMaster state for this offset object.


Created in NX4.0.0.

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

Parameters:
masterStatethe state of the offset path object

The master path object for this offset object.


Created in NX4.0.0.

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

Parameters:
masterPathmaster path for this offset object

The path segments for an offset object.


Created in NX4.0.0.

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

Parameters:
segmentssegment list for the offset object
void NXOpen::Routing::OffsetPath::SetOffsetReferenceAxes ( const NXOpen::Point3d orgin,
const NXOpen::Vector3d xVector,
const NXOpen::Vector3d yVector 
)

The reference axes for an offset object.


Created in NX4.0.0.

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

Parameters:
orginorigin for the offset object
xVectorX reference axes for the offset object
yVectorY reference axes for the offset object

Sets the vector for an offset object.


Created in NX4.0.0.

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

Parameters:
vectorvector for the offset object
void NXOpen::Routing::OffsetPath::SetSlave ( bool  masterState)

Sets the isSlave state for this offset object.


Created in NX4.0.0.

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

Parameters:
masterStatethe state of the offset path object

Sets the use bend ratio flag for an offset object.


Created in NX4.0.0.

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

Parameters:
ratioStateratio state

Returns the use bend ratio flag for an offset object.


Created in NX4.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.