ExportMachineKitBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ExportMachineKitBuilder Class

class `NXOpen.SIM.``ExportMachineKitBuilder`

  Bases: `NXOpen.Builder`

  This class is used for the Export Machine Kit Dialog.

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

  Use `NXOpen.SIM.KinematicConfigurator.ExportMachineKitBuilder()` class to obtain an instance of this class.

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
KitName | Returns or sets the kit name specify the name of the package.
OutputDirectory | Returns or sets the machine kit output directory specify where the finished package will be stored.
PrintReport | Returns or sets the machine kit print report checkbox specify if a report will be plotted while create the kit or not.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AddKitDirectory | Add a subdirectory to the machine kit at the given directory.
AddKitFile | Add a file to the machine kit at the given directory.
AddKitFolder | Add a folder, all containing files and subfolder to the machine kit at the given directory.
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAllKitPaths | Returns a array of the the file paths that are already in the machine kit.
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.
RemovePathInKit | Removes the given file or directory in the machine kit.
RenameKitDirectory | Rename a directory to the machine kit at the given directory.
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

## KitName

`ExportMachineKitBuilder.``KitName`

  Returns or sets the kit name specify the name of the package.

  The name should be unique in the target directory.

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

  Getter Method

  Signature `KitName`

  Returns: | kit name
  Return type: | str

  New in version NX11.0.0.

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

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

  Setter Method

  Signature `KitName`

  Parameters: | kitName (str) – kit name

  New in version NX11.0.0.

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

## OutputDirectory

`ExportMachineKitBuilder.``OutputDirectory`

  Returns or sets the machine kit output directory specify where the finished package will be stored.

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

  Getter Method

  Signature `OutputDirectory`

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

  New in version NX11.0.0.

  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 NX11.0.0.

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

## PrintReport

`ExportMachineKitBuilder.``PrintReport`

  Returns or sets the machine kit print report checkbox specify if a report will be plotted while create the kit or not.

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

  Getter Method

  Signature `PrintReport`

  Returns: | print report flag
  Return type: | bool

  New in version NX11.0.0.

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

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

  Setter Method

  Signature `PrintReport`

  Parameters: | onOff (bool) – print report flag

  New in version NX11.0.0.

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

# Method Detail

## AddKitDirectory

`ExportMachineKitBuilder.``AddKitDirectory`

  Add a subdirectory to the machine kit at the given directory.

  The directory can be get in the function GetAllKitPaths.

  Signature `AddKitDirectory(directory, subDirectory)`

  Parameters:

  - directory (str) – directory in kit
  - subDirectory (str) – subdirectory name

  New in version NX11.0.0.

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

## AddKitFile

`ExportMachineKitBuilder.``AddKitFile`

  Add a file to the machine kit at the given directory.

  The directory can be get in the function GetAllKitPaths.

  Signature `AddKitFile(directory, file)`

  Parameters:

  - directory (str) – directory in kit
  - file (str) – file path on the hrd drive

  New in version NX11.0.0.

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

## AddKitFolder

`ExportMachineKitBuilder.``AddKitFolder`

  Add a folder, all containing files and subfolder to the machine kit at the given directory.

  The directory can be get in the function GetAllKitPaths.

  Signature `AddKitFolder(directory, folder)`

  Parameters:

  - directory (str) – directory in kit
  - folder (str) – folder path on the hrd drive

  New in version NX11.0.0.

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

## GetAllKitPaths

`ExportMachineKitBuilder.``GetAllKitPaths`

  Returns a array of the the file paths that are already in the machine kit.

  If you want to modify what will export with the kit, you need to specify the whole kit path. This function gives the opportunity. This function allocates the memory for kitPaths. The caller is responsible to deallocate the memory.

  Signature `GetAllKitPaths()`

  Returns: | array of all files of the machine kit
  Return type: | list of str

  New in version NX11.0.0.

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

## RemovePathInKit

`ExportMachineKitBuilder.``RemovePathInKit`

  Removes the given file or directory in the machine kit.

  The directory can be get in the function GetAllKitPaths.

  Signature `RemovePathInKit(directory)`

  Parameters: | directory (str) – directory in kit

  New in version NX11.0.0.

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

## RenameKitDirectory

`ExportMachineKitBuilder.``RenameKitDirectory`

  Rename a directory to the machine kit at the given directory.

  The directory can be get in the function GetAllKitPaths.

  Signature `RenameKitDirectory(directory, newDirectoryName)`

  Parameters:

  - directory (str) – directory path in kit
  - newDirectoryName (str) – new name of the directory

  New in version NX11.0.0.

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

## Validate

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