NXOpen C++ Reference Guide
|
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. More... | |
void | FreeAvailableProperties (std::vector< NXString > &properties) |
Frees the memory allocated by Features::ShipDesign::FilterBuilder::GetAvailableProperties Created in NX8.5.0. More... | |
void | GetAvailableProperties (std::vector< NXString > &properties) |
Gets the names of the properties that can be chosen for filtering the selection. More... | |
bool | GetPropertyStatus (const NXString &property) |
Gets the current status true == on or selected, false == off or not selected of the input property. More... | |
bool | GetPropertyStatus (const char *property) |
Gets the current status true == on or selected, false == off or not selected of the input property. More... | |
bool | IsObjectValid (NXOpen::NXObject *object) |
Tests if the object is valid given the current status of the properties. More... | |
void | SetCompareObject (NXOpen::TaggedObject *compareObject) |
Sets the object that is used to compare the property values with. More... | |
void | SetPropertyStatus (const NXString &property, bool onOrOff) |
GSts the current status true == on or selected, false == off or not selected of the input property. More... | |
void | SetPropertyStatus (const char *property, bool onOrOff) |
GSts the current status true == on or selected, false == off or not selected of the input property. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
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 NXOpen::Features::ShipCollection::CreateFilterBuilder
Created in NX8.5.0.
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
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
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.
Created in NX8.5.0.
License requirements : None
property | property |
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.
Created in NX8.5.0.
License requirements : None
property | property |
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.
Created in NX8.5.0.
License requirements : None
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
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
property | property |
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
property | property |
onOrOff | onoroff |