Om  1.0.0
A universal framework for multimedia simulation
Public Types | Public Member Functions | List of all members
om::sound::acoustics::base::SoundMaterialAttributeType Class Reference

A class that specifies the type of an attribute for a sound material. More...

#include <omSoundMaterialAttributeType.h>

Public Types

enum  Enum {
  UNDEFINED = 0, IMPEDANCE = 1, ABSORPTION = 2, SCATTERING = 3,
  TRANSMISSION = 4, ATTENUATION = 5, EMISSION = 6
}
 

Public Member Functions

 SoundMaterialAttributeType ()
 Create a new sound material attribute type with the undefined type. More...
 
 SoundMaterialAttributeType (Enum newType)
 Create a new sound material attribute type with the specified sound material attribute type enum value. More...
 
 operator Enum () const
 Convert this sound material attribute type to an enum value. More...
 
String toString () const
 Return a string representation of the sound material attribute type. More...
 
 operator String () const
 Convert this sound material attribute type into a string representation. More...
 

Detailed Description

A class that specifies the type of an attribute for a sound material.

Member Enumeration Documentation

Enumerator
UNDEFINED 

An unfefined sound material attribute type.

IMPEDANCE 

The frequency-dependent specific acoustic impedance of a material, in units of Pa*s/m.

ABSORPTION 

The frequency-dependent Sabine absorption coefficient between 0 and 1.

SCATTERING 

The frequency-dependent lambertian scattering coefficient between 0 and 1.

TRANSMISSION 

The frequency-dependent transmission coefficient between 0 and 1.

ATTENUATION 

The frequency-dependent air absorption coefficient in pressure dB per meter.

EMISSION 

The frequency-dependent linear emission factor of sound pressure magnitude.

Constructor & Destructor Documentation

om::sound::acoustics::base::SoundMaterialAttributeType::SoundMaterialAttributeType ( )
inline

Create a new sound material attribute type with the undefined type.

om::sound::acoustics::base::SoundMaterialAttributeType::SoundMaterialAttributeType ( Enum  newType)
inline

Create a new sound material attribute type with the specified sound material attribute type enum value.

Member Function Documentation

om::sound::acoustics::base::SoundMaterialAttributeType::operator Enum ( ) const
inline

Convert this sound material attribute type to an enum value.

String om::sound::acoustics::base::SoundMaterialAttributeType::toString ( ) const

Return a string representation of the sound material attribute type.

om::sound::acoustics::base::SoundMaterialAttributeType::operator String ( ) const
inline

Convert this sound material attribute type into a string representation.


The documentation for this class was generated from the following file: