JOSCPROB::JMixingAngle< T > Struct Template Reference

Implementation of oscillation mixing angle. More...

#include <JMixingAngle.hh>

Inheritance diagram for JOSCPROB::JMixingAngle< T >:

Public Types
typedef JMixingAngle< T >	JMixingAngle_t
typedef JOscParameter< T >	JOscParameter_t
typedef JOscParameter_t::JParameter_t	JParameter_t
typedef JOscParameter_t::argument_type	argument_type

Public Member Functions
	JMixingAngle ()
	Default constructor. More...
	JMixingAngle (argument_type value)
	Constructor. More...
JMixingAngle_t &	operator= (argument_type value)
	Assignment operator. More...
bool	is_valid () const override
	Check validity of oscillation parameter. More...
void	setValue (argument_type value)
	Set parameter. More...
const T &	getValue () const
	Get value of parameter. More...
T &	getValue ()
	Get value of parameter. More...
	operator const T & () const
	Type conversion operator. More...
	operator T & ()
	Type conversion operator. More...
const bool	isDefined () const
	Get status of parameter. More...
bool	less (const JParameter< T > &parameter) const
	Less than method. More...

Static Public Member Functions
static JMixingAngle_t	make_parameter (argument_type value)
	Auxiliary function to create a mixing angle parameter. More...

Protected Attributes
T	__value
bool	is_defined

Detailed Description

template<class T = double>
struct JOSCPROB::JMixingAngle< T >

Implementation of oscillation mixing angle.

Definition at line 27 of file JMixingAngle.hh.

Member Typedef Documentation

template<class T = double>

typedef JMixingAngle<T> JOSCPROB::JMixingAngle< T >::JMixingAngle_t

Definition at line 30 of file JMixingAngle.hh.

template<class T = double>

typedef JOscParameter<T> JOSCPROB::JMixingAngle< T >::JOscParameter_t

Definition at line 31 of file JMixingAngle.hh.

template<class T = double>

typedef JOscParameter_t::JParameter_t JOSCPROB::JMixingAngle< T >::JParameter_t

Definition at line 33 of file JMixingAngle.hh.

template<class T = double>

typedef JOscParameter_t::argument_type JOSCPROB::JMixingAngle< T >::argument_type

Definition at line 34 of file JMixingAngle.hh.

Constructor & Destructor Documentation

template<class T = double>

JOSCPROB::JMixingAngle< T >::JMixingAngle ( )

inline

Default constructor.

Definition at line 40 of file JMixingAngle.hh.

                   :
      JOscParameter_t()
    {}

template<class T = double>

JOSCPROB::JMixingAngle< T >::JMixingAngle ( argument_type  value )

inlineexplicit

Constructor.

Parameters

value

mixing angle value [rad]

Definition at line 50 of file JMixingAngle.hh.

                                               :
      JOscParameter_t(value)
    {
      using namespace JPP;
      
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JMixingAngle::JMixingAngle(): Invalid mixing angle " << value);
      }
    }

Member Function Documentation

template<class T = double>

JMixingAngle_t& JOSCPROB::JMixingAngle< T >::operator= ( argument_type  value )

inline

Assignment operator.

Parameters

value

mixing angle value [rad]

Returns

mixing angle

Definition at line 67 of file JMixingAngle.hh.

    {
      this->setValue(value);

      return *this;
    }

template<class T = double>

bool JOSCPROB::JMixingAngle< T >::is_valid ( ) const

inlineoverridevirtual

Check validity of oscillation parameter.

Returns

true if valid; else false

Implements JOSCPROB::JOscParameter< T >.

Definition at line 80 of file JMixingAngle.hh.

    {
      const T& angle = this->getValue();
      
      return this->isDefined() ? !(angle < 0.0 || angle > M_PI / 2.0) : true;
    }

template<class T = double>

static JMixingAngle_t JOSCPROB::JMixingAngle< T >::make_parameter ( argument_type  value )

inlinestatic

Auxiliary function to create a mixing angle parameter.

Parameters

value

mixing angle value [rad]

Returns

mixing angle parameter

Definition at line 94 of file JMixingAngle.hh.

    {
      return JMixingAngle_t(value);
    }

template<class T = double>

void JOSCPROB::JOscParameter< T >::setValue ( argument_type  value )

inlineinherited

Set parameter.

Parameters

value

oscillation parameter value

Definition at line 73 of file JOscParameter.hh.

    {
      using namespace JPP;

      JParameter_t::setValue(value);

      if (!this->is_valid()) {
        THROW(JValueOutOfRange, "JOscParameter<T>::setValue(): Given oscillation parameter is invalid " << value);
      }
    }

template<class T>

const T& JLANG::JParameter< T >::getValue ( ) const

inlineinherited

Get value of parameter.

Returns

value

Definition at line 81 of file JParameter.hh.

    { 
      return __value; 
    }

template<class T>

T& JLANG::JParameter< T >::getValue ( )

inlineinherited

Get value of parameter.

Returns

value

Definition at line 92 of file JParameter.hh.

    { 
      return __value; 
    }

template<class T>

JLANG::JParameter< T >::operator const T & ( ) const

inlineinherited

Type conversion operator.

Returns

value

Definition at line 115 of file JParameter.hh.

    { 
      return getValue();
    }

template<class T>

JLANG::JParameter< T >::operator T & ( )

inlineinherited

Type conversion operator.

Returns

value

Definition at line 126 of file JParameter.hh.

    {
      return getValue();
    }

template<class T>

const bool JLANG::JParameter< T >::isDefined ( ) const

inlineinherited

Get status of parameter.

Returns

true if value has been defined (by read or assignment); else false

Definition at line 137 of file JParameter.hh.

    {
      return is_defined;
    }

template<class T>

bool JLANG::JParameter< T >::less ( const JParameter< T > &  parameter ) const

inlineinherited

Less than method.

This method evaluates to true if both parameter values are defined and this value is less than the value of the given parameter object.

Parameters

parameter

parameter

Returns

true if both defined and first value less than second value; else false

Definition at line 152 of file JParameter.hh.

    {
      return this->isDefined() && parameter.isDefined() && this->getValue() < parameter.getValue();
    }

Member Data Documentation

template<class T>

T JLANG::JParameter< T >::__value

protectedinherited

Definition at line 193 of file JParameter.hh.

template<class T>

bool JLANG::JParameter< T >::is_defined

protectedinherited

Definition at line 194 of file JParameter.hh.

---

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

• JMixingAngle.hh