NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Tooling::PocketBuilder Class Reference

Mold Wizard pocket management builder
To create a new instance of this class, use NXOpen::Tooling::PocketCollection::CreatePocketBuilder
Default values. More...

Inheritance diagram for NXOpen::Tooling::PocketBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ModeType { ModeTypeSubtract, ModeTypeAdd }
 Represents the pocket operation method. More...
 
enum  RsetType {
  RsetTypeFalse, RsetTypeTrue, RsetTypeBoth, RsetTypeAddMaterial,
  RsetTypeNoChange
}
 Represents the pocket refset types. More...
 
enum  ToolType { ToolTypePart, ToolTypeSolid }
 Represents the select type of tool. More...
 

Public Member Functions

bool AssociationSetting ()
 Returns the association setting access functions
Created in NX6.0.0. More...
 
void CheckStatus ()
 Checks the pocket status of standard parts
Created in NX10.0.0. More...
 
bool CreateSolidSetting ()
 Returns the option for creating interference solids for HD3D. More...
 
void DeleteFamilyToolFalse ()
 Deletes the family tool false body
Created in NX11.0.0. More...
 
void EditFalseBody ()
 Edits false body
Created in NX11.0.0. More...
 
bool EntireComponentPattern ()
 Returns the option for selecting entire component pattern. More...
 
void FindIntersection ()
 Finds the intersected components to create pocket
Created in NX10.0.0. More...
 
NXOpen::Tooling::PocketBuilder::ModeType ModeSelection ()
 Returns the mode select types
Created in NX6.0.0. More...
 
bool PreviewFalseBody ()
 Returns the option for previewing family part false bodies. More...
 
NXOpen::Tooling::PocketBuilder::RsetType ReferenceSets ()
 Returns the types of reference sets
Created in NX6.0.0. More...
 
void RemovePocket ()
 The function to remove pocket
Created in NX6.0.0. More...
 
bool SaveSetting ()
 Returns the option for saving pocket check result in part. More...
 
NXOpen::SelectBodyListSelectTarget ()
 Returns the target part selection
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectListSelectTool ()
 Returns the tool part selection
Created in NX6.0.0. More...
 
NXOpen::Tooling::PocketBuilder::ToolType SelectTypes ()
 Returns the types of tool to select
Created in NX6.0.0. More...
 
void SetAssociationSetting (bool associationSetting)
 Sets the association setting access functions
Created in NX6.0.0. More...
 
void SetCreateSolidSetting (bool createSolidSetting)
 Sets the option for creating interference solids for HD3D. More...
 
void SetEntireComponentPattern (bool entire)
 Sets the option for selecting entire component pattern. More...
 
void SetModeSelection (NXOpen::Tooling::PocketBuilder::ModeType modeSelection)
 Sets the mode select types
Created in NX6.0.0. More...
 
void SetPreviewFalseBody (bool previewFalse)
 Sets the option for previewing family part false bodies. More...
 
void SetReferenceSets (NXOpen::Tooling::PocketBuilder::RsetType referenceSets)
 Sets the types of reference sets
Created in NX6.0.0. More...
 
void SetSaveSetting (bool saveSetting)
 Sets the option for saving pocket check result in part. More...
 
void SetSelectTypes (NXOpen::Tooling::PocketBuilder::ToolType selectTypes)
 Sets the types of tool to select
Created in NX6.0.0. More...
 
void SetShowSetting (bool showSetting)
 Sets the show or hide value access functions
Created in NX6.0.0. More...
 
bool ShowSetting ()
 Returns the show or hide value access functions
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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...
 

Detailed Description

Mold Wizard pocket management builder
To create a new instance of this class, use NXOpen::Tooling::PocketCollection::CreatePocketBuilder
Default values.

Property Value

EntireComponentPattern

0

PreviewFalseBody

0


Created in NX6.0.0.

Member Enumeration Documentation

Represents the pocket operation method.

Enumerator
ModeTypeSubtract 

do subtract

ModeTypeAdd 

do unite

Represents the pocket refset types.

Enumerator
RsetTypeFalse 

false

RsetTypeTrue 

true

RsetTypeBoth 

both

RsetTypeAddMaterial 

add material

RsetTypeNoChange 

no change

Represents the select type of tool.

Enumerator
ToolTypePart 

part

ToolTypeSolid 

solid

Member Function Documentation

bool NXOpen::Tooling::PocketBuilder::AssociationSetting ( )

Returns the association setting access functions
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::PocketBuilder::CheckStatus ( )

Checks the pocket status of standard parts
Created in NX10.0.0.



License requirements : None

