Represents a Product Interface Object Builder. More...

Inheritance diagram for NXOpen::Assemblies::ProductInterface::ObjectBuilder:

Public Types
enum	BuilderVersion { BuilderVersionOriginal, BuilderVersionOne }
	Version number of product interface builder. More...

enum	Mate { MateNoCheck, MateWarn, MatePrevent }
	An enum representing the settings available for rule checking during creation of mating conditions. More...

enum	Wave { WaveNoCheck, WaveWarn, WavePrevent }
	An enum representing settings available for rule checking during creation of WAVE geomtery and interpart expressions. More...

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

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

NXOpen::Assemblies::ProductInterface::InterfaceObject *	AddProductInterfaceObject1 (NXOpen::NXObject *nxObject, const NXString &name, const NXString &description, bool reverseDirection)
	Adds an object to the product interface; currently supported types are expressions and geometry.

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

void	EditProductInterfaceObject (NXOpen::Assemblies::ProductInterface::InterfaceObject productInterface, NXOpen::NXObject nxObject, const NXString &name, const NXString &description, bool reverseDirection)
	Edits a product interface object Created in NX9.0.0.

void	EditProductInterfaceObject (NXOpen::Assemblies::ProductInterface::InterfaceObject productInterface, NXOpen::NXObject nxObject, const char name, const char description, bool reverseDirection)
	Edits a product interface object Created in NX9.0.0.

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

NXOpen::Assemblies::ProductInterface::ObjectBuilder::Mate	MateSetting ()
	Returns the current rule setting for use during creation of mating conditions Created in NX5.0.0.

NXOpen::Features::PartGeometryCopyBuilder *	PartGeometryCopy ()
	Returns the part geometry copy Created in NX9.0.0.

std::vector < NXOpen::Assemblies::ProductInterface::InterfaceObject * >	QueryProductInterfaceObjects (NXOpen::NXObject *part)
	Returns a list of product interface objects in the part.

void	RemoveProductInterfaceObject (NXOpen::Assemblies::ProductInterface::InterfaceObject *prodIntItem)
	Removes an object from the product interface; currently supported types are expressions and geometry Created in NX5.0.0.

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

void	SetMateSetting (NXOpen::Assemblies::ProductInterface::ObjectBuilder::Mate mateSetting)
	Sets the current rule setting for use during creation of mating conditions Created in NX5.0.0.

void	SetUserComments (NXOpen::Assemblies::ProductInterface::InterfaceObject *prodIntItem, const NXString &userComments)
	Sets the user comments on the product interface item passed in Created in NX5.0.0.

void	SetUserComments (NXOpen::Assemblies::ProductInterface::InterfaceObject prodIntItem, const char userComments)
	Sets the user comments on the product interface item passed in Created in NX5.0.0.

void	SetWaveSetting (NXOpen::Assemblies::ProductInterface::ObjectBuilder::Wave waveSetting)
	Sets the current rule setting for use during creation of WAVE geomtery and interpart expressions Created in NX5.0.0.

void	UpdateAttributesFromPart (NXOpen::NXObject *part)
	Updates the attributes of the product interface items in the part Created in NX5.0.0.

NXOpen::Assemblies::ProductInterface::ObjectBuilder::Wave	WaveSetting ()
	Returns the current rule setting for use during creation of WAVE geomtery and interpart expressions Created in NX5.0.0.

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

Represents a Product Interface Object Builder.

It creates a set of product interface objects
To create a new instance of this class, use Assemblies::ProductInterface::Collection::CreateObjectBuilder
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.

Enumerator:

BuilderVersionOriginal	linked feature cannot select the product interface item
BuilderVersionOne	linked feature can directly select the product interface item

enum NXOpen::Assemblies::ProductInterface::ObjectBuilder::Mate

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

Enumerator:

MateNoCheck	no checking for product interface objects
MateWarn	warn user while using non product interface objects
MatePrevent	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:

WaveNoCheck	no checking for product interface objects
WaveWarn	warn user while using non product interface objects
WavePrevent	restrict user from using non product interface objects

Member Function Documentation

NXOpen::Assemblies::ProductInterface::InterfaceObject* NXOpen::Assemblies::ProductInterface::ObjectBuilder::AddProductInterface	(	NXOpen::NXObject *	nxItem,
		bool *	alreadyExisted
	)

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

If the object already exists, it becomes active.

Returns: the product interface object created or modified
Created in NX8.5.1.

License requirements : None

Parameters

nxItem	nx item to be added to the product interface
alreadyExisted	alreadyexisted

NXOpen::Assemblies::ProductInterface::InterfaceObject* NXOpen::Assemblies::ProductInterface::ObjectBuilder::AddProductInterfaceObject ( NXOpen::NXObject * nxItem )

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

Returns: the product interface object created
Created in NX5.0.0.

License requirements : None

Parameters

nxItem nx item to be added to the product interface

