HolderSectionBuilder Class

class NXOpen.CAM.HolderSectionBuilder

Bases: NXOpen.TaggedObject

Represents a Holder Section Builder

New in version NX5.0.0.

Properties

Property Description
NumberOfSections Returns the number of holder sections
Tag Returns the Tag for this object.
TlHolderOffsetBuilder Returns the Offset (inheritable double)

Methods

Method Description
Add Add a new holder section item
AddByUpperDiameter Add a new holder section item by upper diameter
Create Create a new holder section item
Delete Delete an existing holder section item
Get Get the values of an existing holder section item
GetAllParameters Get the values of an existing holder section item, include upper diameter
GetSection Get a specific holder section
Modify Modify an existing holder section item
ModifyByUpperDiameter Modify an existing holder section item by upper diameter
MoveDown Move down a holder section item
MoveUp Move up a holder section item

Property Detail

NumberOfSections

HolderSectionBuilder.NumberOfSections

Returns the number of holder sections

-------------------------------------

Getter Method

Signature NumberOfSections

Returns:The number of sections
Return type:int

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

TlHolderOffsetBuilder

HolderSectionBuilder.TlHolderOffsetBuilder

Returns the Offset (inheritable double)

-------------------------------------

Getter Method

Signature TlHolderOffsetBuilder

Returns:The offset builder
Return type:NXOpen.CAM.InheritableDoubleBuilder

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Method Detail

Add

HolderSectionBuilder.Add

Add a new holder section item

Signature Add(inputIndex, diameter, length, taperAngle, cornerRadius)

Parameters:
  • inputIndex (int) – input the new created item index
  • diameter (float) – the diameter
  • length (float) – the length
  • taperAngle (float) – the taper angle
  • cornerRadius (float) – the corner radius
Returns:

output the new created item actual index,if error happens, output will be -1
Return type:

int

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

AddByUpperDiameter

HolderSectionBuilder.AddByUpperDiameter

Add a new holder section item by upper diameter

Signature AddByUpperDiameter(inputIndex, lowerDiameter, length, upperDiameter, cornerRadius)

Parameters:
  • inputIndex (int) – input the new created item index
  • lowerDiameter (float) – the lower diameter
  • length (float) – the length
  • upperDiameter (float) – the upper diameter
  • cornerRadius (float) – the corner radius
Returns:

output the new created item actual index,if error happens, output will be -1
Return type:

int

New in version NX8.0.0.

License requirements: cam_base (“CAM BASE”)

Create

HolderSectionBuilder.Create

Create a new holder section item

Signature Create(diameter, length, taperAngle, cornerRadius)

Parameters:
  • diameter (float) – the diameter
  • length (float) – the length
  • taperAngle (float) – the taper angle
  • cornerRadius (float) – the corner radius
Returns:

input the current selected item pointer and return new created item pointer.

if list is empty, should input NULL :rtype: NXOpen.NXObject

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Delete

HolderSectionBuilder.Delete

Overloaded method Delete

  • Delete(section)
  • Delete(index)

-------------------------------------

Delete an existing holder section item

Signature Delete(section)

Parameters:section (NXOpen.NXObject) – the pointer of deleted holder section

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Delete an existing holder section item by index

Signature Delete(index)

Parameters:index (int) – the index of deleted holder section

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Get

HolderSectionBuilder.Get

Get the values of an existing holder section item

Signature Get(section)

Parameters:section (NXOpen.NXObject) – the section
Returns:a tuple
Return type:A tuple consisting of (diameter, length, taperAngle, cornerRadius) diameter is a float. the diameter length is a float. the length taperAngle is a float. the taper angle cornerRadius is a float. the corner radius

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

GetAllParameters

HolderSectionBuilder.GetAllParameters

Get the values of an existing holder section item, include upper diameter

Signature GetAllParameters(section)

Parameters:section (NXOpen.NXObject) – the section
Returns:a tuple
Return type:A tuple consisting of (lowerDiameter, length, taperAngle, upperDiameter, cornerRadius) lowerDiameter is a float. the lower diameter length is a float. the length taperAngle is a float. the taper angle upperDiameter is a float. the upper diameter cornerRadius is a float. the corner radius

New in version NX8.0.0.

License requirements: None.

GetSection

HolderSectionBuilder.GetSection

Get a specific holder section

Signature GetSection(position)

Parameters:position (int) – index in array
Returns:the section
Return type:NXOpen.NXObject

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

Modify

HolderSectionBuilder.Modify

Overloaded method Modify

  • Modify(section, diameter, length, taperAngle, cornerRadius)
  • Modify(index, diameter, length, taperAngle, cornerRadius)

-------------------------------------

Modify an existing holder section item

Signature Modify(section, diameter, length, taperAngle, cornerRadius)

Parameters:
  • section (NXOpen.NXObject) – the pointer of modified holder section
  • diameter (float) – the diameter
  • length (float) – the length
  • taperAngle (float) – the taper angle
  • cornerRadius (float) – the corner radius

New in version NX5.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

Modify an existing holder section item by index

Signature Modify(index, diameter, length, taperAngle, cornerRadius)

Parameters:
  • index (int) – the index of modified holder section
  • diameter (float) – the diameter
  • length (float) – the length
  • taperAngle (float) – the taper angle
  • cornerRadius (float) – the corner radius

New in version NX6.0.0.

License requirements: cam_base (“CAM BASE”)

-------------------------------------

ModifyByUpperDiameter

HolderSectionBuilder.ModifyByUpperDiameter

Modify an existing holder section item by upper diameter

Signature ModifyByUpperDiameter(index, lowerDiameter, length, upperDiameter, cornerRadius)

Parameters:
  • index (int) – the index of modified holder section
  • lowerDiameter (float) – the lower diameter
  • length (float) – the length
  • upperDiameter (float) – the upper diameter
  • cornerRadius (float) – the corner radius

New in version NX8.0.0.

License requirements: cam_base (“CAM BASE”)

MoveDown

HolderSectionBuilder.MoveDown

Move down a holder section item

Signature MoveDown(index)

Parameters:index (int) – the index of item which should be moved down

New in version NX6.0.0.

License requirements: None.

MoveUp

HolderSectionBuilder.MoveUp

Move up a holder section item

Signature MoveUp(index)

Parameters:index (int) – the index of item which should be moved up

New in version NX6.0.0.

License requirements: None.