BeamEADBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BeamEADBuilder Class

class `NXOpen.CAE.``BeamEADBuilder`

  Bases: `NXOpen.Builder`

  This class provides Beam/Bar Associated Data Support

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

  Default values.

  Property | Value
  --- | ---
  EndReleaseAState | Ignore
  EndReleaseBState | Ignore
  OrientationState | Ignore
  PhysicalPropertyTableState | Ignore

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Elements | Returns the select element operator selects elements
EndOffsetA1 | Returns the end A offset component 1 expression of the element
EndOffsetA2 | Returns the end A offset component 2 expression of the element
EndOffsetA3 | Returns the end A offset component 3 expression of the element
EndOffsetAState | Returns or sets the state drives the commit action
EndOffsetB1 | Returns the end B offset component 1 expression of the element
EndOffsetB2 | Returns the end B offset component 2 expression of the element
EndOffsetB3 | Returns the end B offset component 3 expression of the element
EndOffsetBState | Returns or sets the state drives the commit action
EndReleaseA1 | Returns or sets the get end release setting turns on or off the DOF 1 for end A
EndReleaseA2 | Returns or sets the get end release setting turns on or off the DOF 2 for end A
EndReleaseA3 | Returns or sets the get end release setting turns on or off the DOF 3 for end A
EndReleaseA4 | Returns or sets the get end release setting turns on or off the DOF 4 for end A
EndReleaseA5 | Returns or sets the get end release setting turns on or off the DOF 5 for end A
EndReleaseA6 | Returns or sets the get end release setting turns on or off the DOF 6 for end A
EndReleaseAState | Returns or sets the method to get the state of end release A
EndReleaseB1 | Returns or sets the get end release setting turns on or off the DOF 1 for end B
EndReleaseB2 | Returns or sets the get end release setting turns on or off the DOF 2 for end B
EndReleaseB3 | Returns or sets the get end release setting turns on or off the DOF 3 for end B
EndReleaseB4 | Returns or sets the get end release setting turns on or off the DOF 4 for end B
EndReleaseB5 | Returns or sets the get end release setting turns on or off the DOF 5 for end B
EndReleaseB6 | Returns or sets the get end release setting turns on or off the DOF 6 for end B
EndReleaseBState | Returns or sets the method to get the state of end release B
Node | Returns the get node operator selects an orientation node
OriMethod | Returns or sets the method to get the element orientation method
OrientationState | Returns or sets the state drives the commit action
PhysicalPropertyTable | Returns or sets the physical property table of the beam element
PhysicalPropertyTableState | Returns or sets the physical property table state state drives the action upon commit
SelectSectionOri | Returns or sets the get selection ori operator gets section orientaion value
Tag | Returns the Tag for this object.
VectorChoice | Returns or sets the method to get the orientation vector choice

# 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

BeamEADBuilderEndReleaseSetting Enumeration | indicates which end release setting to use
BeamEADBuilderOrientationMethod Enumeration | indicates which orientation method to use
BeamEADBuilderState Enumeration | indicates to ignore, apply or clear the state property upon commit
BeamEADBuilderVectorChoiceType Enumeration | indicates which vector choice to use

# Property Detail

## Elements

`BeamEADBuilder.``Elements`

  Returns the select element operator selects elements

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

  Getter Method

  Signature `Elements`

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

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetA1

`BeamEADBuilder.``EndOffsetA1`

  Returns the end A offset component 1 expression of the element

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

  Getter Method

  Signature `EndOffsetA1`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetA2

`BeamEADBuilder.``EndOffsetA2`

  Returns the end A offset component 2 expression of the element

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

  Getter Method

  Signature `EndOffsetA2`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetA3

`BeamEADBuilder.``EndOffsetA3`

  Returns the end A offset component 3 expression of the element

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

  Getter Method

  Signature `EndOffsetA3`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetAState

`BeamEADBuilder.``EndOffsetAState`

  Returns or sets the state drives the commit action

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

  Getter Method

  Signature `EndOffsetAState`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndOffsetAState`

  Parameters: | endOffsetAState (`NXOpen.CAE.BeamEADBuilderState`) –

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetB1

`BeamEADBuilder.``EndOffsetB1`

  Returns the end B offset component 1 expression of the element

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

  Getter Method

  Signature `EndOffsetB1`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetB2

`BeamEADBuilder.``EndOffsetB2`

  Returns the end B offset component 2 expression of the element

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

  Getter Method

  Signature `EndOffsetB2`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetB3

`BeamEADBuilder.``EndOffsetB3`

  Returns the end B offset component 3 expression of the element

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

  Getter Method

  Signature `EndOffsetB3`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndOffsetBState

`BeamEADBuilder.``EndOffsetBState`

  Returns or sets the state drives the commit action

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

  Getter Method

  Signature `EndOffsetBState`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndOffsetBState`

  Parameters: | endOffsetBState (`NXOpen.CAE.BeamEADBuilderState`) –

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseA1

`BeamEADBuilder.``EndReleaseA1`

  Returns or sets the get end release setting turns on or off the DOF 1 for end A

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

  Getter Method

  Signature `EndReleaseA1`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseA1`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseA2

`BeamEADBuilder.``EndReleaseA2`

  Returns or sets the get end release setting turns on or off the DOF 2 for end A

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

  Getter Method

  Signature `EndReleaseA2`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseA2`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseA3

