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

This builder is used to define the bead shape. More...

Inheritance diagram for NXOpen::Weld::WeldBeadSizeBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Size {
  SizeDefault1, SizeDefault2, SizeDefault3, SizeDefault4,
  SizeDefault5, SizeCustom
}
 Settings to indicate which standard size to use from the customer defaults file. More...
 
enum  TriangleMethodType { TriangleMethodTypeLegLength, TriangleMethodTypeThroatThickness }
 Settings to indicate the type of method used to build a triangle shape. More...
 
enum  TriangleTypes { TriangleTypesOneSided, TriangleTypesTwoSided }
 Settings to indicate the type of triangle. More...
 

Public Member Functions

NXOpen::SectionCustomSection ()
 Returns the section containing the custom bead shape. More...
 
NXOpen::GeometricUtilities::OnPathDimensionBuilderPathLocation ()
 Returns the location on the path to place the bead shape. More...
 
double RectangleBase ()
 Returns the base length of a rectangle shaped bead. More...
 
double RectangleHeight ()
 Returns the height of a rectangle shaped bead. More...
 
double SemiMajor ()
 Returns the semi the semi major size of an ellipse shaped bead. More...
 
double SemiMinor ()
 Returns the semi minor size of an ellipse shaped bead. More...
 
void SetRectangleBase (double length)
 Sets the base length of a rectangle shaped bead. More...
 
void SetRectangleHeight (double height)
 Sets the height of a rectangle shaped bead. More...
 
void SetSemiMajor (double semiMajor)
 Sets the semi the semi major size of an ellipse shaped bead. More...
 
void SetSemiMinor (double semiMinor)
 Sets the semi minor size of an ellipse shaped bead. More...
 
void SetSizeString (NXOpen::Weld::WeldBeadSizeBuilder::Size sizeString)
 Sets the standard size setting. More...
 
void SetThroatThickness (double throatThickness)
 Sets the throat thickness of a triangular shaped bead. More...
 
void SetTriangleBase (double length)
 Sets the horizontal leg length of a triangular shaped bead. More...
 
void SetTriangleHeight (double length)
 Sets the vertical leg length of a triangular shaped bead. More...
 
void SetTriangleMethod (NXOpen::Weld::WeldBeadSizeBuilder::TriangleMethodType method)
 Sets the method used to construct the triangle shape. More...
 
void SetTriangleType (NXOpen::Weld::WeldBeadSizeBuilder::TriangleTypes type)
 Sets the method used to indicate the type of triangle to create. More...
 
void SetTubeDiameter (double tubeDiameter)
 Sets the diameter size of the tube shape. More...
 
NXOpen::Weld::WeldBeadSizeBuilder::Size SizeString ()
 Returns the standard size setting. More...
 
double ThroatThickness ()
 Returns the throat thickness of a triangular shaped bead. More...
 
double TriangleBase ()
 Returns the horizontal leg length of a triangular shaped bead. More...
 
double TriangleHeight ()
 Returns the vertical leg length of a triangular shaped bead. More...
 
NXOpen::Weld::WeldBeadSizeBuilder::TriangleMethodType TriangleMethod ()
 Returns the method used to construct the triangle shape. More...
 
NXOpen::Weld::WeldBeadSizeBuilder::TriangleTypes TriangleType ()
 Returns the method used to indicate the type of triangle to create. More...
 
double TubeDiameter ()
 Returns the diameter size of the tube shape. 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

This builder is used to define the bead shape.


To create a new instance of this class, use NXOpen::Weld::WeldBeadBuilder::NewSize

Created in NX7.5.0.

Member Enumeration Documentation

Settings to indicate which standard size to use from the customer defaults file.

Enumerator
SizeDefault1 

Default1 from the customer defaults.

SizeDefault2 

Default2 from the customer defaults.

SizeDefault3 

Default3 from the customer defaults.

SizeDefault4 

Default4 from the customer defaults.

SizeDefault5 

Default5 from the customer defaults.

SizeCustom 

Manually keyin value.

Settings to indicate the type of method used to build a triangle shape.

Enumerator
TriangleMethodTypeLegLength 

Triangle defined by leg lengths.

TriangleMethodTypeThroatThickness 

Trangle defined by throat thickness.

Settings to indicate the type of triangle.

Enumerator
TriangleTypesOneSided 

Basically a right triangle.

TriangleTypesTwoSided 

Basically an isosceles triangle.

Member Function Documentation

NXOpen::Section* NXOpen::Weld::WeldBeadSizeBuilder::CustomSection ( )

Returns the section containing the custom bead shape.


Created in NX7.5.0.

License requirements : None

NXOpen::GeometricUtilities::OnPathDimensionBuilder* NXOpen::Weld::WeldBeadSizeBuilder::PathLocation ( )

