EditClauseBuilder Class¶

class NXOpen.AME.EditClauseBuilder¶

Bases: NXOpen.Builder

Naming Rule Builder

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

Default values.

Property	Value
AllAspects	0
AspectOperator	Under
ClassificationOperator	As
ClauseOperator	And
ReuseLibraryOperator	OfType

New in version NX11.0.0.

Properties¶

Property	Description
AllAspects	Returns or sets the all aspects option status whether ON or OFF
AspectOperator	Returns or sets the query operator for Aspect object
ClassificationOperator	Returns or sets the query operator for Classification object
ClauseOperator	Returns or sets the clause operator of query
ReuseLibraryOperator	Returns or sets the query operator for Reuse Library object
SelectAspect	Returns the selected aspect
SelectClassification	Returns the selected classification
SelectFromMemberSelect	Returns the engineering object definition
SelectLibraryObject	Returns the engineering object definition or product definition
SelectedQuery	Returns or sets the query object
SelectedQueryClause	Returns or sets the selected query clause
Tag	Returns the Tag for this object.
Type	Returns or sets the type of object to be used for edit clause `NXOpen.AME.EditClauseBuilder.Type()`

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.
SetProperty	Set the property
SetPropertyOperator	Set the property operator
SetPropertyValue	Set the property value
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.

Enumerations¶

EditClauseBuilderOperator Enumeration	the query operator
EditClauseBuilderQueryClauseOperatorType Enumeration	the clause operator
EditClauseBuilderTypes Enumeration	the type of object to be used for edit clause

Property Detail¶

AllAspects¶

EditClauseBuilder.AllAspects¶

Returns or sets the all aspects option status whether ON or OFF

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

Getter Method

Signature AllAspects

Returns:
Return type:	bool

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature AllAspects

Parameters:	toggleAllAspects (bool) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

AspectOperator¶

EditClauseBuilder.AspectOperator¶

Returns or sets the query operator for Aspect object

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

Getter Method

Signature AspectOperator

Returns:
Return type:	`NXOpen.AME.EditClauseBuilderOperator`

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature AspectOperator

Parameters:	aspectOperator (`NXOpen.AME.EditClauseBuilderOperator`) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ClassificationOperator¶

EditClauseBuilder.ClassificationOperator¶

Returns or sets the query operator for Classification object

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

Getter Method

Signature ClassificationOperator

Returns:
Return type:	`NXOpen.AME.EditClauseBuilderOperator`

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ClassificationOperator

Parameters:	classificationOperator (`NXOpen.AME.EditClauseBuilderOperator`) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ClauseOperator¶

EditClauseBuilder.ClauseOperator¶

Returns or sets the clause operator of query

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

Getter Method

Signature ClauseOperator

Returns:
Return type:	`NXOpen.AME.EditClauseBuilderQueryClauseOperatorType`

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ClauseOperator

Parameters:	clauseOperator (`NXOpen.AME.EditClauseBuilderQueryClauseOperatorType`) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ReuseLibraryOperator¶

EditClauseBuilder.ReuseLibraryOperator¶

Returns or sets the query operator for Reuse Library object

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

Getter Method

Signature ReuseLibraryOperator

Returns:
Return type:	`NXOpen.AME.EditClauseBuilderOperator`

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature ReuseLibraryOperator

Parameters:	reuseLibraryOperator (`NXOpen.AME.EditClauseBuilderOperator`) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectAspect¶

EditClauseBuilder.SelectAspect¶

Returns the selected aspect

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

Getter Method

Signature SelectAspect

Returns:
Return type:	`NXOpen.AME.SelectAMEBaseNode`

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectClassification¶

EditClauseBuilder.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”)

SelectFromMemberSelect¶

EditClauseBuilder.SelectFromMemberSelect¶

Returns the engineering object definition

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

Getter Method

Signature SelectFromMemberSelect

Returns:
Return type:	`NXOpen.AME.SelectionEngineeringObjectDefinitionBuilder`

New in version NX11.0.0.

Deprecated since version NX12.0.0: Use SelectLibraryObject() instead.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectLibraryObject¶

EditClauseBuilder.SelectLibraryObject¶

Returns the engineering object definition or product definition

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

Getter Method

Signature SelectLibraryObject

Returns:
Return type:	`NXOpen.AME.SelectionBaseDefinitionBuilder`

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectedQuery¶

EditClauseBuilder.SelectedQuery¶

Returns or sets the query object

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

Getter Method

Signature SelectedQuery

Returns:
Return type:	`NXOpen.AME.AMEQuery`

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SelectedQuery

Parameters:	selectedQuery (`NXOpen.AME.AMEQuery`) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectedQueryClause¶

EditClauseBuilder.SelectedQueryClause¶

Returns or sets the selected query clause

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

Getter Method

Signature SelectedQueryClause

Returns:
Return type:	`NXOpen.AME.QueryClause`

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature SelectedQueryClause

Parameters:	selectedClause (`NXOpen.AME.QueryClause`) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Type¶

EditClauseBuilder.Type¶

Returns or sets the type of object to be used for edit clause NXOpen.AME.EditClauseBuilder.Type()

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

Getter Method

Signature Type

Returns:
Return type:	`NXOpen.AME.EditClauseBuilderTypes`

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Type

Parameters:	type (`NXOpen.AME.EditClauseBuilderTypes`) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail¶

SetProperty¶

EditClauseBuilder.SetProperty¶

Set the property

Signature SetProperty(index, propertyName)

Parameters:	index (int) – propertyName (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetPropertyOperator¶

EditClauseBuilder.SetPropertyOperator¶

Set the property operator

Signature SetPropertyOperator(index, propertyOperator)

Parameters:	index (int) – propertyOperator (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SetPropertyValue¶

EditClauseBuilder.SetPropertyValue¶

Set the property value

Signature SetPropertyValue(index, propertyValue)

Parameters:	index (int) – propertyValue (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate¶

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

EditClauseBuilder Class¶

Properties¶

Methods¶

Enumerations¶

Property Detail¶

AllAspects¶

AspectOperator¶

ClassificationOperator¶

ClauseOperator¶

ReuseLibraryOperator¶

SelectAspect¶

SelectClassification¶

SelectFromMemberSelect¶

SelectLibraryObject¶

SelectedQuery¶

SelectedQueryClause¶

Type¶

Method Detail¶

SetProperty¶

SetPropertyOperator¶

SetPropertyValue¶

Validate¶

NXOpen Python API Reference

Navigation

Related Topics