Jpp  17.3.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
JACOUSTICS::JMODEL::JEmitter Struct Reference

Emitter parameters. More...

#include <JModel.hh>

Inheritance diagram for JACOUSTICS::JMODEL::JEmitter:
JMATH::JMath< JFirst_t, JSecond_t > JLANG::JEquals< JFirst_t, JSecond_t > JACOUSTICS::JKatoomba< JType >::H_t

Public Member Functions

 JEmitter ()
 Default constructor. More...
 
 JEmitter (const double t1)
 Constructor. More...
 
JEmitternegate ()
 Negate emitter. More...
 
JEmitteradd (const JEmitter &emitter)
 Add emitter. More...
 
JEmittersub (const JEmitter &emitter)
 Subtract emitter. More...
 
JEmittermul (const double factor)
 Scale emitter. More...
 
JEmitterdiv (const double factor)
 Scale emitter. More...
 
bool equals (const JEmitter &emitter, const double precision=std::numeric_limits< double >::min()) const
 Check equality. More...
 
JFirst_t & mul (const JSecond_t &object)
 Multiply with object. More...
 

Static Public Member Functions

static size_t getN (const JMODEL::JOption_t option)
 Get number of fit parameters. More...
 

Public Attributes

double t1
 

Friends

std::ostream & operator<< (std::ostream &out, const JEmitter &emitter)
 Write emitter parameters to output stream. More...
 

Detailed Description

Emitter parameters.

Definition at line 325 of file JAcoustics/JModel.hh.

Constructor & Destructor Documentation

JACOUSTICS::JMODEL::JEmitter::JEmitter ( )
inline

Default constructor.

Definition at line 332 of file JAcoustics/JModel.hh.

332  :
333  t1(0.0)
334  {}
JACOUSTICS::JMODEL::JEmitter::JEmitter ( const double  t1)
inline

Constructor.

Parameters
t1time-of-emission [s]

Definition at line 342 of file JAcoustics/JModel.hh.

342  :
343  t1(t1)
344  {}

Member Function Documentation

static size_t JACOUSTICS::JMODEL::JEmitter::getN ( const JMODEL::JOption_t  option)
inlinestatic

Get number of fit parameters.

Parameters
optionoption
Returns
number of parameters

Definition at line 353 of file JAcoustics/JModel.hh.

354  {
355  switch (option) {
356 
357  case fit_undefined_t:
358  return 0;
359 
360  default:
361  return 1;
362  }
363  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::negate ( )
inline

Negate emitter.

Returns
this emitter

Definition at line 371 of file JAcoustics/JModel.hh.

372  {
373  t1 = -t1;
374 
375  return *this;
376  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::add ( const JEmitter emitter)
inline

Add emitter.

Parameters
emitteremitter
Returns
this emitter

Definition at line 385 of file JAcoustics/JModel.hh.

386  {
387  t1 += emitter.t1;
388 
389  return *this;
390  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::sub ( const JEmitter emitter)
inline

Subtract emitter.

Parameters
emitteremitter
Returns
this emitter

Definition at line 399 of file JAcoustics/JModel.hh.

400  {
401  t1 -= emitter.t1;
402 
403  return *this;
404  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::mul ( const double  factor)
inline

Scale emitter.

Parameters
factormultiplication factor
Returns
this emitter

Definition at line 413 of file JAcoustics/JModel.hh.

414  {
415  t1 *= factor;
416 
417  return *this;
418  }
JEmitter& JACOUSTICS::JMODEL::JEmitter::div ( const double  factor)
inline

Scale emitter.

Parameters
factordivision factor
Returns
this emitter

Definition at line 427 of file JAcoustics/JModel.hh.

428  {
429  t1 /= factor;
430 
431  return *this;
432  }
bool JACOUSTICS::JMODEL::JEmitter::equals ( const JEmitter emitter,
const double  precision = std::numeric_limits<double>::min() 
) const
inline

Check equality.

Parameters
emitteremitter
precisionprecision
Returns
true if emitters are equal; else false

Definition at line 442 of file JAcoustics/JModel.hh.

444  {
445  return (fabs(t1 - emitter.t1) <= precision);
446  }
template<class JFirst_t, class JSecond_t = JNullType>
JFirst_t& JMATH::JMath< JFirst_t, JSecond_t >::mul ( const JSecond_t &  object)
inlineinherited

Multiply with object.

Parameters
objectobject
Returns
result object

Definition at line 354 of file JMath.hh.

355  {
356  return static_cast<JFirst_t&>(*this) = JFirst_t().mul(static_cast<const JFirst_t&>(*this), object);
357  }

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out,
const JEmitter emitter 
)
friend

Write emitter parameters to output stream.

Parameters
outoutput stream
emitteremitter
Returns
output stream

Definition at line 456 of file JAcoustics/JModel.hh.

457  {
458  using namespace std;
459  using namespace JPP;
460 
461  return out << FIXED(20,6) << emitter.t1;
462  }
Auxiliary data structure for floating point format specification.
Definition: JManip.hh:446

Member Data Documentation

double JACOUSTICS::JMODEL::JEmitter::t1

Definition at line 465 of file JAcoustics/JModel.hh.


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