VirtuallabImporter Class¶
-
class
NXOpen.VirtuallabImporter¶ Bases:
NXOpen.BuilderRepresents a
VirtuallabImporterto be used when importing the Virtuallab Data This class is created usingDexManager. NULL object will be returned from Commit()To create a new instance of this class, use
NXOpen.DexManager.CreateVirtuallabImporter()Default values.
Property Value UseFileDirectory 1 New in version NX12.0.0.
Properties¶
| Property | Description |
|---|---|
| OutputDirectory | Returns or sets the output directory - where the sim file will be created |
| SettingsFile | Returns or sets the settings file - definition file for default options |
| Tag | Returns the Tag for this object. |
| UseFileDirectory | Returns or sets the use file directory - if set to true then sim files will be created in the same directory as the input file |
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. |
| SaveSettings | Save the settings - this will save the settings to a file specified |
| 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¶
OutputDirectory¶
-
VirtuallabImporter.OutputDirectory¶ Returns or sets the output directory - where the sim file will be created
-------------------------------------Getter Method
Signature
OutputDirectoryReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OutputDirectoryParameters: outputDirectory (str) – New in version NX12.0.0.
License requirements: None.
SettingsFile¶
-
VirtuallabImporter.SettingsFile¶ Returns or sets the settings file - definition file for default options
-------------------------------------Getter Method
Signature
SettingsFileReturns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SettingsFileParameters: filename (str) – New in version NX12.0.0.
License requirements: None.
UseFileDirectory¶
-
VirtuallabImporter.UseFileDirectory¶ Returns or sets the use file directory - if set to true then sim files will be created in the same directory as the input file
-------------------------------------Getter Method
Signature
UseFileDirectoryReturns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseFileDirectoryParameters: useFileDirectory (bool) – New in version NX12.0.0.
License requirements: None.
Method Detail¶
SaveSettings¶
-
VirtuallabImporter.SaveSettings¶ Save the settings - this will save the settings to a file specified
Signature
SaveSettings(filename)Parameters: filename (str) – New in version NX12.0.0.
License requirements: None.
Validate¶
-
VirtuallabImporter.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.