JOSCPROB::JOscParameter< T > Struct Template Reference

Abstract base class for oscillation parameter. More...

#include <JOscParameter.hh>

Inheritance diagram for JOSCPROB::JOscParameter< T >:

Public Types
typedef JParameter< T >	JParameter_t
typedef JParameter_t::argument_type	argument_type
typedef JParameter_t::value_type	value_type

Public Member Functions
	JOscParameter ()
	Default constructor. More...
	JOscParameter (argument_type value)
	Constructor. More...
JOscParameter< T > &	operator= (const value_type &value)
	Assignment operator. More...
void	setValue (const value_type &value)
	Set parameter. More...
virtual bool	is_valid () const =0
	Check validity of oscillation 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...

Protected Attributes
T	__value
bool	is_defined

Friends
std::istream &	operator>> (std::istream &in, JOscParameter< T > &parameter)
	Stream input. More...

Detailed Description

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

Abstract base class for oscillation parameter.

Definition at line 28 of file JOscParameter.hh.

Member Typedef Documentation

JParameter_t

template<class T >

typedef JParameter<T> JOSCPROB::JOscParameter< T >::JParameter_t

Definition at line 31 of file JOscParameter.hh.

argument_type

template<class T >

typedef JParameter_t::argument_type JOSCPROB::JOscParameter< T >::argument_type

Definition at line 33 of file JOscParameter.hh.

value_type

template<class T >

typedef JParameter_t::value_type JOSCPROB::JOscParameter< T >::value_type

Definition at line 34 of file JOscParameter.hh.

Constructor & Destructor Documentation

JOscParameter() [1/2]

template<class T >

JOSCPROB::JOscParameter< T >::JOscParameter ( )

inline

Default constructor.

Definition at line 40 of file JOscParameter.hh.

                    :
      JParameter_t()
    {}

JOscParameter() [2/2]

template<class T >

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

inlineexplicit

Constructor.

Parameters

value

oscillation parameter value

Definition at line 50 of file JOscParameter.hh.

                                                :
      JParameter_t(value)
    {}

Member Function Documentation

operator=()

template<class T >

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

inline

Assignment operator.

Parameters

value

oscillation parameter value

Returns

oscillation parameter

Definition at line 61 of file JOscParameter.hh.

    {
      setValue(value);
 
      return *this;
    }

setValue()

template<class T >

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

inline

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);
      }
    }

is_valid()

template<class T >

virtual bool JOSCPROB::JOscParameter< T >::is_valid ( ) const

pure virtual

Check validity of oscillation parameter.

Returns

true if valid; else false

Implemented in JOSCPROB::JMixingAngle< JGrid< double > >, JOSCPROB::JMixingAngle< T >, JOSCPROB::JMassSquaredDifference< JGrid< double > >, JOSCPROB::JMassSquaredDifference< T >, JOSCPROB::JComplexPhase< JGrid< double > >, and JOSCPROB::JComplexPhase< T >.

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();
    }

Friends And Related Function Documentation

operator>>

template<class T >

std::istream& operator>> ( std::istream &  in, JOscParameter< T > &  parameter  )

friend

Stream input.

Parameters

in	input stream
parameter	oscillation parameter

Returns

input stream

Definition at line 101 of file JOscParameter.hh.

    {
      using namespace JPP;
      
      in >> static_cast<JParameter_t&>(parameter);
 
      if (!parameter.is_valid()) {
        THROW(JValueOutOfRange, "JOscParameter<T>::operator>>(): Given oscillation parameter is invalid " << parameter);
      }
 
      return in;
    }

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:

• JOscParameter.hh