ModalResultsEvaluationSettingBuilder Class¶
-
class
NXOpen.CAE.ResponseSimulation.
ModalResultsEvaluationSettingBuilder
¶ Bases:
NXOpen.CAE.ResponseSimulation.FunctionEvaluationSettingBuilder
Represents the abstract builder class of evaluation setting for FRF and transmissibility
This is an abstract class, and cannot be created.
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
DataLocation | Returns the frequency setting |
EvaluationProperty | Returns the frequency setting |
InputDirection | Returns or sets the source direction data component |
InputNode | Returns or sets the source node. |
ObservationNode | Returns or sets the observation nodes. |
OutputRequest | Returns or sets the destination direction data component |
OutputSettings | Returns the output setting. |
ResultType | Returns or sets the result type |
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. |
GetOutputElements | Returns destination nodes. |
GetOutputNodes | Returns destination nodes. |
SetOutputElements | Sets destination nodes |
SetOutputNodes | Sets destination nodes |
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¶
DataLocation¶
-
ModalResultsEvaluationSettingBuilder.
DataLocation
¶ Returns the frequency setting
-------------------------------------
Getter Method
Signature
DataLocation()
Returns: Return type: NXOpen.CAE.ResponseSimulation.DataLocation
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
EvaluationProperty¶
-
ModalResultsEvaluationSettingBuilder.
EvaluationProperty
¶ Returns the frequency setting
-------------------------------------
Getter Method
Signature
EvaluationProperty()
Returns: Return type: NXOpen.CAE.ResponseSimulation.FrequencyDefinition
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
InputDirection¶
-
ModalResultsEvaluationSettingBuilder.
InputDirection
¶ Returns or sets the source direction data component
-------------------------------------
Getter Method
Signature
InputDirection()
Returns: Return type: NXOpen.CAE.ResponseSimulation.DirectionDataComponent
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------
Setter Method
Signature
InputDirection(dataComponent)
Parameters: dataComponent ( NXOpen.CAE.ResponseSimulation.DirectionDataComponent
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
InputNode¶
-
ModalResultsEvaluationSettingBuilder.
InputNode
¶ Returns or sets the source node.
-------------------------------------
Getter Method
Signature
InputNode()
Returns: Return type: NXOpen.CAE.FENode
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------
Setter Method
Signature
InputNode(sourceNode)
Parameters: sourceNode ( NXOpen.CAE.FENode
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
ObservationNode¶
-
ModalResultsEvaluationSettingBuilder.
ObservationNode
¶ Returns or sets the observation nodes.
-------------------------------------
Getter Method
Signature
ObservationNode()
Returns: Return type: NXOpen.CAE.FENode
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------
Setter Method
Signature
ObservationNode(observationNode)
Parameters: observationNode ( NXOpen.CAE.FENode
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
OutputRequest¶
-
ModalResultsEvaluationSettingBuilder.
OutputRequest
¶ Returns or sets the destination direction data component
-------------------------------------
Getter Method
Signature
OutputRequest()
Returns: Return type: NXOpen.CAE.ResponseSimulation.DirectionDataComponent
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
-------------------------------------
Setter Method
Signature
OutputRequest(dataComponent)
Parameters: dataComponent ( NXOpen.CAE.ResponseSimulation.DirectionDataComponent
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Method Detail¶
GetOutputElements¶
-
ModalResultsEvaluationSettingBuilder.
GetOutputElements
¶ Returns destination nodes.
Only available when result type is
CAE.ResponseSimulationEvaluationResultType.Stress
,CAE.ResponseSimulationEvaluationResultType.Strain
,CAE.ResponseSimulationEvaluationResultType.ShellStressResultant
Signature
GetOutputElements()
Returns: Return type: list of NXOpen.CAE.FEElement
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
GetOutputNodes¶
-
ModalResultsEvaluationSettingBuilder.
GetOutputNodes
¶ Returns destination nodes.
Only available when result type is
CAE.ResponseSimulationEvaluationResultType.Displacement
,CAE.ResponseSimulationEvaluationResultType.Velocity
,CAE.ResponseSimulationEvaluationResultType.Acceleration
,CAE.ResponseSimulationEvaluationResultType.ReactionForce
Signature
GetOutputNodes()
Returns: Return type: list of NXOpen.CAE.FENode
New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
SetOutputElements¶
-
ModalResultsEvaluationSettingBuilder.
SetOutputElements
¶ Sets destination nodes
Signature
SetOutputElements(destinationElements)
Parameters: destinationElements (list of NXOpen.CAE.FEElement
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
SetOutputNodes¶
-
ModalResultsEvaluationSettingBuilder.
SetOutputNodes
¶ Sets destination nodes
Signature
SetOutputNodes(destinationNode)
Parameters: destinationNode (list of NXOpen.CAE.FENode
) –New in version NX5.0.0.
License requirements: nx_response_anlys (“NX Response Analysis”)
Validate¶
-
ModalResultsEvaluationSettingBuilder.
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.