ElementExtrudeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ElementExtrudeBuilder Class

class `NXOpen.CAE.``ElementExtrudeBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.CAE.ElementExtrudeBuilder`

  To create a new instance of this class, use `NXOpen.CAE.NodeElementManager.CreateElementExtrudeBuilder()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Axis | Returns or sets the axis.
CollectorName | Returns or sets the mesh collector name
Distance | Returns the distance
DistanceOption | Returns or sets the distance option
Edge | Returns the edge when extrude along path
ElementDimensionOption | Returns or sets the element dimension option
ElementType | Returns the element type builder.
Elements | Returns the selected elements
ExportMesh | Returns or sets the option which indicates whether mesh is exported to solver or not.
Face | Returns the face when extrude by project to surface
FlipState | Returns or sets the flip state from the builder
Increment | Returns or sets the increment
Label | Returns or sets the label
MeshName | Returns or sets the mesh name
MethodOption | Returns or sets the method option
NeutralName | Returns or sets the element neutral name
NewMeshOption | Returns or sets the new mesh option
NumberOfCopy | Returns or sets the number of copy
PercentOffset | Returns or sets the percent offset
RetainCollector | Returns or sets the the flag which decides whether collectors are to be retained or not
Tag | Returns the Tag for this object.
TwistAngle | Returns the twist angle
TwistOrigin | Returns or sets the twist origin
Vector | Returns or sets the vector when extrude along vector

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
Flip | Flip the direction of extrude - not journalled
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ElementExtrudeBuilderDistanceType Enumeration | Distance option
ElementExtrudeBuilderElemDimType Enumeration | Dimension of element to be created
ElementExtrudeBuilderMethodType Enumeration | Extrusion method
ElementExtrudeBuilderNewMeshType Enumeration | Option to create new mesh or add to existing mesh

# Property Detail

## Axis

`ElementExtrudeBuilder.``Axis`

  Returns or sets the axis.

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

  Getter Method

  Signature `Axis`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Axis`

  Parameters: | axis (`NXOpen.Axis`) –

  New in version NX11.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## CollectorName

`ElementExtrudeBuilder.``CollectorName`

  Returns or sets the mesh collector name

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

  Getter Method

  Signature `CollectorName`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CollectorName`

  Parameters: | collectorName (str) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Distance

`ElementExtrudeBuilder.``Distance`

  Returns the distance

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

  Getter Method

  Signature `Distance`

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

  New in version NX5.0.0.

  License requirements: None.

## DistanceOption

`ElementExtrudeBuilder.``DistanceOption`

  Returns or sets the distance option

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

  Getter Method

  Signature `DistanceOption`

  Returns: |
  Return type: | `NXOpen.CAE.ElementExtrudeBuilderDistanceType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceOption`

  Parameters: | distanceOption (`NXOpen.CAE.ElementExtrudeBuilderDistanceType`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Edge

`ElementExtrudeBuilder.``Edge`

  Returns the edge when extrude along path

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

  Getter Method

  Signature `Edge`

  Returns: |
  Return type: | `NXOpen.CAE.SelectCAEEdge`

  New in version NX5.0.0.

  License requirements: None.

## ElementDimensionOption

`ElementExtrudeBuilder.``ElementDimensionOption`

  Returns or sets the element dimension option

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

  Getter Method

  Signature `ElementDimensionOption`

  Returns: |
  Return type: | `NXOpen.CAE.ElementExtrudeBuilderElemDimType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ElementDimensionOption`

  Parameters: | elementDimensionOption (`NXOpen.CAE.ElementExtrudeBuilderElemDimType`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementType

`ElementExtrudeBuilder.``ElementType`

  Returns the element type builder.

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

  Getter Method

  Signature `ElementType`

  Returns: |
  Return type: | `NXOpen.CAE.ElementTypeBuilder`

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Elements

`ElementExtrudeBuilder.``Elements`

  Returns the selected elements

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

  Getter Method

  Signature `Elements`

  Returns: |
  Return type: | `NXOpen.CAE.SelectElementsBuilder`

  New in version NX5.0.0.

  License requirements: None.

## ExportMesh

`ElementExtrudeBuilder.``ExportMesh`

  Returns or sets the option which indicates whether mesh is exported to solver or not.

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

  Getter Method

  Signature `ExportMesh`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExportMesh`

  Parameters: | fExportMesh (bool) –

  New in version NX10.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Face

