NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.SIM.ExportMachineKitBuilder Class Reference

This class is used for the Export Machine Kit Dialog. More...

Inheritance diagram for NXOpen.SIM.ExportMachineKitBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Member Functions

unsafe string[] GetAllKitPaths ()
 Returns a array of the the file paths that are already in the machine kit. More...
 
unsafe void AddKitFile (string directory, string file)
 Add a file to the machine kit at the given directory. More...
 
unsafe void AddKitFolder (string directory, string folder)
 Add a folder, all containing files and subfolder to the machine kit at the given directory. More...
 
unsafe void AddKitDirectory (string directory, string subDirectory)
 Add a subdirectory to the machine kit at the given directory. More...
 
unsafe void RenameKitDirectory (string directory, string newDirectoryName)
 Rename a directory to the machine kit at the given directory. More...
 
unsafe void RemovePathInKit (string directory)
 Removes the given file or directory in the machine kit. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Properties

unsafe string KitName [get, set]
 Returns or sets the kit name specify the name of the package. More...
 
unsafe string OutputDirectory [get, set]
 Returns or sets the machine kit output directory specify where the finished package will be stored. More...
 
unsafe bool PrintReport [get, set]
 Returns or sets the machine kit print report checkbox specify if a report will be plotted while create the kit or not. More...
 

Detailed Description

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 a null reference (Nothing in Visual Basic).

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

Created in NX11.0.0

Member Function Documentation

unsafe void NXOpen.SIM.ExportMachineKitBuilder.AddKitDirectory ( string  directory,
string  subDirectory 
)

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

The directory can be get in the function GetAllKitPaths.

Created in NX11.0.0

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

Parameters
directorydirectory in kit
subDirectorysubdirectory name
unsafe void NXOpen.SIM.ExportMachineKitBuilder.AddKitFile ( string  directory,
string  file 
)

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

The directory can be get in the function GetAllKitPaths.

Created in NX11.0.0

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

Parameters
directorydirectory in kit
filefile path on the hrd drive
unsafe void NXOpen.SIM.ExportMachineKitBuilder.AddKitFolder ( string  directory,
string  folder 
)

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.

Created in NX11.0.0

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

Parameters
directorydirectory in kit
folderfolder path on the hrd drive
unsafe string [] NXOpen.SIM.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.

Created in NX11.0.0

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

Returns
array of all files of the machine kit
unsafe void NXOpen.SIM.ExportMachineKitBuilder.RemovePathInKit ( string  directory)

Removes the given file or directory in the machine kit.

The directory can be get in the function GetAllKitPaths.

Created in NX11.0.0

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

Parameters
directorydirectory in kit
unsafe void NXOpen.SIM.ExportMachineKitBuilder.RenameKitDirectory ( string  directory,
string  newDirectoryName 
)

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

The directory can be get in the function GetAllKitPaths.

Created in NX11.0.0

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

Parameters
directorydirectory path in kit
newDirectoryNamenew name of the directory

Property Documentation

unsafe string NXOpen.SIM.ExportMachineKitBuilder.KitName
getset

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

The name should be unique in the target directory.

Created in NX11.0.0

License requirements to get this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

unsafe string NXOpen.SIM.ExportMachineKitBuilder.OutputDirectory
getset

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

Created in NX11.0.0

License requirements to get this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

unsafe bool NXOpen.SIM.ExportMachineKitBuilder.PrintReport
getset

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

Created in NX11.0.0

License requirements to get this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.