JoggleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# JoggleBuilder Class

class `NXOpen.Features.SheetMetal.``JoggleBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a Sheetmetal joggle builder class.

  To create a new instance of this class, use `NXOpen.Features.SheetMetal.SheetmetalManager.CreateJoggleBuilder()`

  Default values.

  Property | Value
  --- | ---
  Adjustment.Value | 0
  FlatPatternCompensation | 0
  LimitType | Single
  SymmetricSides | 1

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
Adjustment | Returns the adjustment
EndPlane | Returns or sets the end plane
FlatPatternCompensation | Returns or sets the flat pattern compensation
InputList | Returns the input list
LimitType | Returns or sets the limit type
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
Side1Options | Returns the joggle side 1 options
Side2Options | Returns the joggle side 2 options
StartPlane | Returns or sets the start plane
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
SymmetricSides | Returns or sets the symmetric sides
Tag | Returns the Tag for this object.
UseMaterialTable | Returns or sets the Use Material Table

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
CreateJoggleInputListItem | Create a input list item.
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.
GetFeature | Returns the feature currently being edited by this builder.
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.
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.

# Enumerations

JoggleBuilderLimitTypes Enumeration | This enum defines the limit types

# Property Detail

## Adjustment

`JoggleBuilder.``Adjustment`

  Returns the adjustment

  `-------------------------------------`

  Getter Method

  Signature `Adjustment`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.0.

  License requirements: None.

## EndPlane

`JoggleBuilder.``EndPlane`

  Returns or sets the end plane

  `-------------------------------------`

  Getter Method

  Signature `EndPlane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EndPlane`

  Parameters: | endPlane (`NXOpen.Plane`) –

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## FlatPatternCompensation

`JoggleBuilder.``FlatPatternCompensation`

  Returns or sets the flat pattern compensation

  `-------------------------------------`

  Getter Method

  Signature `FlatPatternCompensation`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FlatPatternCompensation`

  Parameters: | flatPatternCompensation (bool) –

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## InputList

`JoggleBuilder.``InputList`

  Returns the input list

  `-------------------------------------`

  Getter Method

  Signature `InputList`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.JoggleInputListItemBuilderList`

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## LimitType

`JoggleBuilder.``LimitType`

  Returns or sets the limit type

  `-------------------------------------`

  Getter Method

  Signature `LimitType`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.JoggleBuilderLimitTypes`

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LimitType`

  Parameters: | limitType (`NXOpen.Features.SheetMetal.JoggleBuilderLimitTypes`) –

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## Side1Options

`JoggleBuilder.``Side1Options`

  Returns the joggle side 1 options

  `-------------------------------------`

  Getter Method

  Signature `Side1Options`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.JoggleSideOptionsBuilder`

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## Side2Options

`JoggleBuilder.``Side2Options`

  Returns the joggle side 2 options

  `-------------------------------------`

  Getter Method

  Signature `Side2Options`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.JoggleSideOptionsBuilder`

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## StartPlane

`JoggleBuilder.``StartPlane`

  Returns or sets the start plane

  `-------------------------------------`

  Getter Method

  Signature `StartPlane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StartPlane`

  Parameters: | startPlane (`NXOpen.Plane`) –

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## SymmetricSides

`JoggleBuilder.``SymmetricSides`

  Returns or sets the symmetric sides

  `-------------------------------------`

  Getter Method

  Signature `SymmetricSides`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SymmetricSides`

  Parameters: | symmetricSides (bool) –

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## UseMaterialTable

`JoggleBuilder.``UseMaterialTable`

  Returns or sets the Use Material Table

  `-------------------------------------`

  Getter Method

  Signature `UseMaterialTable`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseMaterialTable`

  Parameters: | useMaterialTable (bool) –

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

# Method Detail

## CreateJoggleInputListItem

`JoggleBuilder.``CreateJoggleInputListItem`

  Create a input list item.

  Signature `CreateJoggleInputListItem()`

  Returns: |
  Return type: | `NXOpen.Features.SheetMetal.JoggleInputListItemBuilder`

  New in version NX11.0.0.

  License requirements: adv_sheet_metal_dsgn (“ADVANCED SHEET METAL DESIGN”)

## Validate

`JoggleBuilder.``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.