NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::SimLoadRecipeFunctionAttributes Class Reference

This is the class handling the default attributes of a source used by a load recipe. More...

Inheritance diagram for NXOpen::CAE::SimLoadRecipeFunctionAttributes:
NXOpen::TaggedObject

Public Types

enum  AcousticalWeightings {
  AcousticalWeightingsUnknown, AcousticalWeightingsNone, AcousticalWeightingsA, AcousticalWeightingsB,
  AcousticalWeightingsC, AcousticalWeightingsD, AcousticalWeightingsAb, AcousticalWeightingsBc
}
 This enum defines the acoustical weightings. More...
 
enum  CorrectionModes { CorrectionModesUnknown, CorrectionModesEnergy, CorrectionModesAmplitude }
 This enum defines the correction modes. More...
 
enum  ScalingType { ScalingTypeUnknown, ScalingTypePeak, ScalingTypeRms }
 This enum defines the spectrum scaling. More...
 

Public Member Functions

NXOpen::CAE::SimLoadRecipeFunctionAttributes::AcousticalWeightings AcousticalWeighting ()
 Returns the default acoustical weighting of the functions in the file
Created in NX12.0.0. More...
 
double AmplitudeCorrectionFactor ()
 Returns the default amplitude correction factor of the functions in the file
Created in NX12.0.0. More...
 
NXOpen::CAE::SimLoadRecipeFunctionAttributes::CorrectionModes CorrectionMode ()
 Returns the default correction mode of the functions in the file
Created in NX12.0.0. More...
 
double EnergyCorrectionFactor ()
 Returns the default energy correction factor of the functions in the file
Created in NX12.0.0. More...
 
void SetAcousticalWeighting (NXOpen::CAE::SimLoadRecipeFunctionAttributes::AcousticalWeightings weighting)
 Sets the default acoustical weighting of the functions in the file
Created in NX12.0.0. More...
 
void SetAmplitudeCorrectionFactor (double correctionFactor)
 Sets the default amplitude correction factor of the functions in the file
Created in NX12.0.0. More...
 
void SetCorrectionMode (NXOpen::CAE::SimLoadRecipeFunctionAttributes::CorrectionModes correctionMode)
 Sets the default correction mode of the functions in the file
Created in NX12.0.0. More...
 
void SetEnergyCorrectionFactor (double correctionFactor)
 Sets the default energy correction factor of the functions in the file
Created in NX12.0.0. More...
 
void SetSpectrumScaling (NXOpen::CAE::SimLoadRecipeFunctionAttributes::ScalingType spectrumScaling)
 Sets the default spectrum scaling of the functions in the file
Created in NX12.0.0. More...
 
NXOpen::CAE::SimLoadRecipeFunctionAttributes::ScalingType SpectrumScaling ()
 Returns the default spectrum scaling of the functions in the file
Created in NX12.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This is the class handling the default attributes of a source used by a load recipe.

This is used by data sources which cannot derive these attributes from the file itself (like UNV, OP2, ...). They specify the default attributes of all functions in the file. Whenever this object is modified, a call to UPDATE_do_update is needed in order to propagate the changes to the LoadRecipe.


Use CAE.SimLoadRecipeSource.GetFunctionAttributes

Created in NX12.0.0.

Member Enumeration Documentation

This enum defines the acoustical weightings.

Enumerator
AcousticalWeightingsUnknown 

Unkonwn.

AcousticalWeightingsNone 

None.

AcousticalWeightingsA 

A.

AcousticalWeightingsB 

B.

AcousticalWeightingsC 

C.

AcousticalWeightingsD 

D.

AcousticalWeightingsAb 

AB.

AcousticalWeightingsBc 

BC.

This enum defines the correction modes.

Enumerator
CorrectionModesUnknown 

Unkonwn.

CorrectionModesEnergy 

Energy.

CorrectionModesAmplitude 

Amplitude.

This enum defines the spectrum scaling.

Enumerator
ScalingTypeUnknown 

Unkonwn.

ScalingTypePeak 

Peak.

ScalingTypeRms 

RMS.

Member Function Documentation

NXOpen::CAE::SimLoadRecipeFunctionAttributes::AcousticalWeightings NXOpen::CAE::SimLoadRecipeFunctionAttributes::AcousticalWeighting ( )

Returns the default acoustical weighting of the functions in the file
Created in NX12.0.0.



License requirements : None

double NXOpen::CAE::SimLoadRecipeFunctionAttributes::AmplitudeCorrectionFactor ( )

Returns the default amplitude correction factor of the functions in the file
Created in NX12.0.0.



License requirements : None

NXOpen::CAE::SimLoadRecipeFunctionAttributes::CorrectionModes NXOpen::CAE::SimLoadRecipeFunctionAttributes::CorrectionMode ( )

Returns the default correction mode of the functions in the file
Created in NX12.0.0.



License requirements : None

double NXOpen::CAE::SimLoadRecipeFunctionAttributes::EnergyCorrectionFactor ( )

Returns the default energy correction factor of the functions in the file
Created in NX12.0.0.



License requirements : None

void NXOpen::CAE::SimLoadRecipeFunctionAttributes::SetAcousticalWeighting ( NXOpen::CAE::SimLoadRecipeFunctionAttributes::AcousticalWeightings  weighting)

Sets the default acoustical weighting of the functions in the file
Created in NX12.0.0.



License requirements : None

Parameters
weightingweighting
void NXOpen::CAE::SimLoadRecipeFunctionAttributes::SetAmplitudeCorrectionFactor ( double  correctionFactor)

Sets the default amplitude correction factor of the functions in the file
Created in NX12.0.0.



License requirements : None

Parameters
correctionFactorcorrectionfactor
void NXOpen::CAE::SimLoadRecipeFunctionAttributes::SetCorrectionMode ( NXOpen::CAE::SimLoadRecipeFunctionAttributes::CorrectionModes  correctionMode)

Sets the default correction mode of the functions in the file
Created in NX12.0.0.



License requirements : None

Parameters
correctionModecorrectionmode
void NXOpen::CAE::SimLoadRecipeFunctionAttributes::SetEnergyCorrectionFactor ( double  correctionFactor)

Sets the default energy correction factor of the functions in the file
Created in NX12.0.0.



License requirements : None

Parameters
correctionFactorcorrectionfactor
void NXOpen::CAE::SimLoadRecipeFunctionAttributes::SetSpectrumScaling ( NXOpen::CAE::SimLoadRecipeFunctionAttributes::ScalingType  spectrumScaling)

Sets the default spectrum scaling of the functions in the file
Created in NX12.0.0.



License requirements : None

Parameters
spectrumScalingspectrumscaling
NXOpen::CAE::SimLoadRecipeFunctionAttributes::ScalingType NXOpen::CAE::SimLoadRecipeFunctionAttributes::SpectrumScaling ( )

Returns the default spectrum scaling of the functions in the file
Created in NX12.0.0.



License requirements : None


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