This class is used for the Export Machine Kit Dialog. More...
Public Member Functions | |
| void | AddKitDirectory (const NXString &directory, const NXString &subDirectory) |
| Add a subdirectory to the machine kit at the given directory. More... | |
| void | AddKitDirectory (const char *directory, const char *subDirectory) |
| Add a subdirectory to the machine kit at the given directory. More... | |
| void | AddKitFile (const NXString &directory, const NXString &file) |
| Add a file to the machine kit at the given directory. More... | |
| void | AddKitFile (const char *directory, const char *file) |
| Add a file to the machine kit at the given directory. More... | |
| void | AddKitFolder (const NXString &directory, const NXString &folder) |
| Add a folder, all containing files and subfolder to the machine kit at the given directory. More... | |
| void | AddKitFolder (const char *directory, const char *folder) |
| Add a folder, all containing files and subfolder to the machine kit at the given directory. More... | |
| std::vector< NXString > | GetAllKitPaths () |
| Returns a array of the the file paths that are already in the machine kit. More... | |
| NXString | KitName () |
| Returns the kit name specify the name of the package. More... | |
| NXString | OutputDirectory () |
| Returns the machine kit output directory specify where the finished package will be stored. More... | |
| bool | PrintReport () |
| Returns the machine kit print report checkbox specify if a report will be plotted while create the kit or not. More... | |
| void | RemovePathInKit (const NXString &directory) |
| Removes the given file or directory in the machine kit. More... | |
| void | RemovePathInKit (const char *directory) |
| Removes the given file or directory in the machine kit. More... | |
| void | RenameKitDirectory (const NXString &directory, const NXString &newDirectoryName) |
| Rename a directory to the machine kit at the given directory. More... | |
| void | RenameKitDirectory (const char *directory, const char *newDirectoryName) |
| Rename a directory to the machine kit at the given directory. More... | |
| void | SetKitName (const NXString &kitName) |
| Sets the kit name specify the name of the package. More... | |
| void | SetKitName (const char *kitName) |
| Sets the kit name specify the name of the package. More... | |
| void | SetOutputDirectory (const NXString &outputDirectory) |
| Sets the machine kit output directory specify where the finished package will be stored. More... | |
| void | SetOutputDirectory (const char *outputDirectory) |
| Sets the machine kit output directory specify where the finished package will be stored. More... | |
| void | SetPrintReport (bool onOff) |
| Sets the machine kit print report checkbox specify if a report will be plotted while create the kit or not. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. 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 NULL.
Use NXOpen::SIM::KinematicConfigurator::ExportMachineKitBuilder class to obtain an instance of this class.
Created in NX11.0.0.
Member Function Documentation
| void NXOpen::SIM::ExportMachineKitBuilder::AddKitDirectory | ( | const NXString & | directory, |
| const NXString & | 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
-
directory directory in kit subDirectory subdirectory name
| void NXOpen::SIM::ExportMachineKitBuilder::AddKitDirectory | ( | const char * | directory, |
| const char * | 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
-
directory directory in kit subDirectory subdirectory name
| void NXOpen::SIM::ExportMachineKitBuilder::AddKitFile | ( | const NXString & | directory, |
| const NXString & | 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
-
directory directory in kit file file path on the hrd drive
| void NXOpen::SIM::ExportMachineKitBuilder::AddKitFile | ( | const char * | directory, |
| const char * | 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
-
directory directory in kit file file path on the hrd drive
| void NXOpen::SIM::ExportMachineKitBuilder::AddKitFolder | ( | const NXString & | directory, |
| const NXString & | 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
-
directory directory in kit folder folder path on the hrd drive
| void NXOpen::SIM::ExportMachineKitBuilder::AddKitFolder | ( | const char * | directory, |
| const char * | 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
-
directory directory in kit folder folder path on the hrd drive
| std::vector<NXString> 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.
- Returns
- array of all files of the machine kit
Created in NX11.0.0.
License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
| NXString NXOpen::SIM::ExportMachineKitBuilder::KitName | ( | ) |
Returns 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 : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
| NXString NXOpen::SIM::ExportMachineKitBuilder::OutputDirectory | ( | ) |
Returns the machine kit output directory specify where the finished package will be stored.
Created in NX11.0.0.
License requirements : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
| bool NXOpen::SIM::ExportMachineKitBuilder::PrintReport | ( | ) |
Returns 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 : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
| void NXOpen::SIM::ExportMachineKitBuilder::RemovePathInKit | ( | const NXString & | 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
-
directory directory in kit
| void NXOpen::SIM::ExportMachineKitBuilder::RemovePathInKit | ( | const char * | 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
-
directory directory in kit
| void NXOpen::SIM::ExportMachineKitBuilder::RenameKitDirectory | ( | const NXString & | directory, |
| const NXString & | 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
-
directory directory path in kit newDirectoryName new name of the directory
| void NXOpen::SIM::ExportMachineKitBuilder::RenameKitDirectory | ( | const char * | directory, |
| const char * | 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
-
directory directory path in kit newDirectoryName new name of the directory
| void NXOpen::SIM::ExportMachineKitBuilder::SetKitName | ( | const NXString & | kitName | ) |
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 : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
- Parameters
-
kitName kit name
| void NXOpen::SIM::ExportMachineKitBuilder::SetKitName | ( | const char * | kitName | ) |
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 : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
- Parameters
-
kitName kit name
| void NXOpen::SIM::ExportMachineKitBuilder::SetOutputDirectory | ( | const NXString & | outputDirectory | ) |
Sets the machine kit output directory specify where the finished package will be stored.
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
-
outputDirectory machine kit output directory
| void NXOpen::SIM::ExportMachineKitBuilder::SetOutputDirectory | ( | const char * | outputDirectory | ) |
Sets the machine kit output directory specify where the finished package will be stored.
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
-
outputDirectory machine kit output directory
| void NXOpen::SIM::ExportMachineKitBuilder::SetPrintReport | ( | bool | onOff | ) |
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 : ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")
- Parameters
-
onOff print report flag
The documentation for this class was generated from the following file:
- SIM_ExportMachineKitBuilder.hxx