NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Assemblies::ProductInterface::ObjectBuilder Class Reference

Represents a Product Interface Object Builder. More...

Inheritance diagram for NXOpen::Assemblies::ProductInterface::ObjectBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

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::InterfaceObjectAddProductInterfaceObject (NXOpen::NXObject *nxItem)
 Adds an object to the product interface; currently supported types are expressions and geometry.
NXOpen::Assemblies::ProductInterface::ObjectBuilder::Mate MateSetting ()
 Returns the current rule setting for use during creation of mating conditions
Created in NX5.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 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 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.

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

Created in NX5.0.0.


Member Enumeration Documentation

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

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

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:
nxItemnx item to be added to the product interface

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



License requirements : None

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:
partpart whose product interface objects have to be queried

Removes an object from the product interface; currently supported types are expressions and geometry
Created in NX5.0.0.



License requirements : None

Parameters:
prodIntItemproduct interface object to be removed from the product interface set

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



License requirements : None

Parameters:
mateSettingmate setting

Sets the user comments on the product interface item passed in
Created in NX5.0.0.



License requirements : None

Parameters:
prodIntItemproduct interface item on which the user comments have to set
userCommentsuser comments to be set on specified product interface item
NOTE: The full Unicode character set is not supported for this parameter.

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



License requirements : None

Parameters:
waveSettingwave setting

Updates the attributes of the product interface items in the part
Created in NX5.0.0.



License requirements : None

Parameters:
partpart, product interface objects of which need to have their attributes updated

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.