NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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

Public Types

enum  EnumDampingFrftype { EnumDampingFrftypeFromWorkModel, EnumDampingFrftypeSpecifyDamping }
 The damping type 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::SimSolutionReferenceSolution ()
 Returns the reference (test) solution of correlation
Created in NX6.0.0.
 
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 SetReferenceSolution (NXOpen::CAE::SimSolution *referenceSolution)
 Sets the reference (test) solution of correlation
Created in NX6.0.0.
 
void SetTitle (const NXString &title)
 Sets the correlation metasolution name
Created in NX6.0.0.
 
void SetTitle (const char *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

Member Function Documentation

NXOpen::CAE::CorrelSolutionBuilder::EnumDampingFrftype NXOpen::CAE::CorrelSolutionBuilder::FrfDampingSource ( )

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



License requirements : None

double NXOpen::CAE::CorrelSolutionBuilder::HighFrequencyCutoff ( )

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



License requirements : None

bool NXOpen::CAE::CorrelSolutionBuilder::HighFrequencyFilteringMode ( )

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



License requirements : None

double NXOpen::CAE::CorrelSolutionBuilder::LowFrequencyCutoff ( )

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



License requirements : None

bool NXOpen::CAE::CorrelSolutionBuilder::LowFrequencyFilteringMode ( )

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



License requirements : None

int NXOpen::CAE::CorrelSolutionBuilder::NodeMapSizeLimit ( )

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



License requirements : None

bool NXOpen::CAE::CorrelSolutionBuilder::NodeMapSizeLimitActive ( )

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



License requirements : None

double NXOpen::CAE::CorrelSolutionBuilder::NodeMatchingDistance ( )

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



License requirements : None

NXOpen::CAE::SimSolution* NXOpen::CAE::CorrelSolutionBuilder::ReferenceSolution ( )

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



License requirements : None

void NXOpen::CAE::CorrelSolutionBuilder::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.



License requirements : nx_correl_base ("FE Correlation")

Parameters
frfDampingSourcefrfdampingsource
void NXOpen::CAE::CorrelSolutionBuilder::SetHighFrequencyCutoff ( double  cutoffFrequency)

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
void NXOpen::CAE::CorrelSolutionBuilder::SetLowFrequencyCutoff ( double  cutoffFrequency)

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
void NXOpen::CAE::CorrelSolutionBuilder::SetNodeMapSizeLimit ( int  limit)

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



License requirements : nx_correl_base ("FE Correlation")

Parameters
limitlimit
void NXOpen::CAE::CorrelSolutionBuilder::SetNodeMapSizeLimitActive ( bool  active)

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



License requirements : nx_correl_base ("FE Correlation")

Parameters
activeactive
void NXOpen::CAE::CorrelSolutionBuilder::SetNodeMatchingDistance ( double  distance)

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



License requirements : nx_correl_base ("FE Correlation")

Parameters
distancedistance
void NXOpen::CAE::CorrelSolutionBuilder::SetReferenceSolution ( NXOpen::CAE::SimSolution referenceSolution)

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



License requirements : nx_correl_base ("FE Correlation")

Parameters
referenceSolutionreferencesolution
void NXOpen::CAE::CorrelSolutionBuilder::SetTitle ( const NXString title)

Sets the correlation metasolution name
Created in NX6.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
titletitle
void NXOpen::CAE::CorrelSolutionBuilder::SetTitle ( const char *  title)

Sets the correlation metasolution name
Created in NX6.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters
titletitle
void NXOpen::CAE::CorrelSolutionBuilder::SetWorkSolution ( NXOpen::CAE::SimSolution workSolution)

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



License requirements : nx_correl_base ("FE Correlation")

Parameters
workSolutionworksolution
NXString NXOpen::CAE::CorrelSolutionBuilder::Title ( )

Returns the correlation metasolution name
Created in NX6.0.0.



License requirements : None

NXOpen::CAE::SimSolution* NXOpen::CAE::CorrelSolutionBuilder::WorkSolution ( )

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 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.