QueryPmiBuilder Class

class NXOpen.Annotations.QueryPmiBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Annotations.QueryPmiBuilder

To create a new instance of this class, use NXOpen.Annotations.AnnotationManager.CreateQueryPmiBuilder()

Default values.

Property	Value
CreateQueryResultsView	true

New in version NX5.0.0.

Properties

Property	Description
AreAllOccurrencesIncluded	Returns or sets an all occurrences of selected component to be included toggle
AreAttachedPmiIncluded	Returns or sets an attached pmi to selected geometry to be included toggle
AreReferencingMemberObjectsIncluded	Returns or sets a referencing member objects of selected geometry to be included toggle
CreateQueryResultsView	Returns or sets the create query results view.
Geometry	Returns the geometry
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.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

AreAllOccurrencesIncluded

QueryPmiBuilder.AreAllOccurrencesIncluded

Returns or sets an all occurrences of selected component to be included toggle

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

Getter Method

Signature AreAllOccurrencesIncluded

Returns: Return type:bool

New in version NX8.5.1.

License requirements: None.

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

Setter Method

Signature AreAllOccurrencesIncluded

Parameters:areOccurrencesIncluded (bool) –

New in version NX8.5.1.

License requirements: None.

AreAttachedPmiIncluded

QueryPmiBuilder.AreAttachedPmiIncluded

Returns or sets an attached pmi to selected geometry to be included toggle

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

Getter Method

Signature AreAttachedPmiIncluded

Returns: Return type:bool

New in version NX8.5.1.

License requirements: None.

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

Setter Method

Signature AreAttachedPmiIncluded

Parameters:areAttachedPMIIncluded (bool) –

New in version NX8.5.1.

License requirements: None.

AreReferencingMemberObjectsIncluded

QueryPmiBuilder.AreReferencingMemberObjectsIncluded

Returns or sets a referencing member objects of selected geometry to be included toggle

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

Getter Method

Signature AreReferencingMemberObjectsIncluded

Returns: Return type:bool

New in version NX8.5.1.

License requirements: None.

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

Setter Method

Signature AreReferencingMemberObjectsIncluded

Parameters:areReferencingMemberObjectsIncluded (bool) –

New in version NX8.5.1.

License requirements: None.

CreateQueryResultsView

QueryPmiBuilder.CreateQueryResultsView

Returns or sets the create query results view.

A value of false results in a temporary display that is not supported through NXOpen.

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

Getter Method

Signature CreateQueryResultsView

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature CreateQueryResultsView

Parameters:createQueryResultsView (bool) –

New in version NX8.5.0.

License requirements: None.

Geometry

QueryPmiBuilder.Geometry

Returns the geometry

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

Getter Method

Signature Geometry

Returns: Return type:NXOpen.SelectObjectList

New in version NX5.0.0.

License requirements: None.

Method Detail

Validate

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