Represents a Product Interface Object Builder. More...

Inheritance diagram for NXOpen.Assemblies.ProductInterface.ObjectBuilder:

Public Types
enum	BuilderVersion { Original, One, Two, Three }
	Version number of product interface builder. More...

enum	Mate { NoCheck, Warn, Prevent }
	An enum representing the settings available for rule checking during creation of mating conditions More...

enum	Wave { NoCheck, Warn, Prevent }
	An enum representing settings available for rule checking during creation of WAVE geomtery and interpart expressions More...

Public Member Functions
unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject	AddProductInterface (NXOpen.NXObject nxItem, out bool alreadyExisted)
	Adds an object to the product interface; currently supported types are expressions and geometry. More...

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject	AddProductInterfaceObject (NXOpen.NXObject nxItem)
	Adds an object to the product interface; currently supported types are expressions and geometry More...

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject	AddProductInterfaceObject1 (NXOpen.NXObject nxObject, string name, string description, bool reverseDirection)
	Adds an object to the product interface; currently supported types are expressions and geometry More...

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject	AddProductInterfaceObject2 (NXOpen.NXObject nxObject, string name, string description, bool reverseDirection, NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType interfaceUsageType)
	Adds an object to the product interface; currently supported types are expressions and geometry. More...

unsafe void	EditProductInterfaceObject (NXOpen.Assemblies.ProductInterface.InterfaceObject productInterface, NXOpen.NXObject nxObject, string name, string description, bool reverseDirection)
	Edits a product interface object More...

unsafe void	EditProductInterfaceObject1 (NXOpen.Assemblies.ProductInterface.InterfaceObject productInterface, NXOpen.NXObject nxObject, string name, string description, bool reverseDirection, NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType interfaceUsageType)
	Edits a product interface object with interface object type . More...

unsafe NXOpen.Assemblies.ProductInterface.ObjectBuilder.BuilderVersion	GetBuilderVersion ()
	Gets the version of this builder. More...

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject[]	QueryProductInterfaceObjects (NXOpen.NXObject part)
	Returns a list of product interface objects in the part More...

unsafe void	RemoveProductInterfaceObject (NXOpen.Assemblies.ProductInterface.InterfaceObject prodIntItem)
	Removes an object from the product interface; currently supported types are expressions and geometry More...

unsafe void	SetBuilderVersion (NXOpen.Assemblies.ProductInterface.ObjectBuilder.BuilderVersion version)
	Sets the version of this builder. More...

unsafe void	SetUserComments (NXOpen.Assemblies.ProductInterface.InterfaceObject prodIntItem, string userComments)
	Sets the user comments on the product interface item passed in More...

unsafe void	UpdateAttributesFromPart (NXOpen.NXObject part)
	Updates the attributes of the product interface items in the part 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.Assemblies.ProductInterface.ObjectBuilder.Mate	MateSetting `[get, set]`
	Returns or sets the current rule setting for use during creation of mating conditions More...

unsafe NXOpen.Features.PartGeometryCopyBuilder	PartGeometryCopy `[get]`
	Returns the part geometry copy More...

unsafe NXOpen.Assemblies.ProductInterface.ObjectBuilder.Wave	WaveSetting `[get, set]`
	Returns or sets the current rule setting for use during creation of WAVE geomtery and interpart expressions 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

Represents a Product Interface Object Builder.

It creates a set of product interface objects

To create a new instance of this class, use NXOpen.Assemblies.ProductInterface.Collection.CreateObjectBuilderWithBuilderVersion

Default values.

Property

Value

PartGeometryCopy.ObjectType

BodyCollector

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.Assemblies.ProductInterface.ObjectBuilder.BuilderVersion

Version number of product interface builder.

The new version is added when new function is added to the product interface. The old versions are kept since user can still use the old recorded NXOpen function.

Enumerator
Original	linked feature cannot select the product interface item
One	linked feature can directly select the product interface item
Two	product interface builder supports composite curve, composite face and body collector options
Three	Enables product interface types but used along with the 'Enable Product Interface Type' customer default

enum NXOpen.Assemblies.ProductInterface.ObjectBuilder.Mate

An enum representing the settings available for rule checking during creation of mating conditions

Enumerator
NoCheck	no checking for product interface objects
Warn	warn user while using non product interface objects
Prevent	restrict user from using non product interface objects

enum NXOpen.Assemblies.ProductInterface.ObjectBuilder.Wave

An enum representing settings available for rule checking during creation of WAVE geomtery and interpart expressions

Enumerator
NoCheck	no checking for product interface objects
Warn	warn user while using non product interface objects
Prevent	restrict user from using non product interface objects

Member Function Documentation

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject NXOpen.Assemblies.ProductInterface.ObjectBuilder.AddProductInterface	(	NXOpen.NXObject	nxItem,
		out bool	alreadyExisted
	)

inline

Adds an object to the product interface; currently supported types are expressions and geometry.

If the object already exists, it becomes active.

Created in NX8.5.1

License requirements: None.

Parameters

nxItem	nx item to be added to the product interface
alreadyExisted

Returns: the product interface object created or modified

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject NXOpen.Assemblies.ProductInterface.ObjectBuilder.AddProductInterfaceObject ( NXOpen.NXObject nxItem )

inline

Adds an object to the product interface; currently supported types are expressions and geometry

Created in NX5.0.0

License requirements: None.

Parameters

nxItem nx item to be added to the product interface

