NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Features::SheetMetal::BeadBuilder Class Reference

Represents a Bead feature builder. More...

Inheritance diagram for NXOpen::Features::SheetMetal::BeadBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  CrossSectionTypeOptions { CrossSectionTypeOptionsCircular, CrossSectionTypeOptionsUshaped, CrossSectionTypeOptionsVshaped }
 This enum represents the cross section type options for the Bead. More...
enum  EndTypeOptions { EndTypeOptionsPunched, EndTypeOptionsLanced, EndTypeOptionsFormed }
 This enum represents the end type options for the Bead. More...
enum  HeightSideOptions { HeightSideOptionsSectionNormalSide, HeightSideOptionsSectionReverseNormalSide }
 This enum represents the depth direction for the Bead. More...

Public Member Functions

NXOpen::ExpressionAngle ()
 Returns the angle of the bead.
NXOpen::Features::SheetMetal::BeadBuilder::CrossSectionTypeOptions CrossSectionType ()
 Returns the bead profile type .
NXOpen::ExpressionDieRadius ()
 Returns the bead die radius.
NXOpen::Features::SheetMetal::BeadBuilder::EndTypeOptions EndType ()
 Returns the bead end type .
NXOpen::ExpressionHeight ()
 Returns the height of the bead.
NXOpen::Features::SheetMetal::BeadBuilder::HeightSideOptions HeightSide ()
 Returns the Height side for the bead.
bool IncludeRounding ()
 Returns the rounding type .
NXOpen::ExpressionMinimumToolClearance ()
 Returns the Minimum tool clearance expression.
NXOpen::ExpressionPunchedWidth ()
 Returns the Punched width of the bead.
NXOpen::ExpressionPunchRadius ()
 Returns the bead punch radius.
NXOpen::ExpressionRadius ()
 Returns the radius of the bead.
NXOpen::SectionSection ()
 Returns the Section used by the bead.
void SetAngle (const NXString &beadAngle)
 
Created in NX4.0.0.
void SetCrossSectionType (NXOpen::Features::SheetMetal::BeadBuilder::CrossSectionTypeOptions crossSectionOption)
 Sets the bead profile type .
void SetDieRadius (const NXString &beadDieRadius)
 
Created in NX4.0.0.
void SetEndType (NXOpen::Features::SheetMetal::BeadBuilder::EndTypeOptions beadEndOptions)
 Sets the bead end type .
void SetHeight (const NXString &beadHeight)
 
Created in NX4.0.0.
void SetHeightSide (NXOpen::Features::SheetMetal::BeadBuilder::HeightSideOptions heightSide)
 Sets the Height side for the bead.
void SetIncludeRounding (bool rounding)
 Sets the rounding type .
void SetPunchedWidth (const NXString &punchedWidth)
 
Created in NX4.0.0.
void SetPunchRadius (const NXString &punchRadius)
 
Created in NX4.0.0.
void SetRadius (const NXString &beadRadius)
 
Created in NX4.0.0.
void SetSection (NXOpen::Section *section)
 Sets the Section used by the bead.
void SetSketch (NXOpen::Features::SketchFeature *sketch)
 Sets the Slave Sketch used by the Bead, If one exists.
void SetWidth (const NXString &beadWidth)
 
Created in NX4.0.0.
NXOpen::Features::SketchFeatureSketch ()
 Returns the Slave Sketch used by the Bead, If one exists.
int ValidateBuilderData ()
 Verify whether the builder data is valid for creating a Bead or not.
NXOpen::ExpressionWidth ()
 Returns the width of the bead.

Detailed Description

Represents a Bead feature builder.


To create a new instance of this class, use Features::SheetMetal::SheetmetalManager::CreateBeadFeatureBuilder

Created in NX4.0.0.


Member Enumeration Documentation

This enum represents the cross section type options for the Bead.

Enumerator:
CrossSectionTypeOptionsCircular 

circular

CrossSectionTypeOptionsUshaped 

ushaped

CrossSectionTypeOptionsVshaped 

vshaped

This enum represents the end type options for the Bead.

Enumerator:
EndTypeOptionsPunched 

punched

EndTypeOptionsLanced 

lanced

EndTypeOptionsFormed 

formed

This enum represents the depth direction for the Bead.

Enumerator:
HeightSideOptionsSectionNormalSide 

Material removed on the side of the section normal.

HeightSideOptionsSectionReverseNormalSide 

Material removed on the side opposite to that of the section normal.


Member Function Documentation

Returns the angle of the bead.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the bead profile type .


