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

This is the class handling the dB settings option: a dB reference value and a dB format (10 or 20). More...

Inheritance diagram for NXOpen::CAE::SignalProcessingDBSettings:
NXOpen::TaggedObject

Public Types

enum  DBFormats { DBFormatsDb10, DBFormatsDb20 }
 This enum defines the dB formats. More...
 

Public Member Functions

NXOpen::CAE::SignalProcessingDBSettings::DBFormats DBFormat ()
 Returns the dB format to apply
Created in NX12.0.0. More...
 
double DBReference ()
 Returns the dB reference to apply
Created in NX12.0.0. More...
 
double GetReferenceForTargetUnit (NXOpen::Unit *targetUnit)
 Gets the dB reference value converted to the units of the data. More...
 
void SetDBFormat (NXOpen::CAE::SignalProcessingDBSettings::DBFormats format)
 Sets the dB format to apply
Created in NX12.0.0. More...
 
void SetDBReference (double dBReference)
 Sets the dB reference to apply
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 dB settings option: a dB reference value and a dB format (10 or 20).

This object is initialized with a Part::Unit::Type. Based on the measure type of this unit, a default dB reference value is retrieved from the customer defaults and a dB format is applied.

In addition, for measure types which are defined in the customer defaults, a MKS unit is derived, in which the dB reference is expressed. The GetConvertedReference method returns the dB reference value converted to the unit that was specified when constructing the object.




Created in NX12.0.0.

Member Enumeration Documentation

This enum defines the dB formats.

Enumerator
DBFormatsDb10 

10

DBFormatsDb20 

20

Member Function Documentation

NXOpen::CAE::SignalProcessingDBSettings::DBFormats NXOpen::CAE::SignalProcessingDBSettings::DBFormat ( )

Returns the dB format to apply
Created in NX12.0.0.



License requirements : None

double NXOpen::CAE::SignalProcessingDBSettings::DBReference ( )

Returns the dB reference to apply
Created in NX12.0.0.



License requirements : None

double NXOpen::CAE::SignalProcessingDBSettings::GetReferenceForTargetUnit ( NXOpen::Unit targetUnit)

Gets the dB reference value converted to the units of the data.

Returns

Created in NX12.0.0.

License requirements : None
Parameters
targetUnittargetunit
void NXOpen::CAE::SignalProcessingDBSettings::SetDBFormat ( NXOpen::CAE::SignalProcessingDBSettings::DBFormats  format)

Sets the dB format to apply
Created in NX12.0.0.



License requirements : None

Parameters
formatformat
void NXOpen::CAE::SignalProcessingDBSettings::SetDBReference ( double  dBReference)

Sets the dB reference to apply
Created in NX12.0.0.



License requirements : None

Parameters
dBReferencedbreference

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