ReportsSettingsBuilder Class

class NXOpen.AME.ReportsSettingsBuilder

Bases: NXOpen.Builder

interface for the ReportsSettingsBuilder

To create a new instance of this class, use NXOpen.AME.AMEManager.CreateReportsSettingsBuilder()

New in version NX11.0.0.

Properties

Property	Description
FunctionAspect	Returns or sets the function aspect
LocationAspect	Returns or sets the location aspect
ProductAspect	Returns or sets the product aspect
ReportName	Returns or sets the string report name
ReportTemplateName	Returns or sets the report template name
ReportType	Returns or sets the selected report template type
SelectClassification	Returns the selected classification
SelectedRule	Returns or sets the selected report rule
Tag	Returns the Tag for this object.
WholeProjectToggle	Returns or sets the whole project toggle

Methods

Method	Description
AddRule	Add new report rule
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.
RemoveRule	Remove report rule
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

FunctionAspect

ReportsSettingsBuilder.FunctionAspect

Returns or sets the function aspect

-------------------------------------

Getter Method

Signature FunctionAspect

Returns: Return type:bool

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature FunctionAspect

Parameters:functionAspect (bool) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

LocationAspect

ReportsSettingsBuilder.LocationAspect

Returns or sets the location aspect

-------------------------------------

Getter Method

Signature LocationAspect

Returns: Return type:bool

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature LocationAspect

Parameters:locationAspect (bool) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ProductAspect

ReportsSettingsBuilder.ProductAspect

Returns or sets the product aspect

-------------------------------------

Getter Method

Signature ProductAspect

Returns: Return type:bool

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature ProductAspect

Parameters:productAspect (bool) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ReportName

ReportsSettingsBuilder.ReportName

Returns or sets the string report name

-------------------------------------

Getter Method

Signature ReportName

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature ReportName

Parameters:reportName (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ReportTemplateName

ReportsSettingsBuilder.ReportTemplateName

Returns or sets the report template name

-------------------------------------

Getter Method

Signature ReportTemplateName

Returns: Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature ReportTemplateName

Parameters:reportTemplateName (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ReportType

ReportsSettingsBuilder.ReportType

Returns or sets the selected report template type

-------------------------------------

Getter Method

Signature ReportType

Returns: Return type:NXOpen.AME.PageBuilderTypes

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature ReportType

Parameters:reportType (NXOpen.AME.PageBuilderTypes) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectClassification

ReportsSettingsBuilder.SelectClassification

Returns the selected classification

-------------------------------------

Getter Method

Signature SelectClassification

Returns: Return type:NXOpen.AME.SelectClassificationBuilder

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectedRule

ReportsSettingsBuilder.SelectedRule

Returns or sets the selected report rule

-------------------------------------

Getter Method

Signature SelectedRule

Returns: Return type:int

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature SelectedRule

Parameters:selectedRule (int) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

WholeProjectToggle

ReportsSettingsBuilder.WholeProjectToggle

Returns or sets the whole project toggle

-------------------------------------

Getter Method

Signature WholeProjectToggle

Returns: Return type:bool

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature WholeProjectToggle

Parameters:wholeProjectToggle (bool) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

AddRule

ReportsSettingsBuilder.AddRule

Add new report rule

Signature AddRule()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

RemoveRule

ReportsSettingsBuilder.RemoveRule

Remove report rule

Signature RemoveRule()

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

ReportsSettingsBuilder.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.