LineWeldBuilder Class¶
-
class
NXOpen.Annotations.LineWeldBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Annotations.LineWeldBuilderTo create a new instance of this class, use
NXOpen.Annotations.WeldCollection.CreateLineWeldBuilder()Default values.
Property Value ArrowSideWeldData.ContourSymbol None ArrowSideWeldData.FinishSymbol None ArrowSideWeldData.WeldSizeCode None ArrowSideWeldData.WeldSymbol None FieldWeld Plain FlipDirection False FlipHorizontal False FlipVertical False IdLine Plain Scale 1 StaggeredWeld NoStaggeredSymbol Tail NoTail WeldAlongContour None New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| ArrowSideWeldData | Returns the NXOpen.Annotations.LineWeldDataBuilder for the arrow side of the weld symbol |
| FieldWeld | Returns or sets the field indicating the weld is done at the field site |
| FlipDirection | Returns or sets the flip direction for top seam |
| FlipHorizontal | Returns or sets the flip horizontal direction for side seam |
| FlipVertical | Returns or sets the flip vertical direction for side seam |
| ForeshorteningSymbol | Returns the foreshortening symbol builder |
| IdLine | Returns or sets the identification or reference line |
| Inherit | Returns the weld symbol from which the style properties are inherited |
| Leader | Returns the NXOpen.Annotations.LeaderBuilder for weld symbol |
| Origin | Returns the NXOpen.Annotations.OriginBuilder for the weld symbol |
| OtherSideWeldData | Returns the NXOpen.Annotations.LineWeldDataBuilder for the other side of the weld symbol |
| Scale | Returns or sets the scaling factor for the welding symbol |
| SideSeamObjects | Returns the side seam object |
| SpaceFactor | Returns or sets the space factor for the welding symbol |
| StaggeredWeld | Returns or sets the staggered weld |
| Style | Returns the NXOpen.Annotations.StyleBuilder for the weld symbol |
| Tag | Returns the Tag for this object. |
| Tail | Returns or sets the weld tail |
| TopSeamObject | Returns the top seam object |
| WeldAlongContour | Returns or sets the weld along contour option |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| GetReference | Returns the reference or specification text |
| InheritProperties | This inherits the properties from the existing weld symbol |
| InheritPropertiesFromWeldFeature | This inherits the properties from the existing weld feature |
| SetReference | Sets the reference or specification text |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| LineWeldBuilderFieldWeldType Enumeration | Represents the field weld type |
| LineWeldBuilderIdLineType Enumeration | Represents the id line type |
| LineWeldBuilderStaggeredWeldType Enumeration | Represents the staggered weld type |
| LineWeldBuilderTailType Enumeration | represents the tail type |
| LineWeldBuilderWeldSymbolWeldAlongContourType Enumeration | Represents the weld along contour option |
Property Detail¶
ArrowSideWeldData¶
-
LineWeldBuilder.ArrowSideWeldData¶ Returns the
NXOpen.Annotations.LineWeldDataBuilderfor the arrow side of the weld symbol-------------------------------------Getter Method
Signature
ArrowSideWeldDataReturns: Return type: NXOpen.Annotations.LineWeldDataBuilderNew in version NX6.0.0.
License requirements: None.
FieldWeld¶
-
LineWeldBuilder.FieldWeld¶ Returns or sets the field indicating the weld is done at the field site
-------------------------------------Getter Method
Signature
FieldWeldReturns: Return type: NXOpen.Annotations.LineWeldBuilderFieldWeldTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FieldWeldParameters: fieldWeld ( NXOpen.Annotations.LineWeldBuilderFieldWeldType) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
FlipDirection¶
-
LineWeldBuilder.FlipDirection¶ Returns or sets the flip direction for top seam
-------------------------------------Getter Method
Signature
FlipDirectionReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FlipDirectionParameters: flipDirection (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
FlipHorizontal¶
-
LineWeldBuilder.FlipHorizontal¶ Returns or sets the flip horizontal direction for side seam
-------------------------------------Getter Method
Signature
FlipHorizontalReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FlipHorizontalParameters: flipHorizontal (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
FlipVertical¶
-
LineWeldBuilder.FlipVertical¶ Returns or sets the flip vertical direction for side seam
-------------------------------------Getter Method
Signature
FlipVerticalReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FlipVerticalParameters: flipVertical (bool) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
ForeshorteningSymbol¶
-
LineWeldBuilder.ForeshorteningSymbol¶ Returns the foreshortening symbol builder
-------------------------------------Getter Method
Signature
ForeshorteningSymbolReturns: Return type: NXOpen.Annotations.ForeshorteningSymbolBuilderNew in version NX10.0.0.
License requirements: None.
IdLine¶
-
LineWeldBuilder.IdLine¶ Returns or sets the identification or reference line
-------------------------------------Getter Method
Signature
IdLineReturns: Return type: NXOpen.Annotations.LineWeldBuilderIdLineTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IdLineParameters: idLine ( NXOpen.Annotations.LineWeldBuilderIdLineType) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Inherit¶
-
LineWeldBuilder.Inherit¶ Returns the weld symbol from which the style properties are inherited
-------------------------------------Getter Method
Signature
InheritReturns: Return type: NXOpen.SelectDisplayableObjectNew in version NX6.0.0.
License requirements: None.
Leader¶
-
LineWeldBuilder.Leader¶ Returns the
NXOpen.Annotations.LeaderBuilderfor weld symbol-------------------------------------Getter Method
Signature
LeaderReturns: Return type: NXOpen.Annotations.LeaderBuilderNew in version NX6.0.0.
License requirements: None.
Origin¶
-
LineWeldBuilder.Origin¶ Returns the
NXOpen.Annotations.OriginBuilderfor the weld symbol-------------------------------------Getter Method
Signature
OriginReturns: Return type: NXOpen.Annotations.OriginBuilderNew in version NX6.0.0.
License requirements: None.
OtherSideWeldData¶
-
LineWeldBuilder.OtherSideWeldData¶ Returns the
NXOpen.Annotations.LineWeldDataBuilderfor the other side of the weld symbol-------------------------------------Getter Method
Signature
OtherSideWeldDataReturns: Return type: NXOpen.Annotations.LineWeldDataBuilderNew in version NX6.0.0.
License requirements: None.
Scale¶
-
LineWeldBuilder.Scale¶ Returns or sets the scaling factor for the welding symbol
-------------------------------------Getter Method
Signature
ScaleReturns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScaleParameters: scale (float) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
SideSeamObjects¶
-
LineWeldBuilder.SideSeamObjects¶ Returns the side seam object
-------------------------------------Getter Method
Signature
SideSeamObjectsReturns: Return type: NXOpen.SelectDisplayableObjectListNew in version NX6.0.0.
License requirements: None.
SpaceFactor¶
-
LineWeldBuilder.SpaceFactor¶ Returns or sets the space factor for the welding symbol
-------------------------------------Getter Method
Signature
SpaceFactorReturns: Return type: float New in version NX7.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpaceFactorParameters: spaceFactor (float) – New in version NX7.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
StaggeredWeld¶
-
LineWeldBuilder.StaggeredWeld¶ Returns or sets the staggered weld
-------------------------------------Getter Method
Signature
StaggeredWeldReturns: Return type: NXOpen.Annotations.LineWeldBuilderStaggeredWeldTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StaggeredWeldParameters: staggeredWeld ( NXOpen.Annotations.LineWeldBuilderStaggeredWeldType) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Style¶
-
LineWeldBuilder.Style¶ Returns the
NXOpen.Annotations.StyleBuilderfor the weld symbol-------------------------------------Getter Method
Signature
StyleReturns: Return type: NXOpen.Annotations.StyleBuilderNew in version NX6.0.0.
License requirements: None.
Tail¶
-
LineWeldBuilder.Tail¶ Returns or sets the weld tail
-------------------------------------Getter Method
Signature
TailReturns: Return type: NXOpen.Annotations.LineWeldBuilderTailTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TailParameters: tail ( NXOpen.Annotations.LineWeldBuilderTailType) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
TopSeamObject¶
-
LineWeldBuilder.TopSeamObject¶ Returns the top seam object
-------------------------------------Getter Method
Signature
TopSeamObjectReturns: Return type: NXOpen.SelectDisplayableObjectNew in version NX6.0.0.
License requirements: None.
WeldAlongContour¶
-
LineWeldBuilder.WeldAlongContour¶ Returns or sets the weld along contour option
-------------------------------------Getter Method
Signature
WeldAlongContourReturns: Return type: NXOpen.Annotations.LineWeldBuilderWeldSymbolWeldAlongContourTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
WeldAlongContourParameters: alongContour ( NXOpen.Annotations.LineWeldBuilderWeldSymbolWeldAlongContourType) –New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Method Detail¶
GetReference¶
-
LineWeldBuilder.GetReference¶ Returns the reference or specification text
Signature
GetReference()Returns: Return type: list of str New in version NX6.0.0.
License requirements: None.
InheritProperties¶
-
LineWeldBuilder.InheritProperties¶ This inherits the properties from the existing weld symbol
Signature
InheritProperties(annotation)Parameters: annotation ( NXOpen.Annotations.Weld) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
InheritPropertiesFromWeldFeature¶
-
LineWeldBuilder.InheritPropertiesFromWeldFeature¶ This inherits the properties from the existing weld feature
Signature
InheritPropertiesFromWeldFeature(feature)Parameters: feature ( NXOpen.DisplayableObject) –New in version NX8.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
SetReference¶
-
LineWeldBuilder.SetReference¶ Sets the reference or specification text
Signature
SetReference(reference)Parameters: reference (list of str) – New in version NX6.0.0.
License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)
Validate¶
-
LineWeldBuilder.Validate¶ 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.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.