bool NXOpen::Tooling::PocketBuilder::CreateSolidSetting ( )

Returns the option for creating interference solids for HD3D.


Created in NX8.0.0.

License requirements : None

void NXOpen::Tooling::PocketBuilder::DeleteFamilyToolFalse ( )

Deletes the family tool false body
Created in NX11.0.0.



License requirements : None

void NXOpen::Tooling::PocketBuilder::EditFalseBody ( )

Edits false body
Created in NX11.0.0.



License requirements : None

bool NXOpen::Tooling::PocketBuilder::EntireComponentPattern ( )

Returns the option for selecting entire component pattern.


Created in NX11.0.0.

License requirements : None

void NXOpen::Tooling::PocketBuilder::FindIntersection ( )

Finds the intersected components to create pocket
Created in NX10.0.0.



License requirements : None

NXOpen::Tooling::PocketBuilder::ModeType NXOpen::Tooling::PocketBuilder::ModeSelection ( )

Returns the mode select types
Created in NX6.0.0.



License requirements : None

bool NXOpen::Tooling::PocketBuilder::PreviewFalseBody ( )

Returns the option for previewing family part false bodies.


Created in NX11.0.0.

License requirements : None

NXOpen::Tooling::PocketBuilder::RsetType NXOpen::Tooling::PocketBuilder::ReferenceSets ( )

Returns the types of reference sets
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::PocketBuilder::RemovePocket ( )

The function to remove pocket
Created in NX6.0.0.



License requirements : None

bool NXOpen::Tooling::PocketBuilder::SaveSetting ( )

Returns the option for saving pocket check result in part.


Created in NX8.0.0.

License requirements : None

NXOpen::SelectBodyList* NXOpen::Tooling::PocketBuilder::SelectTarget ( )

Returns the target part selection
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Tooling::PocketBuilder::SelectTool ( )

Returns the tool part selection
Created in NX6.0.0.



License requirements : None

NXOpen::Tooling::PocketBuilder::ToolType NXOpen::Tooling::PocketBuilder::SelectTypes ( )

Returns the types of tool to select
Created in NX6.0.0.



License requirements : None

void NXOpen::Tooling::PocketBuilder::SetAssociationSetting ( bool  associationSetting)

Sets the association setting access functions
Created in NX6.0.0.



License requirements : None

Parameters
associationSettingassociationsetting
void NXOpen::Tooling::PocketBuilder::SetCreateSolidSetting ( bool  createSolidSetting)

Sets the option for creating interference solids for HD3D.


Created in NX8.0.0.

License requirements : None

Parameters
createSolidSettingcreatesolidsetting
void NXOpen::Tooling::PocketBuilder::SetEntireComponentPattern ( bool  entire)

Sets the option for selecting entire component pattern.


Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard") OR ug_die_design ("Die Design")

Parameters
entireentire
void NXOpen::Tooling::PocketBuilder::SetModeSelection ( NXOpen::Tooling::PocketBuilder::ModeType  modeSelection)

Sets the mode select types
Created in NX6.0.0.



License requirements : None

Parameters
modeSelectionmodeselection
void NXOpen::Tooling::PocketBuilder::SetPreviewFalseBody ( bool  previewFalse)

Sets the option for previewing family part false bodies.


Created in NX11.0.0.

License requirements : ug_mold_design ("UG MOLD") OR prog_die_wizard ("UG/Progressive Die Wizard") OR ug_die_design ("Die Design")

Parameters
previewFalsepreviewfalse
void NXOpen::Tooling::PocketBuilder::SetReferenceSets ( NXOpen::Tooling::PocketBuilder::RsetType  referenceSets)

Sets the types of reference sets
Created in NX6.0.0.



License requirements : None

Parameters
referenceSetsreferencesets
void NXOpen::Tooling::PocketBuilder::SetSaveSetting ( bool  saveSetting)

Sets the option for saving pocket check result in part.


Created in NX8.0.0.

License requirements : None

Parameters
saveSettingsavesetting
void NXOpen::Tooling::PocketBuilder::SetSelectTypes ( NXOpen::Tooling::PocketBuilder::ToolType  selectTypes)

Sets the types of tool to select
Created in NX6.0.0.



License requirements : None

Parameters
selectTypesselecttypes
void NXOpen::Tooling::PocketBuilder::SetShowSetting ( bool  showSetting)

Sets the show or hide value access functions
Created in NX6.0.0.



License requirements : None

Parameters
showSettingshowsetting
bool NXOpen::Tooling::PocketBuilder::ShowSetting ( )

Returns the show or hide value access functions
Created in NX6.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.