FilterBuilder Class¶
-
class
NXOpen.Features.ShipDesign.FilterBuilder¶ Bases:
NXOpen.BuilderA builder that allows the user to define common properties of ship objects and then add objects of similar properties to the select object list.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateFilterBuilder()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| CompareObject | Returns or sets the object that is used to compare the property values with. |
| 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. |
| FreeAvailableProperties | Frees the memory allocated by Features.ShipDesign.FilterBuilder.GetAvailableProperties() |
| GetAvailableProperties | Gets the names of the properties that can be chosen for filtering the selection. |
| 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. |
| GetPropertyStatus | Gets the current status true == on or selected, false == off or not selected of the input property. |
| IsObjectValid | Tests if the object is valid given the current status of the properties. |
| SetPropertyStatus | GSts the current status true == on or selected, false == off or not selected of the input property. |
| 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¶
CompareObject¶
-
FilterBuilder.CompareObject¶ Returns or sets the object that is used to compare the property values with.
-------------------------------------Getter Method
Signature
CompareObjectReturns: Return type: NXOpen.TaggedObjectNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CompareObjectParameters: compareObject ( NXOpen.TaggedObject) –New in version NX8.5.0.
License requirements: None.
Method Detail¶
FreeAvailableProperties¶
-
FilterBuilder.FreeAvailableProperties¶ Frees the memory allocated by
Features.ShipDesign.FilterBuilder.GetAvailableProperties()Signature
FreeAvailableProperties()Returns: Return type: list of str New in version NX8.5.0.
License requirements: None.
GetAvailableProperties¶
-
FilterBuilder.GetAvailableProperties¶ Gets the names of the properties that can be chosen for filtering the selection.
Signature
GetAvailableProperties()Returns: Return type: list of str New in version NX8.5.0.
License requirements: None.
GetPropertyStatus¶
-
FilterBuilder.GetPropertyStatus¶ Gets the current status true == on or selected, false == off or not selected of the input property.
Signature
GetPropertyStatus(property)Parameters: property (str) – Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
IsObjectValid¶
-
FilterBuilder.IsObjectValid¶ Tests if the object is valid given the current status of the properties.
Outputs true if the object passes the tests, false if it does not.
Signature
IsObjectValid(object)Parameters: object ( NXOpen.NXObject) –Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
SetPropertyStatus¶
-
FilterBuilder.SetPropertyStatus¶ GSts the current status true == on or selected, false == off or not selected of the input property.
Signature
SetPropertyStatus(property, onOrOff)Parameters: - property (str) –
- onOrOff (bool) –
New in version NX8.5.0.
License requirements: None.
Validate¶
-
FilterBuilder.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.