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

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

Protected Attributes
T	__value
bool	is_defined

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

Detailed Description

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

Abstract base class for oscillation parameter.

Definition at line 28 of file JOscParameter.hh.

Member Typedef Documentation

template<class T = double>

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

Definition at line 31 of file JOscParameter.hh.

template<class T = double>

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

Definition at line 33 of file JOscParameter.hh.

Constructor & Destructor Documentation

template<class T = double>

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

inline

Default constructor.

Definition at line 39 of file JOscParameter.hh.

                    :
      JParameter_t()
    {}

template<class T = double>

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

inlineexplicit

Constructor.

Parameters

value

oscillation parameter value

Definition at line 49 of file JOscParameter.hh.

                                                :
      JParameter_t(value)
    {}

Member Function Documentation

template<class T = double>

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

inline

Assignment operator.

Parameters

value

oscillation parameter value

Returns

oscillation parameter

Definition at line 60 of file JOscParameter.hh.

    {
      setValue(value);

      return *this;
    }

template<class T = double>

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

inline

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 = double>

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

pure virtual

Check validity of oscillation parameter.

Returns

true if valid; else false

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

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

Friends And Related Function Documentation

template<class T = double>

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

template<class T = double>

std::ostream& operator<< ( std::ostream &  out, const JOscParameter< T > &  parameter  )

friend

Stream output.

Parameters

out	output stream
parameter	oscillation parameter

Returns

output stream

Definition at line 121 of file JOscParameter.hh.

    {
      return out << static_cast<const JParameter_t&>(parameter);
    }

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:

• JOscParameter.hh