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

Shim Builder of PDW and EDW. More...

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

Public Types

enum  ParentOption { ParentOptionNoParent }
 Specify the parent node. More...
 
enum  SideAttributeValues { SideAttributeValuesNone, SideAttributeValuesTop, SideAttributeValuesBottom }
 Specifies the value of side attribute. More...
 
enum  Types { TypesAddInsert, TypesEditInsert, TypesDeleteInsert }
 Specify the shim operation type. More...
 

Public Member Functions

NXOpen::Tooling::ShimInnerProfileSetBuilderCreateInnerProfileSetBuilder ()
 Create a inner profile set builder object. More...
 
void GetItemName (std::vector< int > &itemName)
 Returns the item name Of Set List
Created in NX11.0.0. More...
 
NXOpen::ExpressionHeight ()
 Returns the height of shim body
Created in NX10.0.0. More...
 
NXOpen::Assemblies::SelectComponentListInsertToDelete ()
 Returns the shim component that needs to be deleted
Created in NX10.0.0. More...
 
NXOpen::Assemblies::SelectComponentInsertToEdit ()
 Returns the shim component that needs to be edit
Created in NX10.0.0. More...
 
NXOpen::ExpressionOffsetOuterDistance ()
 Returns the offset distance of outer loop
Created in NX10.0.0. More...
 
bool OuterRoughOffset ()
 Returns the outer rough offset
Created in NX10.0.0. More...
 
NXOpen::Tooling::ShimBuilder::ParentOption ParentNode ()
 Returns the parent node which shim part will be insert to
Created in NX10.0.0. More...
 
NXString ParentPartName ()
 Returns the parent part name of shim part
Created in NX10.0.0. More...
 
bool RenameToggle ()
 Returns the toggle to indicate whether to rename shim part
Created in NX10.0.0. More...
 
void SetItemName (const std::vector< int > &itemName)
 Sets the item name of Set List
Created in NX11.0.0. More...
 
void SetOuterRoughOffset (bool outerRoughOffset)
 Sets the outer rough offset
Created in NX10.0.0. More...
 
void SetParentNode (NXOpen::Tooling::ShimBuilder::ParentOption parentNode)
 Sets the parent node which shim part will be insert to
Created in NX10.0.0. More...
 
void SetParentPartName (const NXString &parentPartName)
 Sets the parent part name of shim part
Created in NX10.0.0. More...
 
void SetParentPartName (const char *parentPartName)
 Sets the parent part name of shim part
Created in NX10.0.0. More...
 
void SetRenameToggle (bool renameToggle)
 Sets the toggle to indicate whether to rename shim part
Created in NX10.0.0. More...
 
void SetSideAttributeValue (NXOpen::Tooling::ShimBuilder::SideAttributeValues sideAttributeValue)
 Sets the side attribute value for shim. More...
 
void SetType (NXOpen::Tooling::ShimBuilder::Types type)
 Sets the type
Created in NX10.0.0. More...
 
void SetWizardType (int wizardType)
 Sets the wizard type
Created in NX10.0.0. More...
 
NXOpen::SelectFaceListShimFace ()
 Returns the face for doing shim body
Created in NX10.0.0. More...
 
NXOpen::Tooling::ShimBuilder::SideAttributeValues SideAttributeValue ()
 Returns the side attribute value for shim. More...
 
NXOpen::Tooling::ShimInnerProfileSetBuilderListSlugholeProfile ()
 Returns the list containing the inner profiles which need to offset. More...
 
NXOpen::Tooling::ShimBuilder::Types Type ()
 Returns the type
Created in NX10.0.0. More...
 
int WizardType ()
 Returns the wizard type
Created in NX10.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

Shim Builder of PDW and EDW.

A Body is returned by this builder.
To create a new instance of this class, use NXOpen::Tooling::ProgressiveDieManager::CreateShimBuilder
Default values.

Property Value

ParentNode

NoParent

RenameToggle

0

SideAttributeValue

None


Created in NX10.0.0.

Member Enumeration Documentation

Specify the parent node.

Enumerator
ParentOptionNoParent 

no parent

Specifies the value of side attribute.

Enumerator
SideAttributeValuesNone 

the NONE value

SideAttributeValuesTop 

the TOP value

SideAttributeValuesBottom 

the BOTTOM value

Specify the shim operation type.

Enumerator
TypesAddInsert 

add insert

TypesEditInsert 

edit insert

TypesDeleteInsert 

delete insert

Member Function Documentation

NXOpen::Tooling::ShimInnerProfileSetBuilder* NXOpen::Tooling::ShimBuilder::CreateInnerProfileSetBuilder ( )

