JogBuilder Class¶
-
class
NXOpen.Features.SheetMetal.
JogBuilder
¶ Bases:
NXOpen.Features.SheetMetal.SheetmetalBaseBuilder
Represents a Jog feature builder.
To create a new instance of this class, use
NXOpen.Features.SheetMetal.SheetmetalManager.CreateJogFeatureBuilder()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
BendLocation | Returns or sets |
BendOptions | Returns the bend options. |
DimensionType | Returns or sets the Offset Dimension |
DirectionType | Returns or sets |
ExtendProfile | Returns or sets |
FixedSide | Returns or sets |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
Section | Returns or sets |
Sketch | Returns or sets |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TargetFace | Returns or sets the target face on which jog feature applies. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetApplicationContext | Get the application context. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFeature | Returns the feature currently being edited by this builder. |
GetHeight | Height of the Jog @return |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetApplicationContext | Set the application context. |
SetHeight | |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
ValidateBuilderData | Verify whether the builder data is valid for creating a jog or not. |
Enumerations¶
JogBuilderBendLocationOptions Enumeration | Represents the bend location type. |
JogBuilderDimensionTypeOptions Enumeration | the Dimension options for jog. |
JogBuilderDirectionTypeOptions Enumeration | this enum represents the direction for the Jog. |
JogBuilderFixedSideOptions Enumeration | The left option represents the side to the left of a person who is walking along the section in the direction of its curves when the section normal is pointing up. |
Property Detail¶
BendLocation¶
-
JogBuilder.
BendLocation
¶ Returns or sets
-------------------------------------
Getter Method
Signature
BendLocation()
Returns: Return type: NXOpen.Features.SheetMetal.JogBuilderBendLocationOptions
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
BendLocation(bendLocation)
Parameters: bendLocation ( NXOpen.Features.SheetMetal.JogBuilderBendLocationOptions
) –New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
BendOptions¶
-
JogBuilder.
BendOptions
¶ Returns the bend options.
The option
Features.SheetMetal.BendOptionsCornerReliefTypeOptions.None
is not valid for theFeatures.Jog
starting NX11 onwards.-------------------------------------
Getter Method
Signature
BendOptions()
Returns: Return type: NXOpen.Features.SheetMetal.BendOptions
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
DimensionType¶
-
JogBuilder.
DimensionType
¶ Returns or sets the Offset Dimension
The actual extent distance of the Jog will be determined by the active dimension option. In case of
Features.SheetMetal.JogBuilderDimensionTypeOptions.Offset
the actual extent distance will be offset dimension distance plus the thickness of sheet. In case ofFeatures.SheetMetal.JogBuilderDimensionTypeOptions.Full
the actual extent distance will be the Full dimension distance.-------------------------------------
Getter Method
Signature
DimensionType()
Returns: Return type: NXOpen.Features.SheetMetal.JogBuilderDimensionTypeOptions
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
DimensionType(dimensionType)
Parameters: dimensionType ( NXOpen.Features.SheetMetal.JogBuilderDimensionTypeOptions
) –New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
DirectionType¶
-
JogBuilder.
DirectionType
¶ Returns or sets
-------------------------------------
Getter Method
Signature
DirectionType()
Returns: Return type: NXOpen.Features.SheetMetal.JogBuilderDirectionTypeOptions
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
DirectionType(directionType)
Parameters: directionType ( NXOpen.Features.SheetMetal.JogBuilderDirectionTypeOptions
) –New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
ExtendProfile¶
-
JogBuilder.
ExtendProfile
¶ Returns or sets
-------------------------------------
Getter Method
Signature
ExtendProfile()
Returns: Return type: bool New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
ExtendProfile(extendOption)
Parameters: extendOption (bool) – New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
FixedSide¶
-
JogBuilder.
FixedSide
¶ Returns or sets
-------------------------------------
Getter Method
Signature
FixedSide()
Returns: Return type: NXOpen.Features.SheetMetal.JogBuilderFixedSideOptions
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
FixedSide(sectionSide)
Parameters: sectionSide ( NXOpen.Features.SheetMetal.JogBuilderFixedSideOptions
) –New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
Section¶
-
JogBuilder.
Section
¶ Returns or sets
-------------------------------------
Getter Method
Signature
Section()
Returns: Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
Section(section)
Parameters: section ( NXOpen.Section
) –New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
Sketch¶
-
JogBuilder.
Sketch
¶ Returns or sets
-------------------------------------
Getter Method
Signature
Sketch()
Returns: Return type: NXOpen.Features.SketchFeature
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
Sketch(sketch)
Parameters: sketch ( NXOpen.Features.SketchFeature
) –New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
TargetFace¶
-
JogBuilder.
TargetFace
¶ Returns or sets the target face on which jog feature applies.
-------------------------------------
Getter Method
Signature
TargetFace()
Returns: Returns the target face on which the jog feature is created. Return type: NXOpen.Face
New in version NX10.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
-------------------------------------
Setter Method
Signature
TargetFace(targetFace)
Parameters: targetFace ( NXOpen.Face
) – A planar non-deform sheet metal face on which the jog feature is to be created.New in version NX10.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
Method Detail¶
GetHeight¶
-
JogBuilder.
GetHeight
¶ Height of the Jog
Signature
GetHeight()
Returns: Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
SetHeight¶
-
JogBuilder.
SetHeight
¶ Signature
SetHeight(height)
Parameters: height (str) – New in version NX5.0.0.
Deprecated since version NX10.0.0: Use
Expression.RightHandSide()
on theExpression
object returned fromFeatures.SheetMetal.JogBuilder.GetHeight()
instead.License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)
Validate¶
-
JogBuilder.
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.
ValidateBuilderData¶
-
JogBuilder.
ValidateBuilderData
¶ Verify whether the builder data is valid for creating a jog or not.
If the Builder data is valid, returned value shall be 0
Signature
ValidateBuilderData()
Returns: Data Validity Flag. Return type: int New in version NX5.0.0.
License requirements: nx_sheet_metal (“NX Sheet Metal”) OR nx_flexible_pcb (“NX Flexible PCB”)