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

Represents a collection of Routing::BendCorner objects. More...

Inheritance diagram for NXOpen::Routing::BendCornerCollection:
NXOpen::TaggedObjectCollection

List of all members.

Classes

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

Public Types

enum  Type { TypeRadiusRatio, TypeTable }
 Option for creating a bend using a bend table or using radius or ratio. More...

Public Member Functions

NXOpen::Routing::BendCornerAssignCornerByBendRadius (NXOpen::Routing::ControlPoint *bendCrn, double bendRadius)
 This routine assigns a new bend corner to the given input bend corner object using bend radius.
NXOpen::Routing::BendCornerAssignCornerByBendRatio (NXOpen::Routing::ControlPoint *bendCrn, double bendRatio)
 This routine assigns a new bend corner to the given input bend corner object using bend ratio.
NXOpen::Routing::BendCornerAssignCornerByBendTable (NXOpen::Routing::ControlPoint *rcp, const NXString &bendTable)
 This routine assigns a bend corner to the given input RCP object using a bend table entry.
iterator begin ()
 Returns an iterator addressing the first element.
NXOpen::Routing::BendCornerCreate (NXOpen::Routing::ControlPoint *rcp, bool useBendRatio, double bendRatio, double bendRadius)
 Create a bend corner object at a Control Point.
iterator end ()
 Returns an iterator addressing one past the last element.
NXOpen::Routing::BendCornerGetBendAssociatedToSegment (NXOpen::Routing::ISegment *segment)
 Enquire the Bend Corner that this segment represents.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents a collection of Routing::BendCorner objects.


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

Created in NX4.0.0.


Member Enumeration Documentation

Option for creating a bend using a bend table or using radius or ratio.

Enumerator:
TypeRadiusRatio 

Using radius or ratio to create a bend corner.

TypeTable 

Using a bend table to create a bend corner.


Member Function Documentation

This routine assigns a new bend corner to the given input bend corner object using bend radius.

This "assignment" can involve the removal of an existing corner at this location and the creation of a new corner.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
bendCrnInput bend corner.
bendRadiusRadius of bend corner arc.

This routine assigns a new bend corner to the given input bend corner object using bend ratio.

This "assignment" can involve the removal of an existing corner at this location and the creation of a new corner.

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

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
bendCrnInput bend corner.
bendRatioBend ratio must be greater than 0.5.

This routine assigns a bend corner to the given input RCP object using a bend table entry.

This "assignment" can involve the removal of an existing corner at this location and the creation of a new corner. The application view must be loaded before attempting to assign a bend corner of this type.

Returns:
The newly created Bend Corner
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 assign corner to. NULL not allowed.
bendTableThe bend table entry that is used to create bend corner
NOTE: The full Unicode character set is not supported for this parameter.

Returns an iterator addressing the first element.

NXOpen::Routing::BendCorner* NXOpen::Routing::BendCornerCollection::Create ( NXOpen::Routing::ControlPoint rcp,
bool  useBendRatio,
double  bendRatio,
double  bendRadius 
)

Create a bend corner object at a Control Point.

Returns:
The new bend corner.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
rcpRoute control point to bend.
useBendRatioTRUE: use bend ratio calculation, FALSE: use given radius
bendRatioBend ratio only used if use_bend_ratio is TRUE. Must be greater than 0.5.
bendRadiusRadius of bend corner arc, only used if use_bend_ratio is FALSE. Must be greater than 0.

Returns an iterator addressing one past the last element.

Enquire the Bend Corner that this segment represents.

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

Returns:
Bend Corner that segment represents (NULL can be returned,indicating that segment does not represent a 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 Bend Corner it represents.

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.