Returns the location on the path to place the bead shape.


Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::RectangleBase ( )

Returns the base length of a rectangle shaped bead.


Created in NX11.0.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::RectangleHeight ( )

Returns the height of a rectangle shaped bead.


Created in NX11.0.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::SemiMajor ( )

Returns the semi the semi major size of an ellipse shaped bead.


Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::SemiMinor ( )

Returns the semi minor size of an ellipse shaped bead.


Created in NX7.5.0.

License requirements : None

void NXOpen::Weld::WeldBeadSizeBuilder::SetRectangleBase ( double  length)

Sets the base length of a rectangle shaped bead.


Created in NX11.0.0.

License requirements : ugweld ("UG WELD")

Parameters
lengthlength
void NXOpen::Weld::WeldBeadSizeBuilder::SetRectangleHeight ( double  height)

Sets the height of a rectangle shaped bead.


Created in NX11.0.0.

License requirements : ugweld ("UG WELD")

Parameters
heightheight
void NXOpen::Weld::WeldBeadSizeBuilder::SetSemiMajor ( double  semiMajor)

Sets the semi the semi major size of an ellipse shaped bead.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
semiMajorsemimajor
void NXOpen::Weld::WeldBeadSizeBuilder::SetSemiMinor ( double  semiMinor)

Sets the semi minor size of an ellipse shaped bead.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
semiMinorsemiminor
void NXOpen::Weld::WeldBeadSizeBuilder::SetSizeString ( NXOpen::Weld::WeldBeadSizeBuilder::Size  sizeString)

Sets the standard size setting.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
sizeStringsizestring
void NXOpen::Weld::WeldBeadSizeBuilder::SetThroatThickness ( double  throatThickness)

Sets the throat thickness of a triangular shaped bead.


Created in NX11.0.0.

License requirements : ugweld ("UG WELD")

Parameters
throatThicknessthroatthickness
void NXOpen::Weld::WeldBeadSizeBuilder::SetTriangleBase ( double  length)

Sets the horizontal leg length of a triangular shaped bead.


Created in NX11.0.0.

License requirements : ugweld ("UG WELD")

Parameters
lengthlength
void NXOpen::Weld::WeldBeadSizeBuilder::SetTriangleHeight ( double  length)

Sets the vertical leg length of a triangular shaped bead.


Created in NX11.0.0.

License requirements : ugweld ("UG WELD")

Parameters
lengthlength
void NXOpen::Weld::WeldBeadSizeBuilder::SetTriangleMethod ( NXOpen::Weld::WeldBeadSizeBuilder::TriangleMethodType  method)

Sets the method used to construct the triangle shape.


Created in NX11.0.0.

License requirements : ugweld ("UG WELD")

Parameters
methodmethod
void NXOpen::Weld::WeldBeadSizeBuilder::SetTriangleType ( NXOpen::Weld::WeldBeadSizeBuilder::TriangleTypes  type)

Sets the method used to indicate the type of triangle to create.


Created in NX11.0.0.

License requirements : ugweld ("UG WELD")

Parameters
typetype
void NXOpen::Weld::WeldBeadSizeBuilder::SetTubeDiameter ( double  tubeDiameter)

Sets the diameter size of the tube shape.


Created in NX7.5.0.

License requirements : ugweld ("UG WELD")

Parameters
tubeDiametertubediameter
NXOpen::Weld::WeldBeadSizeBuilder::Size NXOpen::Weld::WeldBeadSizeBuilder::SizeString ( )

Returns the standard size setting.


Created in NX7.5.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::ThroatThickness ( )

Returns the throat thickness of a triangular shaped bead.


Created in NX11.0.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::TriangleBase ( )

Returns the horizontal leg length of a triangular shaped bead.


Created in NX11.0.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::TriangleHeight ( )

Returns the vertical leg length of a triangular shaped bead.


Created in NX11.0.0.

License requirements : None

NXOpen::Weld::WeldBeadSizeBuilder::TriangleMethodType NXOpen::Weld::WeldBeadSizeBuilder::TriangleMethod ( )

Returns the method used to construct the triangle shape.


Created in NX11.0.0.

License requirements : None

NXOpen::Weld::WeldBeadSizeBuilder::TriangleTypes NXOpen::Weld::WeldBeadSizeBuilder::TriangleType ( )

Returns the method used to indicate the type of triangle to create.


Created in NX11.0.0.

License requirements : None

double NXOpen::Weld::WeldBeadSizeBuilder::TubeDiameter ( )

Returns the diameter size of the tube shape.


Created in NX7.5.0.

License requirements : None

virtual bool NXOpen::Weld::WeldBeadSizeBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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