`ElementExtrudeBuilder.``Face`

  Returns the face when extrude by project to surface

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

  Getter Method

  Signature `Face`

  Returns: |
  Return type: | `NXOpen.CAE.SelectCAEFaceList`

  New in version NX5.0.0.

  License requirements: None.

## FlipState

`ElementExtrudeBuilder.``FlipState`

  Returns or sets the flip state from the builder

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

  Getter Method

  Signature `FlipState`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `FlipState`

  Parameters: | flipstate (int) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Increment

`ElementExtrudeBuilder.``Increment`

  Returns or sets the increment

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

  Getter Method

  Signature `Increment`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Increment`

  Parameters: | increment (int) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Label

`ElementExtrudeBuilder.``Label`

  Returns or sets the label

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

  Getter Method

  Signature `Label`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Label`

  Parameters: | label (int) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MeshName

`ElementExtrudeBuilder.``MeshName`

  Returns or sets the mesh name

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

  Getter Method

  Signature `MeshName`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MeshName`

  Parameters: | meshName (str) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MethodOption

`ElementExtrudeBuilder.``MethodOption`

  Returns or sets the method option

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

  Getter Method

  Signature `MethodOption`

  Returns: |
  Return type: | `NXOpen.CAE.ElementExtrudeBuilderMethodType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MethodOption`

  Parameters: | methodOption (`NXOpen.CAE.ElementExtrudeBuilderMethodType`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NeutralName

`ElementExtrudeBuilder.``NeutralName`

  Returns or sets the element neutral name

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

  Getter Method

  Signature `NeutralName`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NeutralName`

  Parameters: | neutralName (str) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NewMeshOption

`ElementExtrudeBuilder.``NewMeshOption`

  Returns or sets the new mesh option

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

  Getter Method

  Signature `NewMeshOption`

  Returns: |
  Return type: | `NXOpen.CAE.ElementExtrudeBuilderNewMeshType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NewMeshOption`

  Parameters: | newMeshOption (`NXOpen.CAE.ElementExtrudeBuilderNewMeshType`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NumberOfCopy

`ElementExtrudeBuilder.``NumberOfCopy`

  Returns or sets the number of copy

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

  Getter Method

  Signature `NumberOfCopy`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumberOfCopy`

  Parameters: | numberOfCopy (int) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## PercentOffset

`ElementExtrudeBuilder.``PercentOffset`

  Returns or sets the percent offset

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

  Getter Method

  Signature `PercentOffset`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PercentOffset`

  Parameters: | percentOffset (float) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## RetainCollector

`ElementExtrudeBuilder.``RetainCollector`

  Returns or sets the the flag which decides whether collectors are to be retained or not

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

  Getter Method

  Signature `RetainCollector`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RetainCollector`

  Parameters: | isRetain (bool) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## TwistAngle

`ElementExtrudeBuilder.``TwistAngle`

  Returns the twist angle

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

  Getter Method

  Signature `TwistAngle`

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

  New in version NX5.0.0.

  License requirements: None.

## TwistOrigin

`ElementExtrudeBuilder.``TwistOrigin`

  Returns or sets the twist origin

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

  Getter Method

  Signature `TwistOrigin`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TwistOrigin`

  Parameters: | twistOrigin (`NXOpen.Point`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Vector

`ElementExtrudeBuilder.``Vector`

  Returns or sets the vector when extrude along vector

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

  Getter Method

  Signature `Vector`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Vector`

  Parameters: | vector (`NXOpen.Direction`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

# Method Detail

## Flip

`ElementExtrudeBuilder.``Flip`

  Flip the direction of extrude - not journalled

  Signature `Flip()`

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Validate

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