NXOpen::Assemblies::ProductInterface::InterfaceObject* NXOpen::Assemblies::ProductInterface::ObjectBuilder::AddProductInterfaceObject1	(	NXOpen::NXObject *	nxObject,
		const NXString &	name,
		const NXString &	description,
		bool	reverseDirection
	)

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

Returns: the product interface object created
Created in NX9.0.0.

License requirements : None

Parameters

nxObject	Selected object to add
name	User defined name of selected object NOTE: The full Unicode character set is not supported for this parameter.
description	User comments of selected object NOTE: The full Unicode character set is not supported for this parameter.
reverseDirection	Flag to specify whether to reverse the direction of the source object

NXOpen::Assemblies::ProductInterface::InterfaceObject* NXOpen::Assemblies::ProductInterface::ObjectBuilder::AddProductInterfaceObject1	(	NXOpen::NXObject *	nxObject,
		const char *	name,
		const char *	description,
		bool	reverseDirection
	)

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

Returns: the product interface object created
Created in NX9.0.0.

License requirements : None

Parameters

nxObject	Selected object to add
name	User defined name of selected object NOTE: The full Unicode character set is not supported for this parameter.
description	User comments of selected object NOTE: The full Unicode character set is not supported for this parameter.
reverseDirection	Flag to specify whether to reverse the direction of the source object

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::EditProductInterfaceObject	(	NXOpen::Assemblies::ProductInterface::InterfaceObject *	productInterface,
		NXOpen::NXObject *	nxObject,
		const NXString &	name,
		const NXString &	description,
		bool	reverseDirection
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
description	User comments of selected object NOTE: The full Unicode character set is not supported for this parameter.
reverseDirection	Flag to specify whether to reverse the direction of the source object

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::EditProductInterfaceObject	(	NXOpen::Assemblies::ProductInterface::InterfaceObject *	productInterface,
		NXOpen::NXObject *	nxObject,
		const char *	name,
		const char *	description,
		bool	reverseDirection
	)

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 NOTE: The full Unicode character set is not supported for this parameter.
description	User comments of selected object NOTE: The full Unicode character set is not supported for this parameter.
reverseDirection	Flag to specify whether to reverse the direction of the source object

NXOpen::Assemblies::ProductInterface::ObjectBuilder::BuilderVersion NXOpen::Assemblies::ProductInterface::ObjectBuilder::GetBuilderVersion ( )

Gets the version of this builder.

Returns: Created in NX9.0.0.

License requirements : None

NXOpen::Assemblies::ProductInterface::ObjectBuilder::Mate NXOpen::Assemblies::ProductInterface::ObjectBuilder::MateSetting ( )

Returns the current rule setting for use during creation of mating conditions
Created in NX5.0.0.

License requirements : None

NXOpen::Features::PartGeometryCopyBuilder* NXOpen::Assemblies::ProductInterface::ObjectBuilder::PartGeometryCopy ( )

Returns the part geometry copy
Created in NX9.0.0.

License requirements : None

std::vector<NXOpen::Assemblies::ProductInterface::InterfaceObject *> NXOpen::Assemblies::ProductInterface::ObjectBuilder::QueryProductInterfaceObjects ( NXOpen::NXObject * part )

Returns a list of product interface objects in the part.

Returns: objects in the product interface
Created in NX5.0.0.

License requirements : None

Parameters

part	part whose product interface objects have to be queried

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::RemoveProductInterfaceObject ( NXOpen::Assemblies::ProductInterface::InterfaceObject * prodIntItem )

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

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::SetBuilderVersion ( NXOpen::Assemblies::ProductInterface::ObjectBuilder::BuilderVersion version )

Sets the version of this builder.

Created in NX9.0.0.

License requirements : None

Parameters

version version

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::SetMateSetting ( NXOpen::Assemblies::ProductInterface::ObjectBuilder::Mate mateSetting )

Sets the current rule setting for use during creation of mating conditions
Created in NX5.0.0.

License requirements : None

Parameters

mateSetting mate setting

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::SetUserComments	(	NXOpen::Assemblies::ProductInterface::InterfaceObject *	prodIntItem,
		const NXString &	userComments
	)

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 NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::SetUserComments	(	NXOpen::Assemblies::ProductInterface::InterfaceObject *	prodIntItem,
		const char *	userComments
	)

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 NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::SetWaveSetting ( NXOpen::Assemblies::ProductInterface::ObjectBuilder::Wave waveSetting )

Sets the current rule setting for use during creation of WAVE geomtery and interpart expressions
Created in NX5.0.0.

License requirements : None

Parameters

waveSetting wave setting

void NXOpen::Assemblies::ProductInterface::ObjectBuilder::UpdateAttributesFromPart ( NXOpen::NXObject * part )

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

NXOpen::Assemblies::ProductInterface::ObjectBuilder::Wave NXOpen::Assemblies::ProductInterface::ObjectBuilder::WaveSetting ( )

Returns the current rule setting for use during creation of WAVE geomtery and interpart expressions
Created in NX5.0.0.

License requirements : None

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

Assemblies_ProductInterface_ObjectBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation