TeachmodeRetractSettingsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# TeachmodeRetractSettingsBuilder Class

class `NXOpen.CAM.``TeachmodeRetractSettingsBuilder`

  Bases: `NXOpen.CAM.MoveBuilder`

  Represents a TeachmodeRetractSettings builder

  To create a new instance of this class, use `NXOpen.CAM.OperationCollection.CreateTeachmodeTurningBuilder()`

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
FeedRate | Returns or sets the feed rate
FeedType | Returns or sets the feed type
FeedUnit | Returns or sets the feed unit
MotionType | Returns or sets the motion type
NumberOfUserParameters | Returns the number of user parameters
ProtectedMove | Returns or sets the protected move status
RetractBuilder | Returns the retract parameters builder
SubopLabel | Returns or sets the subop label
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
GetUserParameter | Returns the custom parameter with the given name.
SetParent | Set parent
SetSibling | Set sibling
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## RetractBuilder

`TeachmodeRetractSettingsBuilder.``RetractBuilder`

  Returns the retract parameters builder

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

  Getter Method

  Signature `RetractBuilder`

  Returns: | the retract builder
  Return type: | `NXOpen.CAM.TurnEngageRetractBuilder`

  New in version NX7.5.0.

  License requirements: None.

# Method Detail

## Validate

`TeachmodeRetractSettingsBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.