Jpp test-rotations-old
the software that should make you happy
Loading...
Searching...
No Matches
JACOUSTICS::JTransmission Struct Reference

Acoustic transmission. More...

#include <JTransmission.hh>

Inheritance diagram for JACOUSTICS::JTransmission:
TObject JACOUSTICS::hit_type JACOUSTICS::hit_type

Classes

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

Public Member Functions

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

Protected Attributes

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

Friends

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

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.

◆ 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
runrun number
ididentifier
Qquality
Wnormalisation
toa_stime-of-arrival [s]
toe_stime-of-emission [s]

Definition at line 55 of file JTransmission.hh.

60 :
61 run(run),
62 id (id),
63 q (Q),
64 w (W),
65 toa(toa_s),
66 toe(toe_s)
67 {}

◆ ~JTransmission()

virtual JACOUSTICS::JTransmission::~JTransmission ( )
inlinevirtual

Virtual destructor.

Definition at line 73 of file JTransmission.hh.

74 {}

Member Function Documentation

◆ getRunNumber()

int JACOUSTICS::JTransmission::getRunNumber ( ) const
inline

Get run number.

Returns
run number

Definition at line 82 of file JTransmission.hh.

83 {
84 return run;
85 }

◆ getID()

int JACOUSTICS::JTransmission::getID ( ) const
inline

Get identifier.

Returns
identifier

Definition at line 93 of file JTransmission.hh.

94 {
95 return id;
96 }

◆ getQ()

double JACOUSTICS::JTransmission::getQ ( ) const
inline

Get quality.

Returns
quality

Definition at line 104 of file JTransmission.hh.

105 {
106 return q;
107 }

◆ getW()

double JACOUSTICS::JTransmission::getW ( ) const
inline

Get normalisation.

Returns
normalisation

Definition at line 115 of file JTransmission.hh.

116 {
117 return w;
118 }

◆ getToA()

double JACOUSTICS::JTransmission::getToA ( ) const
inline

Get calibrated time of arrival.

Returns
time [s]

Definition at line 126 of file JTransmission.hh.

127 {
128 return toa;
129 }

◆ getToE()

double JACOUSTICS::JTransmission::getToE ( ) const
inline

Get estimated time of emission.

Returns
time [s]

Definition at line 137 of file JTransmission.hh.

138 {
139 return toe;
140 }

◆ setToE()

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

Set estimated time of emission.

Parameters
toetime [s]

Definition at line 148 of file JTransmission.hh.

149 {
150 this->toe = toe;
151 }

◆ ClassDef()

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

Friends And Related Symbol Documentation

◆ operator>>

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

Read transmission from input.

Parameters
inreader
objecttransmission
Returns
reader

Definition at line 161 of file JTransmission.hh.

162 {
163 in >> object.run;
164 in >> object.id;
165 in >> object.q;
166 in >> object.w;
167 in >> object.toa;
168 in >> object.toe;
169
170 return in;
171 }

◆ operator<<

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

Write transmission to output.

Parameters
outwriter
objecttransmission
Returns
writer

Definition at line 181 of file JTransmission.hh.

182 {
183 out << object.run;
184 out << object.id;
185 out << object.q;
186 out << object.w;
187 out << object.toa;
188 out << object.toe;
189
190 return out;
191 }

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: