CorrelSolutionBuilder Class¶
-
class
NXOpen.CAE.
CorrelSolutionBuilder
¶ Bases:
NXOpen.CAE.CorrelBaseBuilder
This is a manager to the
CAE.CorrelSolution
class.Object of type
CAE.CorrelSolution
can be created and edited only through this classTo create a new instance of this class, use
NXOpen.CAE.CorrelSolutionCollection.CreateSolutionBuilder()
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
FrfDampingSource | Returns or sets the option controlling which damping to consider when synthesizing FRF data from analysis results |
HighFrequencyCutoff | Returns or sets the high-frequency cutoff for work modes |
HighFrequencyFilteringMode | Returns or sets the high-frequency filtering option for work modes |
LowFrequencyCutoff | Returns or sets the low-frequency cutoff for work modes |
LowFrequencyFilteringMode | Returns or sets the low-frequency filtering option for work modes |
NodeMapSizeLimit | Returns or sets the node map size limit |
NodeMapSizeLimitActive | Returns or sets the high-frequency filtering option for work modes |
NodeMatchingDistance | Returns or sets the node-matching distance |
ReferenceSolution | Returns or sets the reference (test) solution of correlation |
Tag | Returns the Tag for this object. |
Title | Returns or sets the correlation metasolution name |
WorkSolution | Returns or sets the work (analysis) solution of correlation |
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. |
Enumerations¶
CorrelSolutionBuilderEnumDampingFrftype Enumeration | The damping type enum |
Property Detail¶
FrfDampingSource¶
-
CorrelSolutionBuilder.
FrfDampingSource
¶ Returns or sets the option controlling which damping to consider when synthesizing FRF data from analysis results
-------------------------------------
Getter Method
Signature
FrfDampingSource
Returns: Return type: NXOpen.CAE.CorrelSolutionBuilderEnumDampingFrftype
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FrfDampingSource
Parameters: frfDampingSource ( NXOpen.CAE.CorrelSolutionBuilderEnumDampingFrftype
) –New in version NX6.0.0.
License requirements: nx_correl_base (“FE Correlation”)
HighFrequencyCutoff¶
-
CorrelSolutionBuilder.
HighFrequencyCutoff
¶ Returns or sets the high-frequency cutoff for work modes
-------------------------------------
Getter Method
Signature
HighFrequencyCutoff
Returns: Return type: float New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
HighFrequencyCutoff
Parameters: cutoffFrequency (float) – New in version NX6.0.1.
License requirements: nx_correl_base (“FE Correlation”)
HighFrequencyFilteringMode¶
-
CorrelSolutionBuilder.
HighFrequencyFilteringMode
¶ Returns or sets the high-frequency filtering option for work modes
-------------------------------------
Getter Method
Signature
HighFrequencyFilteringMode
Returns: Return type: bool New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
HighFrequencyFilteringMode
Parameters: highFrequencyFilteringMode (bool) – New in version NX6.0.1.
License requirements: nx_correl_base (“FE Correlation”)
LowFrequencyCutoff¶
-
CorrelSolutionBuilder.
LowFrequencyCutoff
¶ Returns or sets the low-frequency cutoff for work modes
-------------------------------------
Getter Method
Signature
LowFrequencyCutoff
Returns: Return type: float New in version NX6.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
LowFrequencyCutoff
Parameters: cutoffFrequency (float) – New in version NX6.0.2.
License requirements: nx_correl_base (“FE Correlation”)
LowFrequencyFilteringMode¶
-
CorrelSolutionBuilder.
LowFrequencyFilteringMode
¶ Returns or sets the low-frequency filtering option for work modes
-------------------------------------
Getter Method
Signature
LowFrequencyFilteringMode
Returns: Return type: bool New in version NX6.0.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
LowFrequencyFilteringMode
Parameters: lowFrequencyFilteringMode (bool) – New in version NX6.0.2.
License requirements: nx_correl_base (“FE Correlation”)
NodeMapSizeLimit¶
-
CorrelSolutionBuilder.
NodeMapSizeLimit
¶ Returns or sets the node map size limit
-------------------------------------
Getter Method
Signature
NodeMapSizeLimit
Returns: Return type: int New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
NodeMapSizeLimit
Parameters: limit (int) – New in version NX7.5.2.
License requirements: nx_correl_base (“FE Correlation”)
NodeMapSizeLimitActive¶
-
CorrelSolutionBuilder.
NodeMapSizeLimitActive
¶ Returns or sets the high-frequency filtering option for work modes
-------------------------------------
Getter Method
Signature
NodeMapSizeLimitActive
Returns: Return type: bool New in version NX7.5.2.
License requirements: None.
-------------------------------------
Setter Method
Signature
NodeMapSizeLimitActive
Parameters: active (bool) – New in version NX7.5.2.
License requirements: nx_correl_base (“FE Correlation”)
NodeMatchingDistance¶
-
CorrelSolutionBuilder.
NodeMatchingDistance
¶ Returns or sets the node-matching distance
-------------------------------------
Getter Method
Signature
NodeMatchingDistance
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NodeMatchingDistance
Parameters: distance (float) – New in version NX6.0.0.
License requirements: nx_correl_base (“FE Correlation”)
ReferenceSolution¶
-
CorrelSolutionBuilder.
ReferenceSolution
¶ Returns or sets the reference (test) solution of correlation
-------------------------------------
Getter Method
Signature
ReferenceSolution
Returns: Return type: NXOpen.CAE.SimSolution
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceSolution
Parameters: referenceSolution ( NXOpen.CAE.SimSolution
) –New in version NX6.0.0.
License requirements: nx_correl_base (“FE Correlation”)
Title¶
-
CorrelSolutionBuilder.
Title
¶ Returns or sets the correlation metasolution name
-------------------------------------
Getter Method
Signature
Title
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Title
Parameters: title (str) – New in version NX6.0.0.
License requirements: nx_correl_base (“FE Correlation”)
WorkSolution¶
-
CorrelSolutionBuilder.
WorkSolution
¶ Returns or sets the work (analysis) solution of correlation
-------------------------------------
Getter Method
Signature
WorkSolution
Returns: Return type: NXOpen.CAE.SimSolution
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WorkSolution
Parameters: workSolution ( NXOpen.CAE.SimSolution
) –New in version NX6.0.0.
License requirements: nx_correl_base (“FE Correlation”)
Method Detail¶
Validate¶
-
CorrelSolutionBuilder.
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.