NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::CAE::CorrelSolutionBuilder Class Reference

This is a manager to the CAE::CorrelSolution class. More...

Inheritance diagram for NXOpen::CAE::CorrelSolutionBuilder:
NXOpen::CAE::CorrelBaseBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::CAE::ModelUpdateSolutionBuilder

List of all members.

Public Types

enum  EnumDampingFrftype { EnumDampingFrftypeFromWorkModel, EnumDampingFrftypeSpecifyDamping }
 The damping type enum. More...
enum  EnumMatchingOptionType { EnumMatchingOptionTypeStrictNodeToNode }
 The pair matching option enum
More...

Public Member Functions

NXOpen::CAE::CorrelSolutionBuilder::EnumDampingFrftype FrfDampingSource ()
 Returns the option controlling which damping to consider when synthesizing FRF data from analysis results
Created in NX6.0.0.
double HighFrequencyCutoff ()
 Returns the high-frequency cutoff for work modes
Created in NX6.0.1.
bool HighFrequencyFilteringMode ()
 Returns the high-frequency filtering option for work modes
Created in NX6.0.1.
double LowFrequencyCutoff ()
 Returns the low-frequency cutoff for work modes
Created in NX6.0.2.
bool LowFrequencyFilteringMode ()
 Returns the low-frequency filtering option for work modes
Created in NX6.0.2.
int NodeMapSizeLimit ()
 Returns the node map size limit
Created in NX7.5.2.
bool NodeMapSizeLimitActive ()
 Returns the high-frequency filtering option for work modes
Created in NX7.5.2.
double NodeMatchingDistance ()
 Returns the node-matching distance
Created in NX6.0.0.
NXOpen::CAE::CorrelSolutionBuilder::EnumMatchingOptionType NodeMatchingOption ()
 Returns the option determining how node-matching occurs

NXOpen::CAE::SimSolutionReferenceSolution ()
 Returns the reference (test) solution of correlation
Created in NX6.0.0.
double RigidBodyCutoffFrequency ()
 Returns the rigid-body cutoff frequency for work modes - deprecated, use low-frequency cutoff instead

bool RigidBodyFilteringMode ()
 Returns the rigid-body filtering option for work modes - deprecated, use low-frequency filtering option instead

void SetFrfDampingSource (NXOpen::CAE::CorrelSolutionBuilder::EnumDampingFrftype frfDampingSource)
 Sets the option controlling which damping to consider when synthesizing FRF data from analysis results
Created in NX6.0.0.
void SetHighFrequencyCutoff (double cutoffFrequency)
 Sets the high-frequency cutoff for work modes
Created in NX6.0.1.
void SetHighFrequencyFilteringMode (bool highFrequencyFilteringMode)
 Sets the high-frequency filtering option for work modes
Created in NX6.0.1.
void SetLowFrequencyCutoff (double cutoffFrequency)
 Sets the low-frequency cutoff for work modes
Created in NX6.0.2.
void SetLowFrequencyFilteringMode (bool lowFrequencyFilteringMode)
 Sets the low-frequency filtering option for work modes
Created in NX6.0.2.
void SetNodeMapSizeLimit (int limit)
 Sets the node map size limit
Created in NX7.5.2.
void SetNodeMapSizeLimitActive (bool active)
 Sets the high-frequency filtering option for work modes
Created in NX7.5.2.
void SetNodeMatchingDistance (double distance)
 Sets the node-matching distance
Created in NX6.0.0.
void SetNodeMatchingOption (NXOpen::CAE::CorrelSolutionBuilder::EnumMatchingOptionType nodeMatchingOption)
 Sets the option determining how node-matching occurs

void SetReferenceSolution (NXOpen::CAE::SimSolution *referenceSolution)
 Sets the reference (test) solution of correlation
Created in NX6.0.0.
void SetRigidBodyCutoffFrequency (double cutoffFrequency)
 Sets the rigid-body cutoff frequency for work modes - deprecated, use low-frequency cutoff instead

void SetRigidBodyFilteringMode (bool rigidFilteringMode)
 Sets the rigid-body filtering option for work modes - deprecated, use low-frequency filtering option instead

void SetTitle (const NXString &title)
 Sets the correlation metasolution name