Create a inner profile set builder object.

Returns

Created in NX10.0.0.

License requirements : None
void NXOpen::Tooling::ShimBuilder::GetItemName ( std::vector< int > &  itemName)

Returns the item name Of Set List
Created in NX11.0.0.



License requirements : None

Parameters
itemNamethe item name
NXOpen::Expression* NXOpen::Tooling::ShimBuilder::Height ( )

Returns the height of shim body
Created in NX10.0.0.



License requirements : None

NXOpen::Assemblies::SelectComponentList* NXOpen::Tooling::ShimBuilder::InsertToDelete ( )

Returns the shim component that needs to be deleted
Created in NX10.0.0.



License requirements : None

NXOpen::Assemblies::SelectComponent* NXOpen::Tooling::ShimBuilder::InsertToEdit ( )

Returns the shim component that needs to be edit
Created in NX10.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Tooling::ShimBuilder::OffsetOuterDistance ( )

Returns the offset distance of outer loop
Created in NX10.0.0.



License requirements : None

bool NXOpen::Tooling::ShimBuilder::OuterRoughOffset ( )

Returns the outer rough offset
Created in NX10.0.0.



License requirements : None

NXOpen::Tooling::ShimBuilder::ParentOption NXOpen::Tooling::ShimBuilder::ParentNode ( )

Returns the parent node which shim part will be insert to
Created in NX10.0.0.



License requirements : None

NXString NXOpen::Tooling::ShimBuilder::ParentPartName ( )

Returns the parent part name of shim part
Created in NX10.0.0.



License requirements : None

bool NXOpen::Tooling::ShimBuilder::RenameToggle ( )

Returns the toggle to indicate whether to rename shim part
Created in NX10.0.0.



License requirements : None

void NXOpen::Tooling::ShimBuilder::SetItemName ( const std::vector< int > &  itemName)

Sets the item name of Set List
Created in NX11.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
itemNamethe item name
void NXOpen::Tooling::ShimBuilder::SetOuterRoughOffset ( bool  outerRoughOffset)

Sets the outer rough offset
Created in NX10.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
outerRoughOffsetouterroughoffset
void NXOpen::Tooling::ShimBuilder::SetParentNode ( NXOpen::Tooling::ShimBuilder::ParentOption  parentNode)

Sets the parent node which shim part will be insert to
Created in NX10.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
parentNodeparentnode
void NXOpen::Tooling::ShimBuilder::SetParentPartName ( const NXString parentPartName)

Sets the parent part name of shim part
Created in NX10.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
parentPartNameparentpartname
void NXOpen::Tooling::ShimBuilder::SetParentPartName ( const char *  parentPartName)

Sets the parent part name of shim part
Created in NX10.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
parentPartNameparentpartname
void NXOpen::Tooling::ShimBuilder::SetRenameToggle ( bool  renameToggle)

Sets the toggle to indicate whether to rename shim part
Created in NX10.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
renameTogglerenametoggle
void NXOpen::Tooling::ShimBuilder::SetSideAttributeValue ( NXOpen::Tooling::ShimBuilder::SideAttributeValues  sideAttributeValue)

Sets the side attribute value for shim.


Created in NX12.0.0.

License requirements : None

Parameters
sideAttributeValueIndicates the side attribute value for shim
void NXOpen::Tooling::ShimBuilder::SetType ( NXOpen::Tooling::ShimBuilder::Types  type)

Sets the type
Created in NX10.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
typetype
void NXOpen::Tooling::ShimBuilder::SetWizardType ( int  wizardType)

Sets the wizard type
Created in NX10.0.0.



License requirements : prog_die_wizard ("UG/Progressive Die Wizard")

Parameters
wizardTypewizardtype
NXOpen::SelectFaceList* NXOpen::Tooling::ShimBuilder::ShimFace ( )

Returns the face for doing shim body
Created in NX10.0.0.



License requirements : None

NXOpen::Tooling::ShimBuilder::SideAttributeValues NXOpen::Tooling::ShimBuilder::SideAttributeValue ( )

Returns the side attribute value for shim.


Created in NX12.0.0.

License requirements : None

NXOpen::Tooling::ShimInnerProfileSetBuilderList* NXOpen::Tooling::ShimBuilder::SlugholeProfile ( )

Returns the list containing the inner profiles which need to offset.


Created in NX10.0.0.

License requirements : None

NXOpen::Tooling::ShimBuilder::Types NXOpen::Tooling::ShimBuilder::Type ( )

Returns the type
Created in NX10.0.0.



License requirements : None

int NXOpen::Tooling::ShimBuilder::WizardType ( )

Returns the wizard type
Created in NX10.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.