NXOpen.Features.ShipDesign.FilterBuilder Class Reference

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

Inheritance diagram for NXOpen.Features.ShipDesign.FilterBuilder:

Public Member Functions
unsafe void	FreeAvailableProperties (out string[] properties)
	Frees the memory allocated by Features.ShipDesign.FilterBuilder.GetAvailableProperties More...
unsafe void	GetAvailableProperties (out string[] properties)
	Gets the names of the properties that can be chosen for filtering the selection. More...
unsafe bool	GetPropertyStatus (string property)
	Gets the current status true == on or selected, false == off or not selected of the input property. More...
unsafe bool	IsObjectValid (NXOpen.NXObject @object)
	Tests if the object is valid given the current status of the properties. More...
unsafe void	SetPropertyStatus (string 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
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...
unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...
unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
override string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.TaggedObject	CompareObject [get, set]
	Returns or sets the object that is used to compare the property values with. More...
Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder [get]
	Returns the preview builder subobject. More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

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 NXOpen.Features.ShipCollection.CreateFilterBuilder

Created in NX8.5.0

Member Function Documentation

unsafe void NXOpen.Features.ShipDesign.FilterBuilder.FreeAvailableProperties ( out string[]  properties )

inline

Frees the memory allocated by Features.ShipDesign.FilterBuilder.GetAvailableProperties

Created in NX8.5.0

License requirements: None.

Parameters

properties

unsafe void NXOpen.Features.ShipDesign.FilterBuilder.GetAvailableProperties ( out string[]  properties )

inline

Gets the names of the properties that can be chosen for filtering the selection.

Created in NX8.5.0

License requirements: None.

Parameters

properties

unsafe bool NXOpen.Features.ShipDesign.FilterBuilder.GetPropertyStatus ( string  property )

inline

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.

Parameters

property

Returns

unsafe bool NXOpen.Features.ShipDesign.FilterBuilder.IsObjectValid ( NXOpen.NXObject @  object )

inline

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.

Parameters

object

Returns

unsafe void NXOpen.Features.ShipDesign.FilterBuilder.SetPropertyStatus ( string  property, bool  onOrOff  )

inline

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
onOrOff

Property Documentation

unsafe NXOpen.TaggedObject NXOpen.Features.ShipDesign.FilterBuilder.CompareObject

getset

Returns or sets the object that is used to compare the property values with.

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: None.

---

The documentation for this class was generated from the following file:

• Features_ShipDesign_FilterBuilder.cs