Created in NX6.0.0.
void SetWorkSolution (NXOpen::CAE::SimSolution *workSolution)
 Sets the work (analysis) solution of correlation
Created in NX6.0.0.
NXString Title ()
 Returns the correlation metasolution name
Created in NX6.0.0.
NXOpen::CAE::SimSolutionWorkSolution ()
 Returns the work (analysis) solution of correlation
Created in NX6.0.0.

Detailed Description

This is a manager to the CAE::CorrelSolution class.

Object of type CAE::CorrelSolution can be created and edited only through this class
To create a new instance of this class, use CAE::CorrelSolutionCollection::CreateSolutionBuilder

Created in NX6.0.0.


Member Enumeration Documentation

The damping type enum.

Enumerator:
EnumDampingFrftypeFromWorkModel 

from work model

EnumDampingFrftypeSpecifyDamping 

from user input

The pair matching option enum

Deprecated:
Deprecated in NX7.5.2.


Enumerator:
EnumMatchingOptionTypeStrictNodeToNode 

node to node matching


Member Function Documentation

Returns the option controlling which damping to consider when synthesizing FRF data from analysis results
Created in NX6.0.0.



License requirements : None

Returns the high-frequency cutoff for work modes
Created in NX6.0.1.



License requirements : None

Returns the high-frequency filtering option for work modes
Created in NX6.0.1.



License requirements : None

Returns the low-frequency cutoff for work modes
Created in NX6.0.2.



License requirements : None

Returns the low-frequency filtering option for work modes
Created in NX6.0.2.



License requirements : None

Returns the node map size limit
Created in NX7.5.2.



License requirements : None

Returns the high-frequency filtering option for work modes
Created in NX7.5.2.



License requirements : None

Returns the node-matching distance
Created in NX6.0.0.



License requirements : None

Returns the option determining how node-matching occurs

Deprecated:
Deprecated in NX7.5.2.



Created in NX6.0.0.

License requirements : None

Returns the reference (test) solution of correlation
Created in NX6.0.0.



License requirements : None

Returns the rigid-body cutoff frequency for work modes - deprecated, use low-frequency cutoff instead

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : None

Returns the rigid-body filtering option for work modes - deprecated, use low-frequency filtering option instead

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : None

Sets the option controlling which damping to consider when synthesizing FRF data from analysis results
Created in NX6.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
frfDampingSourcefrfdampingsource

Sets the high-frequency cutoff for work modes
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
cutoffFrequencycutofffrequency
void NXOpen::CAE::CorrelSolutionBuilder::SetHighFrequencyFilteringMode ( bool  highFrequencyFilteringMode)

Sets the high-frequency filtering option for work modes
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
highFrequencyFilteringModehighfrequencyfilteringmode

Sets the low-frequency cutoff for work modes
Created in NX6.0.2.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
cutoffFrequencycutofffrequency
void NXOpen::CAE::CorrelSolutionBuilder::SetLowFrequencyFilteringMode ( bool  lowFrequencyFilteringMode)

Sets the low-frequency filtering option for work modes
Created in NX6.0.2.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
lowFrequencyFilteringModelowfrequencyfilteringmode

Sets the node map size limit
Created in NX7.5.2.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
limitlimit

Sets the high-frequency filtering option for work modes
Created in NX7.5.2.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
activeactive

Sets the node-matching distance
Created in NX6.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
distancedistance

Sets the option determining how node-matching occurs

Deprecated:
Deprecated in NX7.5.2.



Created in NX6.0.0.

License requirements : nx_correl_base ("FE Correlation")

Parameters:
nodeMatchingOptionnodematchingoption

Sets the reference (test) solution of correlation
Created in NX6.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
referenceSolutionreferencesolution

Sets the rigid-body cutoff frequency for work modes - deprecated, use low-frequency cutoff instead

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters:
cutoffFrequencycutofffrequency

Sets the rigid-body filtering option for work modes - deprecated, use low-frequency filtering option instead

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Parameters:
rigidFilteringModerigidfilteringmode

Sets the correlation metasolution name
Created in NX6.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
titletitle

Sets the work (analysis) solution of correlation
Created in NX6.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
workSolutionworksolution

Returns the correlation metasolution name
Created in NX6.0.0.



License requirements : None

Returns the work (analysis) solution of correlation
Created in NX6.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.