Specify Features::SheetMetal::BeadBuilder::CrossSectionTypeOptionsCircular to have profile of half circle. Specify Features::SheetMetal::BeadBuilder::CrossSectionTypeOptionsUshaped to have profile of U shape. Specify Features::SheetMetal::BeadBuilder::CrossSectionTypeOptionsVshaped to have profile of V shape.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the bead die radius.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the bead end type .


Specify Features::SheetMetal::BeadBuilder::EndTypeOptionsFormed to have ends of bead feature be formed. Specify Features::SheetMetal::BeadBuilder::EndTypeOptionsLanced to have ends of bead feature be Lanced. Specify Features::SheetMetal::BeadBuilder::EndTypeOptionsPunched to have ends of bead feature be Punched.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the height of the bead.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the Height side for the bead.


This is used to specify the direction in which the Bead is created. If Bead creation must happen in the direction of the Section Normal (specified using the Features::SheetMetal::BeadBuilder::Section and Features::SheetMetal::BeadBuilder::SetSection ) then pass the value of Features::SheetMetal::BeadBuilder::HeightSideOptionsSectionNormalSide If Bead creation must happen in the opposite direction to that of Section Normal, set the value to be Features::SheetMetal::BeadBuilder::HeightSideOptionsSectionReverseNormalSide


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the rounding type .


Specify true to Round the Sharp edges. Specify false to avoid rounding.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the Minimum tool clearance expression.


Created in NX6.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the Punched width of the bead.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the bead punch radius.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the radius of the bead.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the Section used by the bead.

section should be open.
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
beadAngle
NOTE: The full Unicode character set is not supported for this parameter.

Sets the bead profile type .


Specify Features::SheetMetal::BeadBuilder::CrossSectionTypeOptionsCircular to have profile of half circle. Specify Features::SheetMetal::BeadBuilder::CrossSectionTypeOptionsUshaped to have profile of U shape. Specify Features::SheetMetal::BeadBuilder::CrossSectionTypeOptionsVshaped to have profile of V shape.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
crossSectionOptioncross section option


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
beadDieRadius
NOTE: The full Unicode character set is not supported for this parameter.

Sets the bead end type .


Specify Features::SheetMetal::BeadBuilder::EndTypeOptionsFormed to have ends of bead feature be formed. Specify Features::SheetMetal::BeadBuilder::EndTypeOptionsLanced to have ends of bead feature be Lanced. Specify Features::SheetMetal::BeadBuilder::EndTypeOptionsPunched to have ends of bead feature be Punched.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
beadEndOptionsbead end options


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
beadHeight
NOTE: The full Unicode character set is not supported for this parameter.

Sets the Height side for the bead.


This is used to specify the direction in which the Bead is created. If Bead creation must happen in the direction of the Section Normal (specified using the Features::SheetMetal::BeadBuilder::Section and Features::SheetMetal::BeadBuilder::SetSection ) then pass the value of Features::SheetMetal::BeadBuilder::HeightSideOptionsSectionNormalSide If Bead creation must happen in the opposite direction to that of Section Normal, set the value to be Features::SheetMetal::BeadBuilder::HeightSideOptionsSectionReverseNormalSide


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
heightSideheight side

Sets the rounding type .


Specify true to Round the Sharp edges. Specify false to avoid rounding.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
roundingrounding


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
punchedWidth
NOTE: The full Unicode character set is not supported for this parameter.


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
punchRadius
NOTE: The full Unicode character set is not supported for this parameter.


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
beadRadius
NOTE: The full Unicode character set is not supported for this parameter.

Sets the Section used by the bead.

section should be open.
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
sectionsection

Sets the Slave Sketch used by the Bead, If one exists.


If the Sketch is created internally as part of the Bead command in the UI, then it shall be consumed by the Bead and shall not show up as a seperate feature in the Part Navigator. If such a behaviour is deired, then specify the Sketch here.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
sketchsketch


Created in NX4.0.0.



License requirements : nx_sheet_metal ("NX Sheet Metal")

Parameters:
beadWidth
NOTE: The full Unicode character set is not supported for this parameter.

Returns the Slave Sketch used by the Bead, If one exists.


If the Sketch is created internally as part of the Bead command in the UI, then it shall be consumed by the Bead and shall not show up as a seperate feature in the Part Navigator. If such a behaviour is deired, then specify the Sketch here.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Verify whether the builder data is valid for creating a Bead or not.


If the Builder data is valid, returned value shall be 0


Returns:
Data Validity Flag.
Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")

Returns the width of the bead.


Created in NX4.0.0.

License requirements : nx_sheet_metal ("NX Sheet Metal")


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