LaminateSineEventBuilder Class

class NXOpen.CAE.LaminateSineEventBuilder

Bases: NXOpen.CAE.LaminateDynamicEventBuilder

Represents a NXOpen.CAE.LaminateSineEvent builder

To create a new instance of this class, use NXOpen.CAE.LaminateDynamicEventCollection.CreateSineEventBuilder()

New in version NX10.0.0.

Properties

Property Description
AdditionalFrequenciesBreakPoints Returns or sets the option to consider break points
AdditionalFrequenciesUnits Returns or sets the option to consider break points
DynamicEventName Returns or sets the event name
ExcitationCsys Returns or sets the excitation coordinate system
ExcitationSelectedAxis Returns or sets the excitation axis
IntermediateFrequenciesBetweenOption Returns or sets the intermediate in between frequencies option
IntermediateFrequenciesCluster Returns or sets the intermediate in between frequencies number of excitations
IntermediateFrequenciesEnable Returns or sets the intermediate frequencies control
IntermediateFrequenciesIncludeNatFreq Returns or sets the option to include the natural frequencis in the intermediate frequencies with the linear and logarithmic options
IntermediateFrequenciesNumExcitations Returns or sets the intermediate in between frequencies number of excitations
IntermediateFrequenciesNumIncrements Returns or sets the intermediate frequencies number of increments for linear and logarithmic options
IntermediateFrequenciesOption Returns or sets the intermediate frequencies option
LowerBoundFrequency Returns or sets the lower bound freq
NastranBasicCsys Returns or sets the nastran basic
NaturalFrequenciesChoice Returns or sets the natural frequencies selection option
NaturalFrequenciesEnable Returns or sets the natural frequencies option
ReferenceType Returns or sets the reference type
Tag Returns the Tag for this object.
UpperBoundFrequency Returns or sets the upper bound freq
UserFunction Returns or sets the function.

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.
GetOutputRequestObject Get the output request.
SelectModes Sets the a mode property selection
SetAdditionalFrequencies Sets the additional frequencies values
SetOutputRequestObject Set the output request.
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

AdditionalFrequenciesBreakPoints

LaminateSineEventBuilder.AdditionalFrequenciesBreakPoints

Returns or sets the option to consider break points

-------------------------------------

Getter Method

Signature AdditionalFrequenciesBreakPoints

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AdditionalFrequenciesBreakPoints

Parameters:additionalFrequenciesBreakPoints (bool) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

AdditionalFrequenciesUnits

LaminateSineEventBuilder.AdditionalFrequenciesUnits

Returns or sets the option to consider break points

-------------------------------------

Getter Method

Signature AdditionalFrequenciesUnits

Returns:
Return type:NXOpen.CAE.LaminateSineEventBuilderAdditionalFrequeciesUnitsEnum

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AdditionalFrequenciesUnits

Parameters:additionalFrequenciesUnits (NXOpen.CAE.LaminateSineEventBuilderAdditionalFrequeciesUnitsEnum) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

IntermediateFrequenciesBetweenOption

LaminateSineEventBuilder.IntermediateFrequenciesBetweenOption

Returns or sets the intermediate in between frequencies option

-------------------------------------

Getter Method

Signature IntermediateFrequenciesBetweenOption

Returns:
Return type:NXOpen.CAE.LaminateSineEventBuilderIntermediateFrequeciesBetweenEnum

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateFrequenciesBetweenOption

Parameters:intermediateFrequenciesBetweenOption (NXOpen.CAE.LaminateSineEventBuilderIntermediateFrequeciesBetweenEnum) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

IntermediateFrequenciesCluster

LaminateSineEventBuilder.IntermediateFrequenciesCluster

Returns or sets the intermediate in between frequencies number of excitations

-------------------------------------

Getter Method

Signature IntermediateFrequenciesCluster

Returns:
Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateFrequenciesCluster

Parameters:intermediateFrequenciesCluster (float) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

IntermediateFrequenciesEnable

