Jpp 21.0.0
the software that should make you happy
Loading...
Searching...
No Matches
JACOUSTICS::JEmitterParameters Struct Reference

Emitter parameters. More...

#include <JTriggerParameters.hh>

Public Member Functions

 JEmitterParameters ()
 Default constructor.
 
 JEmitterParameters (const int id, const double Q, const double TMax_s, const int numberOfHits)
 Constructor.
 
virtual ~JEmitterParameters ()
 Virtual destructor.
 
 ClassDef (JEmitterParameters, 1)
 

Public Attributes

int id
 emitter identifier
 
double Q
 minimal quality if larger than one; else minimal normalised quality
 
double TMax_s
 maximal difference between times of emission [s]
 
int numberOfHits
 minimal number of hits to trigger event
 

Friends

std::istream & operator>> (std::istream &in, JEmitterParameters &parameters)
 Read emitter parameters from input stream.
 
std::ostream & operator<< (std::ostream &out, const JEmitterParameters &parameters)
 Write emitter parameters to output stream.
 

Detailed Description

Emitter parameters.

Definition at line 28 of file JAcoustics/JTriggerParameters.hh.

Constructor & Destructor Documentation

◆ JEmitterParameters() [1/2]

JACOUSTICS::JEmitterParameters::JEmitterParameters ( )
inline

Default constructor.

Definition at line 32 of file JAcoustics/JTriggerParameters.hh.

32 :
33 id(-1),
34 Q(0.0),
35 TMax_s(0.0),
37 {}
double Q
minimal quality if larger than one; else minimal normalised quality
double TMax_s
maximal difference between times of emission [s]
int numberOfHits
minimal number of hits to trigger event

◆ JEmitterParameters() [2/2]

JACOUSTICS::JEmitterParameters::JEmitterParameters ( const int id,
const double Q,
const double TMax_s,
const int numberOfHits )
inline

Constructor.

Parameters
idemitter identifier
Qminimal quality factor
TMax_smaximal difference between times of emission [s]
numberOfHitsminimum number of hits

Definition at line 48 of file JAcoustics/JTriggerParameters.hh.

51 :
52 id(id),
53 Q(Q),
56 {}

◆ ~JEmitterParameters()

virtual JACOUSTICS::JEmitterParameters::~JEmitterParameters ( )
inlinevirtual

Virtual destructor.

Definition at line 62 of file JAcoustics/JTriggerParameters.hh.

63 {}

Member Function Documentation

◆ ClassDef()

JACOUSTICS::JEmitterParameters::ClassDef ( JEmitterParameters ,
1  )

Friends And Related Symbol Documentation

◆ operator>>

std::istream & operator>> ( std::istream & in,
JEmitterParameters & parameters )
friend

Read emitter parameters from input stream.

Parameters
ininput stream
parametersparameters
Returns
input stream

Definition at line 73 of file JAcoustics/JTriggerParameters.hh.

74 {
75 return in >> parameters.id >> parameters.Q >> parameters.TMax_s >> parameters.numberOfHits;
76 }

◆ operator<<

std::ostream & operator<< ( std::ostream & out,
const JEmitterParameters & parameters )
friend

Write emitter parameters to output stream.

Parameters
outoutput stream
parametersparameters
Returns
output stream

Definition at line 86 of file JAcoustics/JTriggerParameters.hh.

87 {
88 return out << parameters.id << ' ' << parameters.Q << ' ' << parameters.TMax_s << ' ' << parameters.numberOfHits;
89 }

Member Data Documentation

◆ id

int JACOUSTICS::JEmitterParameters::id

emitter identifier

Definition at line 92 of file JAcoustics/JTriggerParameters.hh.

◆ Q

double JACOUSTICS::JEmitterParameters::Q

minimal quality if larger than one; else minimal normalised quality

Definition at line 93 of file JAcoustics/JTriggerParameters.hh.

◆ TMax_s

double JACOUSTICS::JEmitterParameters::TMax_s

maximal difference between times of emission [s]

Definition at line 94 of file JAcoustics/JTriggerParameters.hh.

◆ numberOfHits

int JACOUSTICS::JEmitterParameters::numberOfHits

minimal number of hits to trigger event

Definition at line 95 of file JAcoustics/JTriggerParameters.hh.


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