JOSCPROB::JComplexPhase< T > Struct Template Reference

Implementation of oscillation complex phase. More...

#include <JComplexPhase.hh>

Inheritance diagram for JOSCPROB::JComplexPhase< T >:

Public Types
typedef JComplexPhase< T >	JComplexPhase_t
typedef JOscParameter< T >	JOscParameter_t
typedef JOscParameter_t::JParameter_t	JParameter_t
typedef JOscParameter_t::argument_type	argument_type
typedef JOscParameter_t::value_type	value_type

Public Member Functions
	JComplexPhase ()
	Default constructor. More...
	JComplexPhase (argument_type value)
	Constructor. More...
JComplexPhase_t &	operator= (const value_type &value)
	Assignment operator. More...
bool	is_valid () const override final
	Check validity of oscillation parameter. More...
void	setValue (const value_type &value)
	Set parameter. More...
const value_type	getValue () const
	Get value of parameter. More...
	operator const value_type () const
	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 JComplexPhase_t	make_parameter (argument_type value)
	Auxiliary function to create a complex phase parameter grid. More...

Protected Attributes
T	__value
bool	is_defined

Detailed Description

template<class T>
struct JOSCPROB::JComplexPhase< T >

Implementation of oscillation complex phase.

Definition at line 27 of file JComplexPhase.hh.

Member Typedef Documentation

JComplexPhase_t

template<class T >

typedef JComplexPhase<T> JOSCPROB::JComplexPhase< T >::JComplexPhase_t

Definition at line 30 of file JComplexPhase.hh.

JOscParameter_t

template<class T >

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

Definition at line 31 of file JComplexPhase.hh.

JParameter_t

template<class T >

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

Definition at line 33 of file JComplexPhase.hh.

argument_type

template<class T >

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

Definition at line 34 of file JComplexPhase.hh.

value_type

template<class T >

typedef JOscParameter_t::value_type JOSCPROB::JComplexPhase< T >::value_type

Definition at line 35 of file JComplexPhase.hh.

Constructor & Destructor Documentation

JComplexPhase() [1/2]

template<class T >

JOSCPROB::JComplexPhase< T >::JComplexPhase ( )

inline

Default constructor.

Definition at line 41 of file JComplexPhase.hh.

                    :
      JOscParameter_t()
    {}

JComplexPhase() [2/2]

template<class T >

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

inlineexplicit

Constructor.

Parameters

value

complex phase value [rad]

Definition at line 51 of file JComplexPhase.hh.

                                                :
      JOscParameter_t(value)
    {
      using namespace JPP;
      
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JComplexPhase::JComplexPhase(): Invalid complex phase " << value);
      }
    }

Member Function Documentation

operator=()

template<class T >

JComplexPhase_t& JOSCPROB::JComplexPhase< T >::operator= ( const value_type &  value )

inline

Assignment operator.

Parameters

value

complex phase value [rad]

Returns

complex phase

Definition at line 68 of file JComplexPhase.hh.

    {
      this->setValue(value);
 
      return *this;
    }

is_valid()

template<class T >

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

inlinefinaloverridevirtual

Check validity of oscillation parameter.

Returns

true if valid; else false

Implements JOSCPROB::JOscParameter< T >.

Definition at line 81 of file JComplexPhase.hh.

    {
      const value_type phase = this->getValue();
      
      return this->isDefined() ? !(phase < 0.0 || phase > 2 * M_PI) : true;
    }

make_parameter()

template<class T >

static JComplexPhase_t JOSCPROB::JComplexPhase< T >::make_parameter ( argument_type  value )

inlinestatic

Auxiliary function to create a complex phase parameter grid.

Parameters

value

complex phase value [rad]

Returns

complex phase parameter

Definition at line 95 of file JComplexPhase.hh.

    {
      return JComplexPhase_t(value);
    }

setValue()

template<class T >

void JOSCPROB::JOscParameter< T >::setValue ( const value_type &  value )

inlineinherited

Set parameter.

Parameters

value

oscillation parameter value

Definition at line 74 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);
      }
    }

getValue()

template<class T >

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

inlineinherited

Get value of parameter.

Returns

value

Definition at line 82 of file JParameter.hh.

    { 
      return __value; 
    }

operator const value_type()

template<class T >

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

inlineinherited

Type conversion operator.

Returns

value

Definition at line 105 of file JParameter.hh.

    { 
      return getValue();
    }

isDefined()

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 116 of file JParameter.hh.

    {
      return is_defined;
    }

less()

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 131 of file JParameter.hh.

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

Member Data Documentation

__value

template<class T >

T JLANG::JParameter< T >::__value

protectedinherited

Definition at line 172 of file JParameter.hh.

is_defined

template<class T >

bool JLANG::JParameter< T >::is_defined

protectedinherited

Definition at line 173 of file JParameter.hh.

---

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

• JComplexPhase.hh