FrfSetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# FrfSetBuilder Class

class `NXOpen.CAE.``FrfSetBuilder`

  Bases: `NXOpen.CAE.AlternateFemRepresentationSourceBuilder`

  Represents a `NXOpen.CAE.FrfSetBuilder` which can be used to create FrfSets.

  Not support KF.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitAlternateFemRepresentationSource | Commits the changes that have been applied to the builder and returns the edited or newly created `NXOpen.CAE.AlternateFemRepresentationSource`
DeselectFrfsubsets | Deselect the frf subset that should not be used.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAvailableFrfsubsets | Get the frf subsets available in the source file of the `NXOpen.CAE.FrfSet`
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.
SetFilePath | Sets the file path
SetLengthUnit | Sets the length unit
SetMassUnit | Sets the mass unit
SetMeshCreationMode | Sets the mesh creation mode
SetName | Sets the name of the FemDataSet
SetResultReference | Sets the result reference
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.

# Method Detail

## DeselectFrfsubsets

`FrfSetBuilder.``DeselectFrfsubsets`

  Deselect the frf subset that should not be used.

  The name should be one retrieved from `CAE.FrfSetBuilder.GetAvailableFrfsubsets()`. Should be called if `CAE.FrfSetBuilder.GetAvailableFrfsubsets()` returns several frf subsets. If this method is not called, all frf subsets are supposed to be selected.

  Signature `DeselectFrfsubsets(frfSubSetNames)`

  Parameters: | frfSubSetNames (list of str) – The frf subsets.

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## GetAvailableFrfsubsets

`FrfSetBuilder.``GetAvailableFrfsubsets`

  Get the frf subsets available in the source file of the `NXOpen.CAE.FrfSet`

  Signature `GetAvailableFrfsubsets()`

  Returns: | The available frf subset names.
  Return type: | list of str

  New in version NX12.0.0.

  License requirements: nx_masterfem (“Finite Element Modeling”) OR nx_design_sim (“NX Design Simulation”)

## Validate

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