StrainGageBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# StrainGageBuilder Class

class `NXOpen.CAE.ResponseSimulation.``StrainGageBuilder`

  Bases: `NXOpen.CAE.ResponseSimulation.BaseBuilder`

  Represents a StrainGageBuilder

  To create a new instance of this class, use `NXOpen.CAE.ResponseSimulation.StrainGageCollection.CreateStrainGageBuilder()`

  Default values.

  Property | Value
  --- | ---
  GageType | UniAxial
  Placement | Node
  Plane | FacePlane
  ResultType | Strain
  RotationAngle.Value | 0.0 (millimeters part), 0.0 (inches part)
  ShellElementFace | Top

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
Csys | Returns or sets the orientation direction, Only available when the strain gage’s orientation plane type is `CAE.ResponseSimulationStrainGageOrientationPlane.Csys`
GageType | Returns or sets the type of strain gage
ObjectLabel | Returns the object label
Placement | Returns or sets the placement type of strain gage
Plane | Returns or sets the orientation plane type of strain gage
ResultType | Returns or sets the result type of strain gage
RotationAngle | Returns the rotation angle, Only available when the strain gage’s orientation plane type is `CAE.ResponseSimulationStrainGageOrientationPlane.Csys`
SelectedElementFaces | Returns the selected element face.
SelectedNode | Returns the destination nodes, Only available when the strain gage’s placement type is `CAE.ResponseSimulationStrainGagePlacementType.Node`
ShellElementFace | Returns or sets the shell element face location type of strain gage
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.

# Property Detail

## Csys

`StrainGageBuilder.``Csys`

  Returns or sets the orientation direction, Only available when the strain gage’s orientation plane type is `CAE.ResponseSimulationStrainGageOrientationPlane.Csys`

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

  Getter Method

  Signature `Csys`

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

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `Csys`

  Parameters: | orientationCoordSystem (`NXOpen.SmartObject`) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## GageType

`StrainGageBuilder.``GageType`

  Returns or sets the type of strain gage

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

  Getter Method

  Signature `GageType`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.StrainGageType`

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `GageType`

  Parameters: | gageType (`NXOpen.CAE.ResponseSimulation.StrainGageType`) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## Placement

`StrainGageBuilder.``Placement`

  Returns or sets the placement type of strain gage

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

  Getter Method

  Signature `Placement`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.StrainGagePlacementType`

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `Placement`

  Parameters: | gagePlacement (`NXOpen.CAE.ResponseSimulation.StrainGagePlacementType`) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## Plane

`StrainGageBuilder.``Plane`

  Returns or sets the orientation plane type of strain gage

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

  Getter Method

  Signature `Plane`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.StrainGageOrientationPlane`

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `Plane`

  Parameters: | plane (`NXOpen.CAE.ResponseSimulation.StrainGageOrientationPlane`) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## ResultType

`StrainGageBuilder.``ResultType`

  Returns or sets the result type of strain gage

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

  Getter Method

  Signature `ResultType`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.StrainGageResult`

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `ResultType`

  Parameters: | resultType (`NXOpen.CAE.ResponseSimulation.StrainGageResult`) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## RotationAngle

`StrainGageBuilder.``RotationAngle`

  Returns the rotation angle, Only available when the strain gage’s orientation plane type is `CAE.ResponseSimulationStrainGageOrientationPlane.Csys`

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

  Getter Method

  Signature `RotationAngle`

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

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## SelectedElementFaces

`StrainGageBuilder.``SelectedElementFaces`

  Returns the selected element face.

  Only available when the strain gage’s placement type is `CAE.ResponseSimulationStrainGagePlacementType.ElementFaceCenter`

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

  Getter Method

  Signature `SelectedElementFaces`

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

  New in version NX7.5.2.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## SelectedNode

`StrainGageBuilder.``SelectedNode`

  Returns the destination nodes, Only available when the strain gage’s placement type is `CAE.ResponseSimulationStrainGagePlacementType.Node`

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

  Getter Method

  Signature `SelectedNode`

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

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## ShellElementFace

`StrainGageBuilder.``ShellElementFace`

  Returns or sets the shell element face location type of strain gage

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

  Getter Method

  Signature `ShellElementFace`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.StrainGageShellElementFaceType`

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `ShellElementFace`

  Parameters: | shellElementFace (`NXOpen.CAE.ResponseSimulation.StrainGageShellElementFaceType`) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

# Method Detail

## Validate

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