JACOUSTICS::JWaveform Struct Reference

Utility class for emitter power and frequency. More...

#include <JAcousticsSupportkit.hh>

Public Member Functions
	JWaveform ()
	Default constructor. More...
	JWaveform (const double Q0, const double f_kHz)
	Constructor. More...
double	getQ (const double D_m, const double d_m) const
	Get quality at given distance. More...

Static Public Member Functions
static double	getDmin ()
	Get minimal distance. More...

Public Attributes
double	Q0
double	f_kHz

Friends
std::istream &	operator>> (std::istream &in, JWaveform &waveform)
	Read waveform from input stream. More...
std::ostream &	operator<< (std::ostream &out, const JWaveform &waveform)
	Write waveform to output stream. More...

Detailed Description

Utility class for emitter power and frequency.

Definition at line 103 of file JAcousticsSupportkit.hh.

Constructor & Destructor Documentation

JWaveform() [1/2]

JACOUSTICS::JWaveform::JWaveform ( )

inline

Default constructor.

Definition at line 107 of file JAcousticsSupportkit.hh.

                :
      Q0   (0.0),
      f_kHz(0.0)
    {}

JWaveform() [2/2]

JACOUSTICS::JWaveform::JWaveform ( const double  Q0, const double  f_kHz  )

inline

Constructor.

Note that the power corresponds to the minimal distance (see method JWaveform::getDmin()).

Parameters

Q0	power [quality]
f_kHz	frequency [kHz]

Definition at line 121 of file JAcousticsSupportkit.hh.

                                  :
      Q0   (Q0),
      f_kHz(f_kHz)
    {}

Member Function Documentation

getDmin()

static double JACOUSTICS::JWaveform::getDmin ( )

inlinestatic

Get minimal distance.

Returns

distance [m]

Definition at line 133 of file JAcousticsSupportkit.hh.

    {
      return 1.0;
    }

getQ()

double JACOUSTICS::JWaveform::getQ ( const double  D_m, const double  d_m  ) const

inline

Get quality at given distance.

Parameters

D_m	depth [m]
d_m	distance [m]

Returns

quality

Definition at line 146 of file JAcousticsSupportkit.hh.

    {
      if (d_m > getDmin())
        return Q0 * JPP::getQ(D_m, this->f_kHz, d_m) / JPP::getQ(D_m, this->f_kHz, getDmin());
      else
        return Q0;
    }

Friends And Related Function Documentation

operator>>

std::istream& operator>> ( std::istream &  in, JWaveform &  waveform  )

friend

Read waveform from input stream.

Parameters

in	input stream
waveform	waveform

Returns

input stream

Definition at line 163 of file JAcousticsSupportkit.hh.

    {
      return in >> waveform.Q0 >> waveform.f_kHz;
    }

operator<<

std::ostream& operator<< ( std::ostream &  out, const JWaveform &  waveform  )

friend

Write waveform to output stream.

Parameters

out	output stream
waveform	waveform

Returns

output stream

Definition at line 176 of file JAcousticsSupportkit.hh.

    {
      return out << waveform.Q0 << ' ' << waveform.f_kHz;
    }

Member Data Documentation

Q0

double JACOUSTICS::JWaveform::Q0

Definition at line 181 of file JAcousticsSupportkit.hh.

f_kHz

double JACOUSTICS::JWaveform::f_kHz

Definition at line 182 of file JAcousticsSupportkit.hh.

---

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

• JAcousticsSupportkit.hh