LaminateSineEventBuilder.IntermediateFrequenciesEnable

Returns or sets the intermediate frequencies control

-------------------------------------

Getter Method

Signature IntermediateFrequenciesEnable

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateFrequenciesEnable

Parameters:intermediateFrequenciesEnable (bool) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

IntermediateFrequenciesIncludeNatFreq

LaminateSineEventBuilder.IntermediateFrequenciesIncludeNatFreq

Returns or sets the option to include the natural frequencis in the intermediate frequencies with the linear and logarithmic options

-------------------------------------

Getter Method

Signature IntermediateFrequenciesIncludeNatFreq

Returns:
Return type:bool

New in version NX10.0.0.

Deprecated since version NX11.0.0: This function has no replacement. The IntermediateFrequenciesIncludeNatFreq property is simply not supported by the Sine Event solver and has never been. This parameter is useless.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateFrequenciesIncludeNatFreq

Parameters:intermediateFrequenciesIncludeNatFreq (bool) –

New in version NX10.0.0.

Deprecated since version NX11.0.0: This function has no replacement. The IntermediateFrequenciesIncludeNatFreq property is simply not supported by the Sine Event solver and has never been. This parameter is useless.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

IntermediateFrequenciesNumExcitations

LaminateSineEventBuilder.IntermediateFrequenciesNumExcitations

Returns or sets the intermediate in between frequencies number of excitations

-------------------------------------

Getter Method

Signature IntermediateFrequenciesNumExcitations

Returns:
Return type:int

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateFrequenciesNumExcitations

Parameters:intermediateFrequenciesNumExcitations (int) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

IntermediateFrequenciesNumIncrements

LaminateSineEventBuilder.IntermediateFrequenciesNumIncrements

Returns or sets the intermediate frequencies number of increments for linear and logarithmic options

-------------------------------------

Getter Method

Signature IntermediateFrequenciesNumIncrements

Returns:
Return type:int

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateFrequenciesNumIncrements

Parameters:intermediateFrequenciesNumIncrements (int) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

IntermediateFrequenciesOption

LaminateSineEventBuilder.IntermediateFrequenciesOption

Returns or sets the intermediate frequencies option

-------------------------------------

Getter Method

Signature IntermediateFrequenciesOption

Returns:
Return type:NXOpen.CAE.LaminateSineEventBuilderIntermediateFrequeciesEnum

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IntermediateFrequenciesOption

Parameters:intermediateFrequenciesOption (NXOpen.CAE.LaminateSineEventBuilderIntermediateFrequeciesEnum) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

NaturalFrequenciesChoice

LaminateSineEventBuilder.NaturalFrequenciesChoice

Returns or sets the natural frequencies selection option

-------------------------------------

Getter Method

Signature NaturalFrequenciesChoice

Returns:
Return type:NXOpen.CAE.LaminateSineEventBuilderNaturalFrequeciesEnum

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature NaturalFrequenciesChoice

Parameters:naturalFrequenciesChoice (NXOpen.CAE.LaminateSineEventBuilderNaturalFrequeciesEnum) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

NaturalFrequenciesEnable

LaminateSineEventBuilder.NaturalFrequenciesEnable

Returns or sets the natural frequencies option

-------------------------------------

Getter Method

Signature NaturalFrequenciesEnable

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature NaturalFrequenciesEnable

Parameters:naturalFrequenciesEnable (bool) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

Method Detail

SelectModes

LaminateSineEventBuilder.SelectModes

Sets the a mode property selection

Signature SelectModes(selectedModes)

Parameters:selectedModes (list of NXOpen.CAE.LaminateModeProperty) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

SetAdditionalFrequencies

LaminateSineEventBuilder.SetAdditionalFrequencies

Sets the additional frequencies values

Signature SetAdditionalFrequencies(additionalFrequencies)

Parameters:additionalFrequencies (list of float) –

New in version NX10.0.0.

License requirements: nx_lam_comp_adv (“Laminate Composites Advanced”)

Validate

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