Returns: the product interface object created

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject NXOpen.Assemblies.ProductInterface.ObjectBuilder.AddProductInterfaceObject1	(	NXOpen.NXObject	nxObject,
		string	name,
		string	description,
		bool	reverseDirection
	)

inline

Adds an object to the product interface; currently supported types are expressions and geometry

Created in NX9.0.0

License requirements: None.

Parameters

nxObject	Selected object to add
name	User defined name of selected object
description	User comments of selected object
reverseDirection	Flag to specify whether to reverse the direction of the source object

Returns: the product interface object created

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject NXOpen.Assemblies.ProductInterface.ObjectBuilder.AddProductInterfaceObject2	(	NXOpen.NXObject	nxObject,
		string	name,
		string	description,
		bool	reverseDirection,
		NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType	interfaceUsageType
	)

inline

Adds an object to the product interface; currently supported types are expressions and geometry.

Interface Usage type can be set using this API.

Created in NX12.0.0

License requirements: None.

Parameters

nxObject	Selected object to add
name	User defined name of selected object
description	User comments of selected object
reverseDirection	Flag to specify whether to reverse the direction of the source object
interfaceUsageType	Usage type of product interface object

Returns: the product interface object created

unsafe void NXOpen.Assemblies.ProductInterface.ObjectBuilder.EditProductInterfaceObject	(	NXOpen.Assemblies.ProductInterface.InterfaceObject	productInterface,
		NXOpen.NXObject	nxObject,
		string	name,
		string	description,
		bool	reverseDirection
	)

inline

Edits a product interface object

Created in NX9.0.0

License requirements: None.

Parameters

productInterface	Product interface object to be edited
nxObject	Selected object to add
name	User defined name of selected object
description	User comments of selected object
reverseDirection	Flag to specify whether to reverse the direction of the source object

unsafe void NXOpen.Assemblies.ProductInterface.ObjectBuilder.EditProductInterfaceObject1	(	NXOpen.Assemblies.ProductInterface.InterfaceObject	productInterface,
		NXOpen.NXObject	nxObject,
		string	name,
		string	description,
		bool	reverseDirection,
		NXOpen.Assemblies.ProductInterface.InterfaceObject.InterfaceUsageType	interfaceUsageType
	)

inline

Edits a product interface object with interface object type .

Interface Usage type can be set using this API.

Created in NX12.0.0

License requirements: None.

Parameters

productInterface	Product interface object to be edited
nxObject	Selected object to add
name	User defined name of selected object
description	User comments of selected object
reverseDirection	Flag to specify whether to reverse the direction of the source object
interfaceUsageType	Usage type of product interface object

unsafe NXOpen.Assemblies.ProductInterface.ObjectBuilder.BuilderVersion NXOpen.Assemblies.ProductInterface.ObjectBuilder.GetBuilderVersion ( )

inline

Gets the version of this builder.

Created in NX9.0.0

License requirements: None.

Returns

unsafe NXOpen.Assemblies.ProductInterface.InterfaceObject [] NXOpen.Assemblies.ProductInterface.ObjectBuilder.QueryProductInterfaceObjects ( NXOpen.NXObject part )

inline

Returns a list of product interface objects in the part

Created in NX5.0.0

License requirements: None.

Parameters

part	part whose product interface objects have to be queried

Returns: objects in the product interface

unsafe void NXOpen.Assemblies.ProductInterface.ObjectBuilder.RemoveProductInterfaceObject ( NXOpen.Assemblies.ProductInterface.InterfaceObject prodIntItem )

inline

Removes an object from the product interface; currently supported types are expressions and geometry

Created in NX5.0.0

License requirements: None.

Parameters

prodIntItem product interface object to be removed from the product interface set

unsafe void NXOpen.Assemblies.ProductInterface.ObjectBuilder.SetBuilderVersion ( NXOpen.Assemblies.ProductInterface.ObjectBuilder.BuilderVersion version )

inline

Sets the version of this builder.

Created in NX9.0.0

License requirements: None.

Parameters

version

unsafe void NXOpen.Assemblies.ProductInterface.ObjectBuilder.SetUserComments	(	NXOpen.Assemblies.ProductInterface.InterfaceObject	prodIntItem,
		string	userComments
	)

inline

Sets the user comments on the product interface item passed in

Created in NX5.0.0

License requirements: None.

Parameters

prodIntItem	product interface item on which the user comments have to set
userComments	user comments to be set on specified product interface item

unsafe void NXOpen.Assemblies.ProductInterface.ObjectBuilder.UpdateAttributesFromPart ( NXOpen.NXObject part )

inline

Updates the attributes of the product interface items in the part

Created in NX5.0.0

License requirements: None.

Parameters

part	part, product interface objects of which need to have their attributes updated

Property Documentation

unsafe NXOpen.Assemblies.ProductInterface.ObjectBuilder.Mate NXOpen.Assemblies.ProductInterface.ObjectBuilder.MateSetting

getset

Returns or sets the current rule setting for use during creation of mating conditions

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Features.PartGeometryCopyBuilder NXOpen.Assemblies.ProductInterface.ObjectBuilder.PartGeometryCopy

get

Returns the part geometry copy

Created in NX9.0.0

License requirements: None.

unsafe NXOpen.Assemblies.ProductInterface.ObjectBuilder.Wave NXOpen.Assemblies.ProductInterface.ObjectBuilder.WaveSetting

getset

Returns or sets the current rule setting for use during creation of WAVE geomtery and interpart expressions

Created in NX5.0.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:

Assemblies_ProductInterface_ObjectBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation