StepParamsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# StepParamsBuilder Class

class `NXOpen.CAM.``StepParamsBuilder`

  Bases: `NXOpen.TaggedObject`

  Represents a StepParams Builder

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
NumberOfSteps | Returns the number of step params
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Add | Create a new step params item
Delete | Delete an existing step params item
Get | Get the values of an existing step params item
Modify | Modify an existing step params item
MoveDown | Move down a step params item
MoveUp | Move up a step params item

# Property Detail

## NumberOfSteps

`StepParamsBuilder.``NumberOfSteps`

  Returns the number of step params

  `-------------------------------------`

  Getter Method

  Signature `NumberOfSteps`

  Returns: | The number of steps
  Return type: | int

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

# Method Detail

## Add

`StepParamsBuilder.``Add`

  Create a new step params item

  Signature `Add(inputIndex, diameter, length, angle, radius)`

  Parameters:

  - inputIndex (int) – the inputted new created item position
  - diameter (float) – the diameter
  - length (float) – the length
  - angle (float) – the angle
  - radius (float) – the radius

  Returns: | the outputted new created item actual position,if error happens, output will be -1
  Return type: | int

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## Delete

`StepParamsBuilder.``Delete`

  Delete an existing step params item

  Signature `Delete(nodeIndex)`

  Parameters: | nodeIndex (int) – the selected entry indx in list

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## Get

`StepParamsBuilder.``Get`

  Get the values of an existing step params item

  Signature `Get(step)`

  Parameters: | step (int) – the step
  Returns: | a tuple
  Return type: | A tuple consisting of (diameter, length, angle, cornerRadius) diameter is a float. the diameter length is a float. the length angle is a float. the angle cornerRadius is a float. the corner radius

  New in version NX6.0.0.

  License requirements: cam_base (“CAM BASE”)

## Modify

`StepParamsBuilder.``Modify`

  Modify an existing step params item

  Signature `Modify(nodeIndex, diameter, length, angle, radius)`

  Parameters:

  - nodeIndex (int) – the index of modified step params
  - diameter (float) – the diameter
  - length (float) – the length
  - angle (float) – the angle
  - radius (float) – the radius

  New in version NX5.0.0.

  License requirements: cam_base (“CAM BASE”)

## MoveDown

`StepParamsBuilder.``MoveDown`

  Move down a step params 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

`StepParamsBuilder.``MoveUp`

  Move up a step params 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.