`BeamEADBuilder.``EndReleaseA3`

  Returns or sets the get end release setting turns on or off the DOF 3 for end A

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

  Getter Method

  Signature `EndReleaseA3`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseA3`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseA4

`BeamEADBuilder.``EndReleaseA4`

  Returns or sets the get end release setting turns on or off the DOF 4 for end A

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

  Getter Method

  Signature `EndReleaseA4`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseA4`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseA5

`BeamEADBuilder.``EndReleaseA5`

  Returns or sets the get end release setting turns on or off the DOF 5 for end A

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

  Getter Method

  Signature `EndReleaseA5`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseA5`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseA6

`BeamEADBuilder.``EndReleaseA6`

  Returns or sets the get end release setting turns on or off the DOF 6 for end A

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

  Getter Method

  Signature `EndReleaseA6`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseA6`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseAState

`BeamEADBuilder.``EndReleaseAState`

  Returns or sets the method to get the state of end release A

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

  Getter Method

  Signature `EndReleaseAState`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseAState`

  Parameters: | endReleaseAState (`NXOpen.CAE.BeamEADBuilderState`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseB1

`BeamEADBuilder.``EndReleaseB1`

  Returns or sets the get end release setting turns on or off the DOF 1 for end B

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

  Getter Method

  Signature `EndReleaseB1`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseB1`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseB2

`BeamEADBuilder.``EndReleaseB2`

  Returns or sets the get end release setting turns on or off the DOF 2 for end B

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

  Getter Method

  Signature `EndReleaseB2`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseB2`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseB3

`BeamEADBuilder.``EndReleaseB3`

  Returns or sets the get end release setting turns on or off the DOF 3 for end B

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

  Getter Method

  Signature `EndReleaseB3`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseB3`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseB4

`BeamEADBuilder.``EndReleaseB4`

  Returns or sets the get end release setting turns on or off the DOF 4 for end B

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

  Getter Method

  Signature `EndReleaseB4`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseB4`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseB5

`BeamEADBuilder.``EndReleaseB5`

  Returns or sets the get end release setting turns on or off the DOF 5 for end B

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

  Getter Method

  Signature `EndReleaseB5`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseB5`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseB6

`BeamEADBuilder.``EndReleaseB6`

  Returns or sets the get end release setting turns on or off the DOF 6 for end B

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

  Getter Method

  Signature `EndReleaseB6`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseB6`

  Parameters: | endReleaseSetting (`NXOpen.CAE.BeamEADBuilderEndReleaseSetting`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## EndReleaseBState

`BeamEADBuilder.``EndReleaseBState`

  Returns or sets the method to get the state of end release B

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

  Getter Method

  Signature `EndReleaseBState`

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

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `EndReleaseBState`

  Parameters: | endReleaseBState (`NXOpen.CAE.BeamEADBuilderState`) –

  New in version NX6.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## Node

`BeamEADBuilder.``Node`

  Returns the get node operator selects an orientation node

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

  Getter Method

  Signature `Node`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## OriMethod

`BeamEADBuilder.``OriMethod`

  Returns or sets the method to get the element orientation method

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

  Getter Method

  Signature `OriMethod`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `OriMethod`

  Parameters: | oriMethod (`NXOpen.CAE.BeamEADBuilderOrientationMethod`) –

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## OrientationState

`BeamEADBuilder.``OrientationState`

  Returns or sets the state drives the commit action

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

  Getter Method

  Signature `OrientationState`

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

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `OrientationState`

  Parameters: | orientationState (`NXOpen.CAE.BeamEADBuilderState`) –

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## PhysicalPropertyTable

`BeamEADBuilder.``PhysicalPropertyTable`

  Returns or sets the physical property table of the beam element

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

  Getter Method

  Signature `PhysicalPropertyTable`

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

  New in version NX11.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `PhysicalPropertyTable`

  Parameters: | physicalPropertyTable (`NXOpen.CAE.PhysicalPropertyTable`) –

  New in version NX11.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## PhysicalPropertyTableState

`BeamEADBuilder.``PhysicalPropertyTableState`

  Returns or sets the physical property table state state drives the action upon commit

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

  Getter Method

  Signature `PhysicalPropertyTableState`

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

  New in version NX11.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `PhysicalPropertyTableState`

  Parameters: | physicalPropertyTableState (`NXOpen.CAE.BeamEADBuilderState`) –

  New in version NX11.0.1.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## SelectSectionOri

`BeamEADBuilder.``SelectSectionOri`

  Returns or sets the get selection ori operator gets section orientaion value

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

  Getter Method

  Signature `SelectSectionOri`

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

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `SelectSectionOri`

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

  New in version NX6.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

## VectorChoice

`BeamEADBuilder.``VectorChoice`

  Returns or sets the method to get the orientation vector choice

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

  Getter Method

  Signature `VectorChoice`

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

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

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

  Setter Method

  Signature `VectorChoice`

  Parameters: | vectorChoice (`NXOpen.CAE.BeamEADBuilderVectorChoiceType`) –

  New in version NX7.5.0.

  License requirements: nx_masterfem (“Finite Element Modeling”)

# Method Detail

## Validate

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