MachineKitBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MachineKitBuilder Class

class `NXOpen.SIM.``MachineKitBuilder`

  Bases: `NXOpen.Builder`

  This class is used for the Machine Kit Create Dialog.

  Calling `Builder.Commit()` on this builder will start the machine kit creation process and return None.

  Use the `Part` class to create a MachineKitBuilder object.

  New in version NX10.0.2.

# Properties

Property | Description
--- | ---
Name | Returns or sets the machine kit name.
OutputDirectory | Returns or sets the machine kit output directory.
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.
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

## Name

`MachineKitBuilder.``Name`

  Returns or sets the machine kit name.

  The name is used for the database entry and the name of the folder.

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

  Getter Method

  Signature `Name`

  Returns: | machine kit name
  Return type: | str

  New in version NX10.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

  Setter Method

  Signature `Name`

  Parameters: | kitName (str) – machine kit name

  New in version NX10.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

## OutputDirectory

`MachineKitBuilder.``OutputDirectory`

  Returns or sets the machine kit output directory.

  This is the location of the machine folder.

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

  Getter Method

  Signature `OutputDirectory`

  Returns: | machine kit output directory
  Return type: | str

  New in version NX10.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

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

  Setter Method

  Signature `OutputDirectory`

  Parameters: | outputDirectory (str) – machine kit output directory

  New in version NX10.0.2.

  License requirements: ug_isv_full (“Full functionality for Integrated Simulation and Verification”) OR nx_isv_mtb (“Machine Tool Builder”)

# Method Detail

## Validate

`MachineKitBuilder.``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.