ModeSetBuilder Class

class NXOpen.CAE.ModeSetBuilder

Bases: NXOpen.CAE.AlternateFemRepresentationSourceBuilder

Represents a NXOpen.CAE.ModeSetBuilder which can be used to create ModeSets.

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
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetAvailableModesets	Get the mode sets available in the source file of the NXOpen.CAE.ModeSet
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.
SelectModeset	Select the mode set that should be used.
SetFilePath	Sets the file path
SetLengthUnit	Sets the length unit
SetMassUnit	Sets the mass unit
SetMeshCreationMode	Sets the mesh creation mode
SetModesCanBeRenumbered	Allow the modes to be renumbered in case there are modes with the same index in the modeset
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

GetAvailableModesets

ModeSetBuilder.GetAvailableModesets

Get the mode sets available in the source file of the NXOpen.CAE.ModeSet

Signature GetAvailableModesets()

Returns:The available mode set 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”)

SelectModeset

ModeSetBuilder.SelectModeset

Select the mode set that should be used.

The name should be one retrieved from CAE.ModeSetBuilder.GetAvailableModesets(). Should be called if CAE.ModeSetBuilder.GetAvailableModesets() returns several mode sets. This method is mandatory. If this method is not called, the mode set name corresponding to the empty string will be selected

Signature SelectModeset(modeSetName)

Parameters:modeSetName (str) – The mode set name.

New in version NX12.0.0.

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

SetModesCanBeRenumbered

ModeSetBuilder.SetModesCanBeRenumbered

Allow the modes to be renumbered in case there are modes with the same index in the modeset

Signature SetModesCanBeRenumbered(allowRenumbering)

Parameters:allowRenumbering (bool) – Allow renumbering flag.

New in version NX12.0.0.

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

Validate

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