GenerateReportsBuilder Class¶
-
class
NXOpen.AME.GenerateReportsBuilder¶ Bases:
NXOpen.BuilderComment
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateGenerateReportsBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| GenerateToProjectToggle | Returns or sets the generate to project toggle |
| GenerateToSystemToggle | Returns or sets the generate to system toggle |
| NativeFolderBrowser | Returns or sets the native folder browser |
| 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. |
| UpdateReportRuleStatus | The function updates the report rule status |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
GenerateToProjectToggle¶
-
GenerateReportsBuilder.GenerateToProjectToggle¶ Returns or sets the generate to project toggle
-------------------------------------Getter Method
Signature
GenerateToProjectToggleReturns: Return type: bool New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
GenerateToProjectToggleParameters: generateToProjectToggle (bool) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
GenerateToSystemToggle¶
-
GenerateReportsBuilder.GenerateToSystemToggle¶ Returns or sets the generate to system toggle
-------------------------------------Getter Method
Signature
GenerateToSystemToggleReturns: Return type: bool New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
GenerateToSystemToggleParameters: generateToSystemToggle (bool) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
NativeFolderBrowser¶
-
GenerateReportsBuilder.NativeFolderBrowser¶ Returns or sets the native folder browser
-------------------------------------Getter Method
Signature
NativeFolderBrowserReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
NativeFolderBrowserParameters: foldername (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
UpdateReportRuleStatus¶
-
GenerateReportsBuilder.UpdateReportRuleStatus¶ The function updates the report rule status
Signature
UpdateReportRuleStatus(ruleTag, status)Parameters: - ruleTag (int) –
- status (bool) –
New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Validate¶
-
GenerateReportsBuilder.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.