NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::Routing::SBendCornerCollection Class Reference

Represents a collection of SBendCorner objects. More...

Inheritance diagram for NXOpen::Routing::SBendCornerCollection:
NXOpen::TaggedObjectCollection

List of all members.

Classes

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

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element.
bool ComputeSBend (const NXOpen::Point3d &startPnt, const NXOpen::Point3d &endPnt, const NXOpen::Vector3d &lineVec1, const NXOpen::Vector3d &lineVec2, double radius, int sbendType, NXOpen::Spline **bendCurve)
 Compute a S-Bend curve given input.
bool ComputeSBendData (const NXOpen::Point3d &startPnt, const NXOpen::Point3d &endPnt, const NXOpen::Vector3d &lineVec1, const NXOpen::Vector3d &lineVec2, double radius, int sbendType, NXOpen::Point3d *extensionPt1, NXOpen::Point3d *extensionPt2, NXOpen::Point3d *arc1StartPt, NXOpen::Point3d *arc1EndPt, NXOpen::Point3d *arc2StartPt, NXOpen::Point3d *arc2EndPt)
 Compute a S-Bend parameters given input.
NXOpen::Routing::SBendCornerCreateCornerByBendRadius (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp, double bendRadius, int sbendType)
 Creates a S-Bend corner between the start rcp and end rcp using a bend radius.
NXOpen::Routing::SBendCornerCreateCornerByBendRatio (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp, double bendRatio, int sbendType)
 Creates a S-Bend corner between the start rcp and end rcp using a bend ratio.
NXOpen::Routing::SBendCornerCreateCornerBySegBendRadius (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp, NXOpen::Routing::SplineSegment *segment, int sbendType, double bendRadius)
 Creates a S-Bend corner between the start rcp and end rcp using a SplineSegment and a bend radius.
NXOpen::Routing::SBendCornerCreateCornerBySegBendRatio (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp, NXOpen::Routing::SplineSegment *segment, int sbendType, double bendRatio)
 Creates a S-Bend corner between the start rcp and end rcp using a SplineSegment and a bend ratio.
void EditCornerByBendRadius (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp, double bendRadius, int sbendType, NXOpen::Routing::SBendCorner *sbend)
 Edits a selected S-Bend corner between the start rcp and end rcp using a bend radius.
void EditCornerByBendRatio (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp, double bendRatio, int sbendType, NXOpen::Routing::SBendCorner *sbend)
 Edits a S-Bend corner between the start rcp and end rcp using a bend ratio.
iterator end ()
 Returns an iterator addressing one past the last element.
double GetRcpSBendRadius (NXOpen::Routing::ControlPoint *rcp)
 Gets the S-Bend radius of a rcp associated S-Bend corner.
std::vector
< NXOpen::Routing::SBendCorner * > 
GetSBendAssociatedToRcp (NXOpen::Routing::ControlPoint *rcp)
 Given a control point, get S-Bend corners pointing to it.
NXOpen::Routing::SBendCornerGetSBendAssociatedToSegment (NXOpen::Routing::SplineSegment *segment)
 Enquire the S-Bend Corner that this segment represents.
double GetSegmentSBendRadius (NXOpen::Routing::SplineSegment *segment)
 Gets the bend radius of a segment associated S-Bend corner.
bool IsRcpAssociatedToSBend (NXOpen::Routing::ControlPoint *rcp)
 Determines if the rcp is associated to an S-Bend corner.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents a collection of SBendCorner objects.


To obtain an instance of this class, refer to Routing::RouteManager

Created in NX4.0.0.


Member Function Documentation

Returns an iterator addressing the first element.

bool NXOpen::Routing::SBendCornerCollection::ComputeSBend ( const NXOpen::Point3d startPnt,
const NXOpen::Point3d endPnt,
const NXOpen::Vector3d lineVec1,
const NXOpen::Vector3d lineVec2,
double  radius,
int  sbendType,
NXOpen::Spline **  bendCurve 
)

Compute a S-Bend curve given input.

Returns:
TURE: if S-Bend is possible; FALSE: otherwise.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startPntStart point of a S-Bend.
endPntend point of a S-Bend.
lineVec1First S-Bend defining vector.
lineVec2Second S-Bend defining vector.
radiusRadius to use for a S-Bend
sbendTypeValid values: ROUTE_SBEND_TYPE_[1-5].
bendCurveS-Bend spline when a valid solution exists; NULL otherwise.
bool NXOpen::Routing::SBendCornerCollection::ComputeSBendData ( const NXOpen::Point3d startPnt,
const NXOpen::Point3d endPnt,
const NXOpen::Vector3d lineVec1,
const NXOpen::Vector3d lineVec2,
double  radius,
int  sbendType,
NXOpen::Point3d extensionPt1,
NXOpen::Point3d extensionPt2,
NXOpen::Point3d arc1StartPt,
NXOpen::Point3d arc1EndPt,
NXOpen::Point3d arc2StartPt,
NXOpen::Point3d arc2EndPt 
)

