JACOUSTICS::JTransmission Struct Reference

Acoustic transmission. More...

#include <JTransmission.hh>

Inheritance diagram for JACOUSTICS::JTransmission:

Classes
struct	compare
	Auxiliary class to compare transmissions. More...
struct	equals
	Auxiliary class to compare transmissions. More...

Public Member Functions
	JTransmission ()
	Default constructor. More...
	JTransmission (const int run, const int id, const double Q, const double W, const double toa_s, const double toe_s)
	Constructor. More...
virtual	~JTransmission ()
	Virtual destructor. More...
int	getRunNumber () const
	Get run number. More...
int	getID () const
	Get identifier. More...
double	getQ () const
	Get quality. More...
double	getW () const
	Get normalisation. More...
double	getToA () const
	Get calibrated time of arrival. More...
double	getToE () const
	Get estimated time of emission. More...
void	setToE (const double toe)
	Set estimated time of emission. More...
	ClassDef (JTransmission, 3)

Protected Attributes
int	run
int	id
double	q
double	w
double	toa
double	toe

Friends
JReader &	operator>> (JReader &in, JTransmission &object)
	Read transmission from input. More...
JWriter &	operator<< (JWriter &out, const JTransmission &object)
	Write transmission to output. More...

Detailed Description

Acoustic transmission.

Definition at line 29 of file JTransmission.hh.

Constructor & Destructor Documentation

JTransmission() [1/2]

JACOUSTICS::JTransmission::JTransmission ( )

inline

Default constructor.

Definition at line 35 of file JTransmission.hh.

                    :
      run(-1),
      id (-1),
      q  (0.0),
      w  (0.0),
      toa(0.0),
      toe(0.0)
    {}

JTransmission() [2/2]

JACOUSTICS::JTransmission::JTransmission ( const int  run, const int  id, const double  Q, const double  W, const double  toa_s, const double  toe_s  )

inline

Constructor.

Parameters

run	run number
id	identifier
Q	quality
W	normalisation
toa_s	time-of-arrival [s]
toe_s	time-of-emission [s]

Definition at line 55 of file JTransmission.hh.

                                      :
      run(run),
      id (id),
      q  (Q),
      w  (W),
      toa(toa_s),
      toe(toe_s)
    {}

~JTransmission()

virtual JACOUSTICS::JTransmission::~JTransmission ( )

inlinevirtual

Virtual destructor.

Definition at line 73 of file JTransmission.hh.

    {}

Member Function Documentation

getRunNumber()

int JACOUSTICS::JTransmission::getRunNumber ( ) const

inline

Get run number.

Returns

run number

Definition at line 82 of file JTransmission.hh.

    {
      return run;
    }

getID()

int JACOUSTICS::JTransmission::getID ( ) const

inline

Get identifier.

Returns

identifier

Definition at line 93 of file JTransmission.hh.

    {
      return id;
    }

getQ()

double JACOUSTICS::JTransmission::getQ ( ) const

inline

Get quality.

Returns

quality

Definition at line 104 of file JTransmission.hh.

    {
      return q;
    }

getW()

double JACOUSTICS::JTransmission::getW ( ) const

inline

Get normalisation.

Returns

normalisation

Definition at line 115 of file JTransmission.hh.

    {
      return w;
    }

getToA()

double JACOUSTICS::JTransmission::getToA ( ) const

inline

Get calibrated time of arrival.

Returns

time [s]

Definition at line 126 of file JTransmission.hh.

    {
      return toa;
    }

getToE()

double JACOUSTICS::JTransmission::getToE ( ) const

inline

Get estimated time of emission.

Returns

time [s]

Definition at line 137 of file JTransmission.hh.

    {
      return toe;
    }

setToE()

void JACOUSTICS::JTransmission::setToE ( const double  toe )

inline

Set estimated time of emission.

Parameters

toe

time [s]

Definition at line 148 of file JTransmission.hh.

    {
      this->toe = toe;
    }

ClassDef()

JACOUSTICS::JTransmission::ClassDef	(	JTransmission	,
		3
	)

Friends And Related Function Documentation

operator>>

JReader& operator>> ( JReader &  in, JTransmission &  object  )

friend

Read transmission from input.

Parameters

in	reader
object	transmission

Returns

reader

Definition at line 161 of file JTransmission.hh.

    {
      in >> object.run;
      in >> object.id;
      in >> object.q;
      in >> object.w;
      in >> object.toa;
      in >> object.toe;
 
      return in;
    }

operator<<

JWriter& operator<< ( JWriter &  out, const JTransmission &  object  )

friend

Write transmission to output.

Parameters

out	writer
object	transmission

Returns

writer

Definition at line 181 of file JTransmission.hh.

    {
      out << object.run;
      out << object.id;
      out << object.q;
      out << object.w;
      out << object.toa;
      out << object.toe;
 
      return out;
    }

Member Data Documentation

run

int JACOUSTICS::JTransmission::run

protected

Definition at line 270 of file JTransmission.hh.

id

int JACOUSTICS::JTransmission::id

protected

Definition at line 271 of file JTransmission.hh.

q

double JACOUSTICS::JTransmission::q

protected

Definition at line 272 of file JTransmission.hh.

w

double JACOUSTICS::JTransmission::w

protected

Definition at line 273 of file JTransmission.hh.

toa

double JACOUSTICS::JTransmission::toa

protected

Definition at line 274 of file JTransmission.hh.

toe

double JACOUSTICS::JTransmission::toe

protected

Definition at line 275 of file JTransmission.hh.

---

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

• JTransmission.hh