JointItemBuilder Class

class NXOpen.Weld.JointItemBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Used to create or edit a Weld.WeldJoint feature.

To create a new instance of this class, use NXOpen.Weld.WeldJointBuilder.NewItem()

New in version NX8.0.0.

Properties

Property	Description
BackingFace	Returns the backing face.
Curve	Returns the joint curve
Limits	Returns the limits of the joint curve span.
MasterEdge	Returns the master edge of a T-joint weld.
PlacementFace	Returns the placement face of a T-joint weld.
PrimaryEdge	Returns the primary edge of a butt weld.
PrimaryFace	Returns the primary face of a butt weld.
RoutingObject	Returns the routing port.
SecondaryEdge	Returns the secondary edge of a butt weld.
SecondaryFace	Returns the secondary face of a butt weld.
Tag	Returns the Tag for this object.
TargetFace	Returns the target face of a T-joint weld.
UseCallbackValues	Returns or sets the indication to use the values of the callback to define the joint
WeldType	Returns or sets the weld type
WeldingCharacteristics	Returns the collection of welding characteristics defined by attributes.

Methods

Method	Description
DeleteCurve	Deletes the joint curve from the builder.
GetPortEngagement	Returns the engagement distance of the parent port of the pipe joint
ReadEdgePrepValues	Read edge prep values set by the user plugin function.
SaveEdgePrepValues	Save edge prep values to the Welding Joint.
SetCallbackMessage	Sets a message to display after callback processing ends
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

BackingFace

JointItemBuilder.BackingFace

Returns the backing face.

-------------------------------------

Getter Method

Signature BackingFace

Returns: Return type:NXOpen.ScCollector

New in version NX9.0.0.

License requirements: None.

Curve

JointItemBuilder.Curve

Returns the joint curve

-------------------------------------

Getter Method

Signature Curve

Returns: Return type:NXOpen.Curve

New in version NX8.5.0.

License requirements: None.

Limits

JointItemBuilder.Limits

Returns the limits of the joint curve span.

-------------------------------------

Getter Method

Signature Limits

Returns: Return type:NXOpen.Die.DieLimitsBuilder

New in version NX8.0.0.

License requirements: None.

MasterEdge

JointItemBuilder.MasterEdge

Returns the master edge of a T-joint weld.

-------------------------------------

Getter Method

Signature MasterEdge

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

PlacementFace

JointItemBuilder.PlacementFace

Returns the placement face of a T-joint weld.

For example, on a profile it is the face that touches the plate.

-------------------------------------

Getter Method

Signature PlacementFace

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

PrimaryEdge

JointItemBuilder.PrimaryEdge

Returns the primary edge of a butt weld.

-------------------------------------

Getter Method

Signature PrimaryEdge

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

PrimaryFace

JointItemBuilder.PrimaryFace

Returns the primary face of a butt weld.

-------------------------------------

Getter Method

Signature PrimaryFace

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

RoutingObject

JointItemBuilder.RoutingObject

Returns the routing port.

-------------------------------------

Getter Method

Signature RoutingObject

Returns: Return type:NXOpen.Routing.SelectPort

New in version NX10.0.0.

License requirements: None.

SecondaryEdge

JointItemBuilder.SecondaryEdge

Returns the secondary edge of a butt weld.

-------------------------------------

Getter Method

Signature SecondaryEdge

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

SecondaryFace

JointItemBuilder.SecondaryFace

Returns the secondary face of a butt weld.

-------------------------------------

Getter Method

Signature SecondaryFace

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

TargetFace

JointItemBuilder.TargetFace

Returns the target face of a T-joint weld.

For example, the plate face that the profile lies on.

-------------------------------------

Getter Method

Signature TargetFace

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

UseCallbackValues

JointItemBuilder.UseCallbackValues

Returns or sets the indication to use the values of the callback to define the joint

-------------------------------------

Getter Method

Signature UseCallbackValues

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseCallbackValues

Parameters:status (bool) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

WeldType

JointItemBuilder.WeldType

Returns or sets the weld type

-------------------------------------

Getter Method

Signature WeldType

Returns: Return type:int

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature WeldType

Parameters:type (int) –

New in version NX8.5.0.

License requirements: structure_weld (“STRUCTURE WELD”)

WeldingCharacteristics

JointItemBuilder.WeldingCharacteristics

Returns the collection of welding characteristics defined by attributes.

-------------------------------------

Getter Method

Signature WeldingCharacteristics

Returns: Return type:NXOpen.Weld.CharacteristicsBuilder

New in version NX8.0.0.

License requirements: None.

Method Detail

DeleteCurve

JointItemBuilder.DeleteCurve

Deletes the joint curve from the builder.

Signature DeleteCurve()

New in version NX8.0.0.

License requirements: None.

GetPortEngagement

JointItemBuilder.GetPortEngagement

Returns the engagement distance of the parent port of the pipe joint

Signature GetPortEngagement()

Returns:Engagement distance Return type:float

New in version NX10.0.3.

License requirements: None.

ReadEdgePrepValues

JointItemBuilder.ReadEdgePrepValues

Read edge prep values set by the user plugin function.

Signature ReadEdgePrepValues()

Returns: Return type:NXOpen.Weld.EdgePrepValuesBuilder

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SaveEdgePrepValues

JointItemBuilder.SaveEdgePrepValues

Save edge prep values to the Welding Joint.

Signature SaveEdgePrepValues(valuesBuilder)

Parameters:valuesBuilder (NXOpen.Weld.EdgePrepValuesBuilder) –

New in version NX8.0.0.

License requirements: structure_weld (“STRUCTURE WELD”)

SetCallbackMessage

JointItemBuilder.SetCallbackMessage

Sets a message to display after callback processing ends

Signature SetCallbackMessage(message)

Parameters:message (str) – Message to display to user

New in version NX11.0.2.

License requirements: structure_weld (“STRUCTURE WELD”)

Validate

JointItemBuilder.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.