Compute a S-Bend parameters given input.

Returns:
TURE: if S-Bend is possible; FALSE: otherwise.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startPntStart point of a S-Bend.
endPntend point of a S-Bend.
lineVec1First S-Bend defining vector.
lineVec2Second S-Bend defining vector.
radiusRadius to use for a S-Bend
sbendTypeValid values: ROUTE_SBEND_TYPE_[1-5].
extensionPt1Location of 1st extension point where bend fillets could be assigned. Value is not valid when no S-Bend is possible.
extensionPt2Location of 2nd extension point where bend fillets could be assigned.
arc1StartPtPoint where the first bend arc starts. Only computed if not NULL.
arc1EndPtPoint where the first bend arc ends. Only computed if not NULL.
arc2StartPtPoint where the second bend arc starts. Only computed if not NULL.
arc2EndPtPoint where the second bend arc ends. Only computed if not NULL.

Creates a S-Bend corner between the start rcp and end rcp using a bend radius.

Returns:
The newly created S-Bend Corner
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startRcpStart rcp must not be NULL.
endRcpEnd rcp must not be NULL.
bendRadiusBend radius.
sbendTypeValid values: ROUTE_SBEND_TYPE_[1-5].

Creates a S-Bend corner between the start rcp and end rcp using a bend ratio.

Returns:
The newly created S-Bend Corner
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startRcpStart rcp must not be NULL.
endRcpEnd rcp must not be NULL.
bendRatioBend ratio.
sbendTypeValid values: ROUTE_SBEND_TYPE__[1-5].

Creates a S-Bend corner between the start rcp and end rcp using a SplineSegment and a bend radius.

Returns:
The newly created S-Bend corner object.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startRcpStart rcp must not be NULL.
endRcpEnd rcp must not be NULL.
segmentSegment representing the path of the S-Bend.
sbendTypeValid values: ROUTE_SBEND_TYPE__[1-5].
bendRadiusS-Bend radius.

Creates a S-Bend corner between the start rcp and end rcp using a SplineSegment and a bend ratio.

Returns:
The newly created S-Bend corner object.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
startRcpStart rcp must not be NULL.
endRcpEnd rcp must not be NULL.
segmentSegment representing the path of the S-Bend.
sbendTypeValid values: ROUTE_SBEND_TYPE__[1-5].
bendRatioS-Bend ratio.

Edits a selected S-Bend corner between the start rcp and end rcp using a bend radius.


Created in NX5.0.0.

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

Parameters:
startRcpStart rcp must not be NULL.
endRcpEnd rcp must not be NULL.
bendRadiusBend radius.
sbendTypeValid values: ROUTE_SBEND_TYPE_[1-5].
sbendS-Bend Corner to be edited.

Edits a S-Bend corner between the start rcp and end rcp using a bend ratio.


Created in NX5.0.0.

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

Parameters:
startRcpStart rcp must not be NULL.
endRcpEnd rcp must not be NULL.
bendRatioBend ratio.
sbendTypeValid values: ROUTE_SBEND_TYPE__[1-5].
sbendS-Bend Corner to be edited.

Returns an iterator addressing one past the last element.

Gets the S-Bend radius of a rcp associated S-Bend corner.

Returns:
The bend radius.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
rcpThe control point.

Given a control point, get S-Bend corners pointing to it.

Returns:
Corner objects pointing to the rcp.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
rcpInput control point

Enquire the S-Bend Corner that this segment represents.

(NULL can be returned, indicating that this segment does not represent a S-Bend Corner.)

Returns:
S-Bend Corner that segment represents (NULL can be returned,indicating that segment does not represent a S-Bend Corner).
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
segmentSegment being queried for the S-Bend Corner it represents.

Gets the bend radius of a segment associated S-Bend corner.

Returns:
The bend radius.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
segmentThe segment associated with the S-Bend corner

Determines if the rcp is associated to an S-Bend corner.

Returns:
true - The control point is a rcp for a S-Bend corner. false - Otherwise
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
rcpControl point to be interrogated.

Returns the tag of this object.


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