JACOUSTICS::JMODEL Namespace Reference

Auxiliary namespace to encapsulate different model parameters. More...

Classes
struct	JModel_t
	Auxiliary class to hide access function to fit option. More...
struct	JString
	String parameters. More...
struct	JEmitter
	Emitter parameters. More...

Enumerations
enum	JOption_t { fit_emitters_only_t = 0, fit_emitters_and_strings_1st_order_t = 1, fit_emitters_and_strings_2nd_order_t = 2, fit_emitters_and_strings_2nd_order_and_stretching_t = 3 }
	Fit options. More...

Functions
JOption_t	getOption ()
	Get fit option. More...
void	setOption (const int option)
	Set fit option. More...

Detailed Description

Auxiliary namespace to encapsulate different model parameters.

Enumeration Type Documentation

enum JACOUSTICS::JMODEL::JOption_t

Fit options.

Enumerator
fit_emitters_only_t	fit only times of emission of emitters
fit_emitters_and_strings_1st_order_t	fit times of emission of emitters and tilt angles of strings
fit_emitters_and_strings_2nd_order_t	fit times of emission of emitters and tilt angles of strings with second order correction
fit_emitters_and_strings_2nd_order_and_stretching_t	fit times of emission of emitters and tilt angles of strings with second order correction and stretching of string

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

                   {
      fit_emitters_only_t                                  =  0,     //!< fit only times of emission of emitters
      fit_emitters_and_strings_1st_order_t                 =  1,     //!< fit times of emission of emitters and tilt angles of strings
      fit_emitters_and_strings_2nd_order_t                 =  2,     //!< fit times of emission of emitters and tilt angles of strings with second order correction
      fit_emitters_and_strings_2nd_order_and_stretching_t  =  3      //!< fit times of emission of emitters and tilt angles of strings with second order correction and stretching of string
    };

Function Documentation

JOption_t JACOUSTICS::JMODEL::getOption ( )

inline

Get fit option.

Returns

option

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

    {
      return JModel_t::get_option();
    }

void JACOUSTICS::JMODEL::setOption ( const int  option )

inline

Set fit option.

Parameters

option

option

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

    {
      switch (option) {

      case fit_emitters_only_t:
      case fit_emitters_and_strings_1st_order_t:
      case fit_emitters_and_strings_2nd_order_t:
      case fit_emitters_and_strings_2nd_order_and_stretching_t:
        JModel_t::get_option() = static_cast<JOption_t>(option);
        break;

      default:
        THROW(JValueOutOfRange, "Invalid option " << option);
      }
    }