SuppressPMIBuilder Class¶
-
class
NXOpen.Annotations.
SuppressPMIBuilder
¶ Bases:
NXOpen.Builder
Represents Annotations.
SuppressPMIBuilder. This builder is used for controlling suppression of PMI objects either manually or through expressions. A suppressed PMI is not displayed and does not participate in most of the PMI operations. To create a new instance of this class, use
NXOpen.Annotations.PmiManager.CreateSuppressPmibuilder()
Default values.
Property Value SuppressionMethod None New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
SelectPMIObjects | Returns the selected pmi objects |
SuppressionMethod | Returns or sets the suppression method |
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. |
SelectExpression | Selects the expression for suppression when the method is Select Expression |
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¶
SuppressPMIBuilderSuppressionMethodType Enumeration | Suppression methods |
Property Detail¶
SelectPMIObjects¶
-
SuppressPMIBuilder.
SelectPMIObjects
¶ Returns the selected pmi objects
-------------------------------------
Getter Method
Signature
SelectPMIObjects
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX12.0.0.
License requirements: None.
SuppressionMethod¶
-
SuppressPMIBuilder.
SuppressionMethod
¶ Returns or sets the suppression method
-------------------------------------
Getter Method
Signature
SuppressionMethod
Returns: Return type: NXOpen.Annotations.SuppressPMIBuilderSuppressionMethodType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SuppressionMethod
Parameters: suppressionMethod ( NXOpen.Annotations.SuppressPMIBuilderSuppressionMethodType
) –New in version NX12.0.0.
License requirements: None.
Method Detail¶
SelectExpression¶
-
SuppressPMIBuilder.
SelectExpression
¶ Selects the expression for suppression when the method is Select Expression
Signature
SelectExpression(expression)
Parameters: expression ( NXOpen.Expression
) –New in version NX12.0.0.
License requirements: None.
Validate¶
-
SuppressPMIBuilder.
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.