WeldBuilder Class¶
-
class
NXOpen.CAE.
WeldBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.CAE.WeldBuilder
To create a new instance of this class, use
NXOpen.CAE.MeshManager.CreateWeldBuilder()
New in version NX7.5.2.
Properties¶
Property | Description |
---|---|
DistanceBetween | Returns the distance between the points on the edge(s) used to specify the location of the weld |
EdgeSelection | Returns the edge(s) used to specify the location of the weld |
ElementType | Returns the element type to be created for the weld |
EndOffset | Returns the distance of the last point from the end of the edge(s) |
FlipState | Returns or sets the flip state of the selected edge(s) |
InputFile | Returns or sets the name of the input file used to specify locations for the weld |
Location | Returns or sets the location of the specified weld |
NodeSelection | Returns the node(s) used to specify the location of the weld |
NumberOfPointsOnEdge | Returns or sets the number of points on the edge(s) used to specify the location of the weld |
NumberOfPointsOption | Returns or sets the option to specify the maximum number of points on the edge(s) used to specify the location of the weld |
OffsetDistance | Returns the distance to offset the points from the edge(s) |
OffsetVector | Returns or sets the vector along which to offset the points |
Pattern | Returns or sets the pattern used to specify locations on the edge(s) |
PointOnEdgeOption | Returns or sets the location of the points on the edge |
PointsSelection | Returns the point(s) used to specify the location of the weld |
SearchDistance | Returns the distance within which to search for PIDs |
SpecifiedNumberOfPoints | Returns or sets the maximum number of points on the edge(s) used to specify the location of the weld |
StartOffset | Returns the distance of the first point from the beginning of the edge(s) |
SupportAllPids | Returns or sets the option to include all PIDs within the search distance for creating welds |
Tag | Returns the Tag for this object. |
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. |
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¶
WeldBuilderNumberOfPointsOnEdgeType Enumeration | Represents the options for specifying maximum number of weld points on an edge |
WeldBuilderPointOnEdgeType Enumeration | Represents the options for specifying number of weld points on an edge |
WeldBuilderWeldLocation Enumeration | Represents the options for type of operation |
Property Detail¶
DistanceBetween¶
-
WeldBuilder.
DistanceBetween
¶ Returns the distance between the points on the edge(s) used to specify the location of the weld
-------------------------------------
Getter Method
Signature
DistanceBetween
Returns: Return type: NXOpen.Expression
New in version NX7.5.2.
License requirements: None.
EdgeSelection¶
-
WeldBuilder.
EdgeSelection
¶ Returns the edge(s) used to specify the location of the weld
-------------------------------------
Getter Method
Signature
EdgeSelection
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX7.5.2.
License requirements: None.
ElementType¶
-
WeldBuilder.
ElementType
¶ Returns the element type to be created for the weld
-------------------------------------
Getter Method
Signature
ElementType
Returns: Return type: NXOpen.CAE.ElementTypeBuilder
New in version NX7.5.2.
License requirements: None.
EndOffset¶
-
WeldBuilder.
EndOffset
¶ Returns the distance of the last point from the end of the edge(s)
-------------------------------------
Getter Method
Signature
EndOffset
Returns: Return type: NXOpen.Expression
New in version NX7.5.4.
License requirements: None.
FlipState¶
-
WeldBuilder.
FlipState
¶ Returns or sets the flip state of the selected edge(s)
-------------------------------------
Getter Method
Signature
FlipState
Returns: Return type: int New in version NX7.5.4.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------
Setter Method
Signature
FlipState
Parameters: flipState (int) – New in version NX7.5.4.
License requirements: nx_masterfem (“Finite Element Modeling”)
InputFile¶
-
WeldBuilder.
InputFile
¶ Returns or sets the name of the input file used to specify locations for the weld
-------------------------------------
Getter Method
Signature
InputFile
Returns: Return type: str New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputFile
Parameters: inputFile (str) – New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
Location¶
-
WeldBuilder.
Location
¶ Returns or sets the location of the specified weld
-------------------------------------
Getter Method
Signature
Location
Returns: Return type: NXOpen.CAE.WeldBuilderWeldLocation
New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
Location
Parameters: location ( NXOpen.CAE.WeldBuilderWeldLocation
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
NodeSelection¶
-
WeldBuilder.
NodeSelection
¶ Returns the node(s) used to specify the location of the weld
-------------------------------------
Getter Method
Signature
NodeSelection
Returns: Return type: NXOpen.CAE.SelectFENodeList
New in version NX7.5.2.
License requirements: None.
NumberOfPointsOnEdge¶
-
WeldBuilder.
NumberOfPointsOnEdge
¶ Returns or sets the number of points on the edge(s) used to specify the location of the weld
-------------------------------------
Getter Method
Signature
NumberOfPointsOnEdge
Returns: Return type: int New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfPointsOnEdge
Parameters: numberOfPoints (int) – New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
NumberOfPointsOption¶
-
WeldBuilder.
NumberOfPointsOption
¶ Returns or sets the option to specify the maximum number of points on the edge(s) used to specify the location of the weld
-------------------------------------
Getter Method
Signature
NumberOfPointsOption
Returns: Return type: NXOpen.CAE.WeldBuilderNumberOfPointsOnEdgeType
New in version NX7.5.4.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfPointsOption
Parameters: pointOnEdgeOption ( NXOpen.CAE.WeldBuilderNumberOfPointsOnEdgeType
) –New in version NX7.5.4.
License requirements: nx_masterfem (“Finite Element Modeling”)
OffsetDistance¶
-
WeldBuilder.
OffsetDistance
¶ Returns the distance to offset the points from the edge(s)
-------------------------------------
Getter Method
Signature
OffsetDistance
Returns: Return type: NXOpen.Expression
New in version NX7.5.4.
License requirements: None.
OffsetVector¶
-
WeldBuilder.
OffsetVector
¶ Returns or sets the vector along which to offset the points
-------------------------------------
Getter Method
Signature
OffsetVector
Returns: Return type: NXOpen.Direction
New in version NX7.5.4.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetVector
Parameters: offsetVector ( NXOpen.Direction
) –New in version NX7.5.4.
License requirements: nx_masterfem (“Finite Element Modeling”)
Pattern¶
-
WeldBuilder.
Pattern
¶ Returns or sets the pattern used to specify locations on the edge(s)
-------------------------------------
Getter Method
Signature
Pattern
Returns: Return type: str New in version NX7.5.4.
License requirements: None.
-------------------------------------
Setter Method
Signature
Pattern
Parameters: pattern (str) – New in version NX7.5.4.
License requirements: nx_masterfem (“Finite Element Modeling”)
PointOnEdgeOption¶
-
WeldBuilder.
PointOnEdgeOption
¶ Returns or sets the location of the points on the edge
-------------------------------------
Getter Method
Signature
PointOnEdgeOption
Returns: Return type: NXOpen.CAE.WeldBuilderPointOnEdgeType
New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
PointOnEdgeOption
Parameters: pointOnEdgeOption ( NXOpen.CAE.WeldBuilderPointOnEdgeType
) –New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
PointsSelection¶
-
WeldBuilder.
PointsSelection
¶ Returns the point(s) used to specify the location of the weld
-------------------------------------
Getter Method
Signature
PointsSelection
Returns: Return type: NXOpen.SelectTaggedObjectList
New in version NX7.5.2.
License requirements: None.
SearchDistance¶
-
WeldBuilder.
SearchDistance
¶ Returns the distance within which to search for PIDs
-------------------------------------
Getter Method
Signature
SearchDistance
Returns: Return type: NXOpen.Expression
New in version NX7.5.2.
License requirements: None.
SpecifiedNumberOfPoints¶
-
WeldBuilder.
SpecifiedNumberOfPoints
¶ Returns or sets the maximum number of points on the edge(s) used to specify the location of the weld
-------------------------------------
Getter Method
Signature
SpecifiedNumberOfPoints
Returns: Return type: int New in version NX7.5.4.
License requirements: None.
-------------------------------------
Setter Method
Signature
SpecifiedNumberOfPoints
Parameters: specifiedNumberOfPoints (int) – New in version NX7.5.4.
License requirements: nx_masterfem (“Finite Element Modeling”)
StartOffset¶
-
WeldBuilder.
StartOffset
¶ Returns the distance of the first point from the beginning of the edge(s)
-------------------------------------
Getter Method
Signature
StartOffset
Returns: Return type: NXOpen.Expression
New in version NX7.5.4.
License requirements: None.
SupportAllPids¶
-
WeldBuilder.
SupportAllPids
¶ Returns or sets the option to include all PIDs within the search distance for creating welds
-------------------------------------
Getter Method
Signature
SupportAllPids
Returns: Return type: bool New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
SupportAllPids
Parameters: isSupportAllPids (bool) – New in version NX7.5.2.
License requirements: nx_masterfem (“Finite Element Modeling”)
Method Detail¶
Validate¶
-
WeldBuilder.
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.