ElementRotateBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ElementRotateBuilder Class

class `NXOpen.CAE.``ElementRotateBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.CAE.ElementRotateBuilder`

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

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
Angle | Returns the theta angle for translation in a cylindrical/spherical coordinate system
Axis | Returns or sets the axis.
CopyOption | Returns or sets the copy option .
DistanceCopyOption | Returns or sets the distance option
ElementDimension | Returns or sets the dimension of the elements to be rotated
ElementSelection | Returns the selected elements
ElementType | Returns the element type builder.
Increment | Returns or sets the increment in label for each new element
Label | Returns or sets the start label for the new elements
LabelOption | Returns or sets the option to specify the start label and increment for the new elements OR specify an offset from the existing element labels
MeshCollectorName | Returns or sets the name of the mesh collector which will hold the new elements
MeshName | Returns or sets the name of the mesh that will hold the new elements
NeutralName | Returns or sets the neutral name of the elements to be created
NewMeshOption | Returns or sets the option to create a new mesh or add the new elements to an existing mesh
NumCopy | Returns or sets the number of copies to be created for each selected element
Offset | Returns or sets the offset to be used to generate new element labels
Tag | Returns the Tag for this object.

# 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.
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

ElementRotateBuilderCopyType Enumeration | the copy types
ElementRotateBuilderDistanceType Enumeration | Distance - specify whether the translation distance is per copy or total
ElementRotateBuilderElemDimensionType Enumeration | Dimension of the elements to be created
ElementRotateBuilderLabelType Enumeration | Option to use label/increment or offset
ElementRotateBuilderMethodType Enumeration | Translation method
ElementRotateBuilderNewMeshType Enumeration | Option to create a new mesh or add the new elements to an existing mesh

# Property Detail

## Angle

`ElementRotateBuilder.``Angle`

  Returns the theta angle for translation in a cylindrical/spherical coordinate system

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

  Getter Method

  Signature `Angle`

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

  New in version NX12.0.0.

  License requirements: None.

## Axis

`ElementRotateBuilder.``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”)

## CopyOption

`ElementRotateBuilder.``CopyOption`

  Returns or sets the copy option .

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

  Getter Method

  Signature `CopyOption`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CopyOption`

  Parameters: | inCopyoption (`NXOpen.CAE.ElementRotateBuilderCopyType`) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## DistanceCopyOption

`ElementRotateBuilder.``DistanceCopyOption`

  Returns or sets the distance option

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

  Getter Method

  Signature `DistanceCopyOption`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceCopyOption`

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

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementDimension

`ElementRotateBuilder.``ElementDimension`

  Returns or sets the dimension of the elements to be rotated

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

  Getter Method

  Signature `ElementDimension`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ElementDimension`

  Parameters: | elementDimension (`NXOpen.CAE.ElementRotateBuilderElemDimensionType`) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementSelection

`ElementRotateBuilder.``ElementSelection`

  Returns the selected elements

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

  Getter Method

  Signature `ElementSelection`

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

  New in version NX12.0.0.

  License requirements: None.

## ElementType

`ElementRotateBuilder.``ElementType`

  Returns the element type builder.

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

  Getter Method

  Signature `ElementType`

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

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Increment

`ElementRotateBuilder.``Increment`

  Returns or sets the increment in label for each new element

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

  Getter Method

  Signature `Increment`

  Returns: |
  Return type: | int

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Increment`

  Parameters: | increment (int) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Label

`ElementRotateBuilder.``Label`

  Returns or sets the start label for the new elements

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

  Getter Method

  Signature `Label`

  Returns: |
  Return type: | int

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Label`

  Parameters: | label (int) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## LabelOption

`ElementRotateBuilder.``LabelOption`

  Returns or sets the option to specify the start label and increment for the new elements OR specify an offset from the existing element labels

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

  Getter Method

  Signature `LabelOption`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelOption`

  Parameters: | labelOption (`NXOpen.CAE.ElementRotateBuilderLabelType`) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MeshCollectorName

`ElementRotateBuilder.``MeshCollectorName`

  Returns or sets the name of the mesh collector which will hold the new elements

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

  Getter Method

  Signature `MeshCollectorName`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MeshCollectorName`

  Parameters: | meshCollectorName (str) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MeshName

`ElementRotateBuilder.``MeshName`

  Returns or sets the name of the mesh that will hold the new elements

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

  Getter Method

  Signature `MeshName`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MeshName`

  Parameters: | meshName (str) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NeutralName

`ElementRotateBuilder.``NeutralName`

  Returns or sets the neutral name of the elements to be created

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

  Getter Method

  Signature `NeutralName`

  Returns: |
  Return type: | str

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NeutralName`

  Parameters: | neutralName (str) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NewMeshOption

`ElementRotateBuilder.``NewMeshOption`

  Returns or sets the option to create a new mesh or add the new elements to an existing mesh

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

  Getter Method

  Signature `NewMeshOption`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NewMeshOption`

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

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NumCopy

`ElementRotateBuilder.``NumCopy`

  Returns or sets the number of copies to be created for each selected element

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

  Getter Method

  Signature `NumCopy`

  Returns: |
  Return type: | int

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumCopy`

  Parameters: | numCopy (int) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Offset

`ElementRotateBuilder.``Offset`

  Returns or sets the offset to be used to generate new element labels

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

  Getter Method

  Signature `Offset`

  Returns: |
  Return type: | int

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Offset`

  Parameters: | offset (int) –

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

# Method Detail

## Validate

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