JACOUSTICS::JTransceiver Struct Reference

Acoustic transceiver. More...

#include <JTransceiver.hh>

Inheritance diagram for JACOUSTICS::JTransceiver:

Public Member Functions
	JTransceiver ()
	Default constructor.
	JTransceiver (const JEmitter &emitter, const JReceiver &receiver)
	Constructor.
JTransmission	getTransmission (const JToA &data, const JAbstractSoundVelocity &V) const
	Get transmission.
double	getDistance () const
	Get distance between emitter and receiver.
const JEmitter &	getEmitter () const
	Get emitter.
double	getT0 () const
	Get time offset of clock.
double	getT (const double t_s) const
	Get corrected time.
double	putT (const double t_s) const
	Get uncorrected time.

Public Attributes
JEmitter	emitter
JReceiver	receiver

Protected Attributes
double	t0_s

Detailed Description

Acoustic transceiver.

Definition at line 25 of file JTransceiver.hh.

Constructor & Destructor Documentation

JTransceiver() [1/2]

JACOUSTICS::JTransceiver::JTransceiver ( )

inline

Default constructor.

Definition at line 32 of file JTransceiver.hh.

                   :
      emitter (),
      receiver()
    {}

JTransceiver() [2/2]

JACOUSTICS::JTransceiver::JTransceiver ( const JEmitter & emitter, const JReceiver & receiver )

inline

Constructor.

Parameters

emitter	emitter
receiver	receiver

Definition at line 44 of file JTransceiver.hh.

                                            :
      emitter (emitter),
      receiver(receiver)
    {}

Member Function Documentation

getTransmission()

JTransmission JACOUSTICS::JTransceiver::getTransmission ( const JToA & data, const JAbstractSoundVelocity & V ) const

inline

Get transmission.

Parameters

data	time-of-arrival
V	sound velocity

Returns

transmission

Definition at line 58 of file JTransceiver.hh.

    {
      const double toa = receiver.getT(data.TOA_S());
      const double t1  = V.getTime(this->getDistance(),
                                   this->emitter .getZ(),
                                   this->receiver.getZ());
 
      return JTransmission(data.RUN,
                           this->receiver.getID(),
                           data.QUALITYFACTOR,
                           data.QUALITYNORMALISATION,
                           toa,
                           toa  -  t1);
    }

getDistance()

double JACOUSTICS::JTransceiver::getDistance ( ) const

inline

Get distance between emitter and receiver.

Returns

distance

Definition at line 80 of file JTransceiver.hh.

    {
      return emitter.getDistance(receiver);
    }

getEmitter()

const JEmitter & JACOUSTICS::JEmitter::getEmitter ( ) const

inlineinherited

Get emitter.

Returns

emitter

Definition at line 57 of file JEmitter.hh.

    {
      return static_cast<const JEmitter&>(*this);
    }

getT0()

double JACOUSTICS::JReceiver::getT0 ( ) const

inlineinherited

Get time offset of clock.

Returns

time offset [s]

Definition at line 60 of file JReceiver.hh.

    {
      return t0_s;
    }

getT()

double JACOUSTICS::JReceiver::getT ( const double t_s ) const

inlineinherited

Get corrected time.

Parameters

t_s

time [s]

Returns

time [s]

Definition at line 72 of file JReceiver.hh.

    {
      return t_s + t0_s;
    }

putT()

double JACOUSTICS::JReceiver::putT ( const double t_s ) const

inlineinherited

Get uncorrected time.

Parameters

t_s

time [s]

Returns

time [s]

Definition at line 84 of file JReceiver.hh.

    {
      return t_s - t0_s;
    }

Member Data Documentation

emitter

JEmitter JACOUSTICS::JTransceiver::emitter

Definition at line 85 of file JTransceiver.hh.

receiver

JReceiver JACOUSTICS::JTransceiver::receiver

Definition at line 86 of file JTransceiver.hh.

t0_s

double JACOUSTICS::JReceiver::t0_s

protectedinherited

Definition at line 90 of file JReceiver.hh.

---

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

• JTransceiver.hh