A builder that allows the user to define common properties of ship objects and then add objects of similar properties to the select object list. More...
Public Member Functions | |
| NXOpen::TaggedObject * | CompareObject () |
| Returns the object that is used to compare the property values with. | |
| void | FreeAvailableProperties (std::vector< NXString > &properties) |
| Frees the memory allocated by Features::ShipDesign::FilterBuilder::GetAvailableProperties Created in NX8.5.0. | |
| void | GetAvailableProperties (std::vector< NXString > &properties) |
| Gets the names of the properties that can be chosen for filtering the selection. | |
| bool | GetPropertyStatus (const NXString &property) |
| Gets the current status true == on or selected, false == off or not selected of the input property. | |
| bool | GetPropertyStatus (const char *property) |
| Gets the current status true == on or selected, false == off or not selected of the input property. | |
| bool | IsObjectValid (NXOpen::NXObject *object) |
| Tests if the object is valid given the current status of the properties. | |
| void | SetCompareObject (NXOpen::TaggedObject *compareObject) |
| Sets the object that is used to compare the property values with. | |
| void | SetPropertyStatus (const NXString &property, bool onOrOff) |
| GSts the current status true == on or selected, false == off or not selected of the input property. | |
| void | SetPropertyStatus (const char *property, bool onOrOff) |
| GSts the current status true == on or selected, false == off or not selected of the input property. | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
Detailed Description
A 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 Features::ShipCollection::CreateFilterBuilder
Created in NX8.5.0.
Member Function Documentation
| NXOpen::TaggedObject* NXOpen::Features::ShipDesign::FilterBuilder::CompareObject | ( | ) |
Returns the object that is used to compare the property values with.
Created in NX8.5.0.
License requirements : None
| void NXOpen::Features::ShipDesign::FilterBuilder::FreeAvailableProperties | ( | std::vector< NXString > & | properties | ) |
Frees the memory allocated by Features::ShipDesign::FilterBuilder::GetAvailableProperties
Created in NX8.5.0.
License requirements : None
- Parameters
-
properties properties
| void NXOpen::Features::ShipDesign::FilterBuilder::GetAvailableProperties | ( | std::vector< NXString > & | properties | ) |
Gets the names of the properties that can be chosen for filtering the selection.
Created in NX8.5.0.
License requirements : None
- Parameters
-
properties properties
| bool NXOpen::Features::ShipDesign::FilterBuilder::GetPropertyStatus | ( | const NXString & | property | ) |
Gets the current status true == on or selected, false == off or not selected of the input property.
- Returns
Created in NX8.5.0.
License requirements : None
- Parameters
-
property
NOTE: The full Unicode character set is not supported for this parameter.
| bool NXOpen::Features::ShipDesign::FilterBuilder::GetPropertyStatus | ( | const char * | property | ) |
Gets the current status true == on or selected, false == off or not selected of the input property.
- Returns
Created in NX8.5.0.
License requirements : None
- Parameters
-
property
NOTE: The full Unicode character set is not supported for this parameter.
| bool NXOpen::Features::ShipDesign::FilterBuilder::IsObjectValid | ( | NXOpen::NXObject * | object | ) |
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.
- Returns
Created in NX8.5.0.
License requirements : None
- Parameters
-
object object
| void NXOpen::Features::ShipDesign::FilterBuilder::SetCompareObject | ( | NXOpen::TaggedObject * | compareObject | ) |
Sets the object that is used to compare the property values with.
Created in NX8.5.0.
License requirements : None
- Parameters
-
compareObject compareobject
| void NXOpen::Features::ShipDesign::FilterBuilder::SetPropertyStatus | ( | const NXString & | property, |
| bool | onOrOff | ||
| ) |
GSts the current status true == on or selected, false == off or not selected of the input property.
Created in NX8.5.0.
License requirements : None
- Parameters
-
property
NOTE: The full Unicode character set is not supported for this parameter.
onOrOff onoroff
| void NXOpen::Features::ShipDesign::FilterBuilder::SetPropertyStatus | ( | const char * | property, |
| bool | onOrOff | ||
| ) |
GSts the current status true == on or selected, false == off or not selected of the input property.
Created in NX8.5.0.
License requirements : None
- Parameters
-
property
NOTE: The full Unicode character set is not supported for this parameter.
onOrOff onoroff
The documentation for this class was generated from the following file:
- Features_ShipDesign_FilterBuilder.hxx