LouverBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# LouverBuilder Class

class `NXOpen.Features.SheetMetal.``LouverBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a louver feature builder.

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

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
Depth | Returns the depth of the louver
DepthSide | Returns or sets the depth side for the louver.
DieRadius | Returns the die radius.
EndType | Returns or sets the end type for the louver.
IncludeRounding | Returns or sets the option to round the edges of the louver using the die radius.
MinimumToolClearance | Returns the minimum tool clearance expression.
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 the section used by the louver.
SectionSide | Returns or sets the side of the section on which the louver is created and width is measure.
Sketch | Returns or sets the internal sketch used by the louver’s section.
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Width | Returns the width of the louver.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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.
SetDepth |
SetDieRadius |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
SetWidth |
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 | This method verifies that the builder data is valid for louver creation.

# Enumerations

LouverBuilderDepthSideOptions Enumeration | This enum represents the depth side for the louver.
LouverBuilderEndTypeOptions Enumeration | This enum represents the end type for the louver.
LouverBuilderSectionSideOptions Enumeration | This enum represents the side of the section that the louver width is measured.

# Property Detail

## Depth

`LouverBuilder.``Depth`

  Returns the depth of the louver

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

  Getter Method

  Signature `Depth`

  Returns: | The depth of the louver
  Return type: | `NXOpen.Expression`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## DepthSide

`LouverBuilder.``DepthSide`

  Returns or sets the depth side for the louver.

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

  Getter Method

  Signature `DepthSide`

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

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

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

  Setter Method

  Signature `DepthSide`

  Parameters: | depthSide (`NXOpen.Features.SheetMetal.LouverBuilderDepthSideOptions`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## DieRadius

`LouverBuilder.``DieRadius`

  Returns the die radius.

  Not used if `NXOpen.Features.SheetMetal.LouverBuilder.IncludeRounding()` is false.

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

  Getter Method

  Signature `DieRadius`

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

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## EndType

`LouverBuilder.``EndType`

  Returns or sets the end type for the louver.

  Select lanced end or formed end from `NXOpen.Features.SheetMetal.LouverBuilderEndTypeOptions`.

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

  Getter Method

  Signature `EndType`

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

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

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

  Setter Method

  Signature `EndType`

  Parameters: | endType (`NXOpen.Features.SheetMetal.LouverBuilderEndTypeOptions`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## IncludeRounding

`LouverBuilder.``IncludeRounding`

  Returns or sets the option to round the edges of the louver using the die radius.

  If this is false, then the value of `NXOpen.Features.SheetMetal.LouverBuilder.DieRadius()` is not used.

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

  Getter Method

  Signature `IncludeRounding`

  Returns: |
  Return type: | bool

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

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

  Setter Method

  Signature `IncludeRounding`

  Parameters: | includeRounding (bool) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## MinimumToolClearance

`LouverBuilder.``MinimumToolClearance`

  Returns the minimum tool clearance expression.

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

  Getter Method

  Signature `MinimumToolClearance`

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

  New in version NX6.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## Section

`LouverBuilder.``Section`

  Returns or sets the section used by the louver.

  The section should be open.

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

  Getter Method

  Signature `Section`

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

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

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

  Setter Method

  Signature `Section`

  Parameters: | section (`NXOpen.Section`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## SectionSide

`LouverBuilder.``SectionSide`

  Returns or sets the side of the section on which the louver is created and width is measure.

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

  Getter Method

  Signature `SectionSide`

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

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

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

  Setter Method

  Signature `SectionSide`

  Parameters: | sectionSide (`NXOpen.Features.SheetMetal.LouverBuilderSectionSideOptions`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## Sketch

`LouverBuilder.``Sketch`

  Returns or sets the internal sketch used by the louver’s section.

  If the sketch is created internally as part of the louver command in the UI, then it is consumed by the louver and does not show up as a separate feature in the part navigator. By setting the sketch object here, you will be making it internal to the louver feature.

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

  Getter Method

  Signature `Sketch`

  Returns: |
  Return type: | `NXOpen.Features.SketchFeature`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

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

  Setter Method

  Signature `Sketch`

  Parameters: | sketch (`NXOpen.Features.SketchFeature`) –

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## Width

`LouverBuilder.``Width`

  Returns the width of the louver.

  The side of the section that the width is measured from depends on the value of the section side (see `NXOpen.Features.SheetMetal.LouverBuilder.SectionSide()`).

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

  Getter Method

  Signature `Width`

  Returns: | The width of the louver
  Return type: | `NXOpen.Expression`

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

# Method Detail

## SetDepth

`LouverBuilder.``SetDepth`

  Signature `SetDepth(depth)`

  Parameters: | depth (str) –

  New in version NX4.0.0.

  Deprecated since version NX10.0.0: Use `NXOpen.Expression.RightHandSide()` on the `NXOpen.Expression` object returned from `NXOpen.Features.SheetMetal.LouverBuilder.Depth()` instead.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## SetDieRadius

`LouverBuilder.``SetDieRadius`

  Signature `SetDieRadius(dieRadius)`

  Parameters: | dieRadius (str) –

  New in version NX4.0.0.

  Deprecated since version NX10.0.0: Use `NXOpen.Expression.RightHandSide()` on the `NXOpen.Expression` object returned from `NXOpen.Features.SheetMetal.LouverBuilder.DieRadius()` instead.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## SetWidth

`LouverBuilder.``SetWidth`

  Signature `SetWidth(width)`

  Parameters: | width (str) –

  New in version NX4.0.0.

  Deprecated since version NX10.0.0: Use `NXOpen.Expression.RightHandSide()` on the `NXOpen.Expression` object returned from `NXOpen.Features.SheetMetal.LouverBuilder.Width()` instead.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)

## Validate

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

`LouverBuilder.``ValidateBuilderData`

  This method verifies that the builder data is valid for louver creation.

  If the builder data is valid, it returns a value of 0.

  Signature `ValidateBuilderData()`

  Returns: | data validity flag
  Return type: | int

  New in version NX4.0.0.

  License requirements: nx_sheet_metal (“NX Sheet Metal”)