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

Represents the frequency setting to perform FRF evaluation. More...

Inheritance diagram for NXOpen::CAE::ResponseSimulation::FrequencyDefinition:
NXOpen::TaggedObject

List of all members.

Public Types

enum  Definition { DefinitionRange, DefinitionModalContribution }
 Specifies the method to define frequency. More...
enum  InterpolationMethod { InterpolationMethodLogLog, InterpolationMethodLogLinear, InterpolationMethodLinearLinear }
 Specifies the method for interpolation. More...

Public Member Functions

int ContributorNumber ()
 Returns the number of contributors.
double EndValue ()
 Returns the end value of frequency range.
NXOpen::CAE::ResponseSimulation::FrequencyDefinition::Definition EvaluationType ()
 Returns the method to define frequency
Created in NX5.0.0.
bool GenerateMaximumContributors ()
 Returns the option for generating maximum contributors or not.
std::vector< double > GetFrequencies ()
 Returns frequency values to perform FRF evaluation.
NXOpen::CAE::ResponseSimulation::FrequencyDefinition::InterpolationMethod InterpolationMethodOption ()
 Returns the interpolation method.
bool NormalizeResults ()
 Returns the option to normalize results.
void SetContributorNumber (int contributorNumber)
 Sets the number of contributors.
void SetEndValue (double endValue)
 Sets the end value of frequency range.
void SetEvaluationType (NXOpen::CAE::ResponseSimulation::FrequencyDefinition::Definition type)
 Sets the method to define frequency
Created in NX5.0.0.
void SetFrequencies (const std::vector< double > &frequencies)
 Sets the frequency values to perform FRF evaluation.
void SetGenerateMaximumContributors (bool generateMaximumContributors)
 Sets the option for generating maximum contributors or not.
void SetInterpolationMethodOption (NXOpen::CAE::ResponseSimulation::FrequencyDefinition::InterpolationMethod interpolationMethod)
 Sets the interpolation method.
void SetNormalizeResults (bool normalizeResults)
 Sets the option to normalize results.
void SetSpectralLine (int spectralLines)
 Sets the additional spectral lines.
void SetStartValue (double startValue)
 Sets the start value of frequency range.
int SpectralLine ()
 Returns the additional spectral lines.
double StartValue ()
 Returns the start value of frequency range.

Detailed Description

Represents the frequency setting to perform FRF evaluation.


Member Enumeration Documentation

Specifies the method to define frequency.

Enumerator:
DefinitionRange 

range

DefinitionModalContribution 

modal contribution

Specifies the method for interpolation.

Enumerator:
InterpolationMethodLogLog 

log log

InterpolationMethodLogLinear 

log linear

InterpolationMethodLinearLinear 

linear linear


Member Function Documentation

Returns the number of contributors.

Only available when maximu contributors will be generated
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns the end value of frequency range.

Only available when the frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns the method to define frequency
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Returns the option for generating maximum contributors or not.

Only available when frequency definition metod is CAE::ResponseSimulation::FrequencyDefinition::DefinitionModalContribution
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns frequency values to perform FRF evaluation.

Only available when the frequency definition method is CAE::ResponseSimulation::FrequencyDefinition::DefinitionModalContribution

Returns:

Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns the interpolation method.

Only available when the frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns the option to normalize results.

Only available when maximu contributors will be generated
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Sets the number of contributors.

Only available when maximu contributors will be generated
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
contributorNumbercontributornumber

Sets the end value of frequency range.

Only available when the frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
endValueend value

Sets the method to define frequency
Created in NX5.0.0.



License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
typetype
void NXOpen::CAE::ResponseSimulation::FrequencyDefinition::SetFrequencies ( const std::vector< double > &  frequencies)

Sets the frequency values to perform FRF evaluation.

Only available when the frequency definition method is CAE::ResponseSimulation::FrequencyDefinition::DefinitionModalContribution
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
frequenciesfrequencies

Sets the option for generating maximum contributors or not.

Only available when frequency definition metod is CAE::ResponseSimulation::FrequencyDefinition::DefinitionModalContribution
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
generateMaximumContributorsgeneratemaximumcontributors

Sets the interpolation method.

Only available when the frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
interpolationMethodinterpolation method

Sets the option to normalize results.

Only available when maximu contributors will be generated
Created in NX6.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
normalizeResultsnormalizeresults

Sets the additional spectral lines.

Only available when frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
spectralLinesspectral lines

Sets the start value of frequency range.

Only available when the frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Parameters:
startValuestart value

Returns the additional spectral lines.

Only available when frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")

Returns the start value of frequency range.

Only available when the frequency is defined by CAE::ResponseSimulation::FrequencyDefinition::DefinitionRange
Created in NX5.0.0.

License requirements : nx_response_anlys ("NX Response Analysis")


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