JointmarkGuideBuilder Class¶
-
class
NXOpen.Weld.
JointmarkGuideBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Used to create or edit a guide curve for Jointmark.
To create a new instance of this class, use
NXOpen.Weld.JointmarkBuilder.NewGuide
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
EndDistance | Returns the end distance. |
ExtendOffset | Returns or sets the extend offset. |
GuideCurve | Returns or sets the guide curve. |
LocationOption | Returns or sets the location option. |
NumberOfPoints | Returns or sets the number to determine the points along the guide curve. |
OffsetDistance | Returns the offset distance. |
ReverseDirection | Returns or sets the reversal status of Guide Curve direction. |
Section1 | Returns the first section used in Centerline. |
Section2 | Returns the second section used in Centerline. |
Section3 | Returns the third section used in Offset from Edge. |
Section4 | Returns the fourth section used in Existing Curve. |
Spacing | Returns the spacing to determine the points along the guide curve. |
SpacingMethod | Returns or sets the spacing method. |
SpacingOption | Returns or sets the spacing option. |
StartDistance | Returns the start distance. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
CreateGuideCurves | Creates the guide curves. |
GetGuideCurves | Gets the created curves curves. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
JointmarkGuideBuilderLocation Enumeration | The type of guide curve |
JointmarkGuideBuilderSpaceMethod Enumeration | Options for Spacing Method |
JointmarkGuideBuilderSpaceOption Enumeration | Spacing Option |
Property Detail¶
EndDistance¶
-
JointmarkGuideBuilder.
EndDistance
¶ Returns the end distance.
-------------------------------------
Getter Method
Signature
EndDistance()
Returns: Return type: NXOpen.GeometricUtilities.OnPathDimensionBuilder
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
ExtendOffset¶
-
JointmarkGuideBuilder.
ExtendOffset
¶ Returns or sets the extend offset.
-------------------------------------
Getter Method
Signature
ExtendOffset()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ExtendOffset(extendOffset)
Parameters: extendOffset (bool) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
GuideCurve¶
-
JointmarkGuideBuilder.
GuideCurve
¶ Returns or sets the guide curve.
-------------------------------------
Getter Method
Signature
GuideCurve()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
GuideCurve(guide)
Parameters: guide ( NXOpen.Section
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
LocationOption¶
-
JointmarkGuideBuilder.
LocationOption
¶ Returns or sets the location option.
-------------------------------------
Getter Method
Signature
LocationOption()
Returns: Return type: NXOpen.Weld.JointmarkGuideBuilderLocation
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
LocationOption(locationOption)
Parameters: locationOption ( NXOpen.Weld.JointmarkGuideBuilderLocation
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
NumberOfPoints¶
-
JointmarkGuideBuilder.
NumberOfPoints
¶ Returns or sets the number to determine the points along the guide curve.
-------------------------------------
Getter Method
Signature
NumberOfPoints()
Returns: Return type: int New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
NumberOfPoints(number)
Parameters: number (int) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
OffsetDistance¶
-
JointmarkGuideBuilder.
OffsetDistance
¶ Returns the offset distance.
-------------------------------------
Getter Method
Signature
OffsetDistance()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
ReverseDirection¶
-
JointmarkGuideBuilder.
ReverseDirection
¶ Returns or sets the reversal status of Guide Curve direction.
-------------------------------------
Getter Method
Signature
ReverseDirection()
Returns: Return type: bool New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
ReverseDirection(reverse)
Parameters: reverse (bool) – New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Section1¶
-
JointmarkGuideBuilder.
Section1
¶ Returns the first section used in Centerline.
-------------------------------------
Getter Method
Signature
Section1()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Section2¶
-
JointmarkGuideBuilder.
Section2
¶ Returns the second section used in Centerline.
-------------------------------------
Getter Method
Signature
Section2()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Section3¶
-
JointmarkGuideBuilder.
Section3
¶ Returns the third section used in Offset from Edge.
-------------------------------------
Getter Method
Signature
Section3()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Section4¶
-
JointmarkGuideBuilder.
Section4
¶ Returns the fourth section used in Existing Curve.
-------------------------------------
Getter Method
Signature
Section4()
Returns: Return type: NXOpen.Section
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Spacing¶
-
JointmarkGuideBuilder.
Spacing
¶ Returns the spacing to determine the points along the guide curve.
-------------------------------------
Getter Method
Signature
Spacing()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
SpacingMethod¶
-
JointmarkGuideBuilder.
SpacingMethod
¶ Returns or sets the spacing method.
-------------------------------------
Getter Method
Signature
SpacingMethod()
Returns: Return type: NXOpen.Weld.JointmarkGuideBuilderSpaceMethod
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SpacingMethod(spacingMethod)
Parameters: spacingMethod ( NXOpen.Weld.JointmarkGuideBuilderSpaceMethod
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
SpacingOption¶
-
JointmarkGuideBuilder.
SpacingOption
¶ Returns or sets the spacing option.
-------------------------------------
Getter Method
Signature
SpacingOption()
Returns: Return type: NXOpen.Weld.JointmarkGuideBuilderSpaceOption
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
-------------------------------------
Setter Method
Signature
SpacingOption(spacingOption)
Parameters: spacingOption ( NXOpen.Weld.JointmarkGuideBuilderSpaceOption
) –New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
StartDistance¶
-
JointmarkGuideBuilder.
StartDistance
¶ Returns the start distance.
-------------------------------------
Getter Method
Signature
StartDistance()
Returns: Return type: NXOpen.GeometricUtilities.OnPathDimensionBuilder
New in version NX9.0.0.
License requirements: ugweld (“UG WELD”)
Method Detail¶
CreateGuideCurves¶
-
JointmarkGuideBuilder.
CreateGuideCurves
¶ Creates the guide curves.
Signature
CreateGuideCurves()
New in version NX9.0.1.
License requirements: ugweld (“UG WELD”)
GetGuideCurves¶
-
JointmarkGuideBuilder.
GetGuideCurves
¶ Gets the created curves curves.
The guide curves need to exist before calling this, or nothing will be returned.
Signature
GetGuideCurves()
Returns: a tuple Return type: A tuple consisting of (guideCurves, instanceGuideCurves). guideCurves is a list of NXOpen.ICurve
. The array of curves.instanceGuideCurves is a list ofNXOpen.NXObject
. The array of component curve instances. If there is not an assembly, then this will match the prototype curve.New in version NX9.0.1.
License requirements: ugweld (“UG WELD”)
Validate¶
-
JointmarkGuideBuilder.
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.