ElementTranslateBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ElementTranslateBuilder Class

class `NXOpen.CAE.``ElementTranslateBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.CAE.ElementTranslateBuilder`

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

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
CopyOption | Returns or sets the copy option .
Csys | Returns or sets the coordinate system to be used for translating the selected elements
Distance | Returns the total distance for translation along a vector
DistanceOption | Returns or sets the distance option
ElementDimension | Returns or sets the dimension of the elements to be translated
ElementSelection | Returns the selected elements
ElementType | Returns the element type builder.
ExportMesh | Returns or sets the option which indicates whether mesh is exported to solver or not.
FlipState | Returns or sets the flip state from the 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
Method | Returns or sets the method to be used for translating the selected 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
PAngle | Returns the phi angle for translation in a spherical coordinate system
RDistance | Returns the radial component of distance for translation in a cylindrical/spherical coordinate system
SourcePoint | Returns or sets the source point .
TAngle | Returns the theta angle for translation in a cylindrical/spherical coordinate system
Tag | Returns the Tag for this object.
TargetPoint | Returns or sets the target point .
Vector | Returns or sets the vector along which the selected elements should be translated
XDistance | Returns the x component of distance for translation in a cartesian coordinate system
YDistance | Returns the y component of distance for translation in a cartesian coordinate system
ZDistance | Returns the z component of distance for translation in a cartesian/cylindrical coordinate system

# 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

ElementTranslateBuilderCopyType Enumeration | the copy types
ElementTranslateBuilderDistanceType Enumeration | Distance - specify whether the translation distance is per copy or total
ElementTranslateBuilderElemDimensionType Enumeration | Dimension of the elements to be created
ElementTranslateBuilderLabelType Enumeration | Option to use label/increment or offset
ElementTranslateBuilderMethodType Enumeration | Translation method
ElementTranslateBuilderNewMeshType Enumeration | Option to create a new mesh or add the new elements to an existing mesh

# Property Detail

## CopyOption

`ElementTranslateBuilder.``CopyOption`

  Returns or sets the copy option .

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

  Getter Method

  Signature `CopyOption`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CopyOption`

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

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Csys

`ElementTranslateBuilder.``Csys`

  Returns or sets the coordinate system to be used for translating the selected elements

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

  Getter Method

  Signature `Csys`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Csys`

  Parameters: | csys (`NXOpen.CoordinateSystem`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Distance

`ElementTranslateBuilder.``Distance`

  Returns the total distance for translation along a vector

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

  Getter Method

  Signature `Distance`

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

  New in version NX5.0.0.

  License requirements: None.

## DistanceOption

`ElementTranslateBuilder.``DistanceOption`

  Returns or sets the distance option

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

  Getter Method

  Signature `DistanceOption`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceOption`

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

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementDimension

`ElementTranslateBuilder.``ElementDimension`

  Returns or sets the dimension of the elements to be translated

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

  Getter Method

  Signature `ElementDimension`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ElementDimension`

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

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## ElementSelection

`ElementTranslateBuilder.``ElementSelection`

  Returns the selected elements

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

  Getter Method

  Signature `ElementSelection`

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

  New in version NX5.0.0.

  License requirements: None.

## ElementType

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

## ExportMesh

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

## FlipState

`ElementTranslateBuilder.``FlipState`

  Returns or sets the flip state from the builder

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

  Getter Method

  Signature `FlipState`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `FlipState`

  Parameters: | flipstate (int) –

  New in version NX8.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Increment

`ElementTranslateBuilder.``Increment`

  Returns or sets the increment in label for each new element

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

  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

`ElementTranslateBuilder.``Label`

  Returns or sets the start label for the new elements

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

  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”)

## LabelOption

`ElementTranslateBuilder.``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.ElementTranslateBuilderLabelType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LabelOption`

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

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MeshCollectorName

`ElementTranslateBuilder.``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 NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MeshCollectorName`

  Parameters: | meshCollectorName (str) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## MeshName

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

## Method

`ElementTranslateBuilder.``Method`

  Returns or sets the method to be used for translating the selected elements

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

  Getter Method

  Signature `Method`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Method`

  Parameters: | method (`NXOpen.CAE.ElementTranslateBuilderMethodType`) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NeutralName

`ElementTranslateBuilder.``NeutralName`

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

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

  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

`ElementTranslateBuilder.``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.ElementTranslateBuilderNewMeshType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NewMeshOption`

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

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## NumCopy

`ElementTranslateBuilder.``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 NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `NumCopy`

  Parameters: | numCopy (int) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Offset

`ElementTranslateBuilder.``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 NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Offset`

  Parameters: | offset (int) –

  New in version NX5.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## PAngle

`ElementTranslateBuilder.``PAngle`

  Returns the phi angle for translation in a spherical coordinate system

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

  Getter Method

  Signature `PAngle`

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

  New in version NX5.0.0.

  License requirements: None.

## RDistance

`ElementTranslateBuilder.``RDistance`

  Returns the radial component of distance for translation in a cylindrical/spherical coordinate system

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

  Getter Method

  Signature `RDistance`

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

  New in version NX5.0.0.

  License requirements: None.

## SourcePoint

`ElementTranslateBuilder.``SourcePoint`

  Returns or sets the source point .

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

  Getter Method

  Signature `SourcePoint`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SourcePoint`

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

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## TAngle

`ElementTranslateBuilder.``TAngle`

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

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

  Getter Method

  Signature `TAngle`

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

  New in version NX5.0.0.

  License requirements: None.

## TargetPoint

`ElementTranslateBuilder.``TargetPoint`

  Returns or sets the target point .

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

  Getter Method

  Signature `TargetPoint`

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

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TargetPoint`

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

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Vector

`ElementTranslateBuilder.``Vector`

  Returns or sets the vector along which the selected elements should be translated

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

  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”)

## XDistance

`ElementTranslateBuilder.``XDistance`

  Returns the x component of distance for translation in a cartesian coordinate system

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

  Getter Method

  Signature `XDistance`

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

  New in version NX5.0.0.

  License requirements: None.

## YDistance

`ElementTranslateBuilder.``YDistance`

  Returns the y component of distance for translation in a cartesian coordinate system

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

  Getter Method

  Signature `YDistance`

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

  New in version NX5.0.0.

  License requirements: None.

## ZDistance

`ElementTranslateBuilder.``ZDistance`

  Returns the z component of distance for translation in a cartesian/cylindrical coordinate system

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

  Getter Method

  Signature `ZDistance`

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

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## Validate

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