JOSCPROB::JOscParametersHelper< T > Struct Template Reference

Helper class for oscillation parameters. More...

#include <JOscParametersHelper.hh>

Inheritance diagram for JOSCPROB::JOscParametersHelper< T >:

Public Types
typedef JOscParametersHelper< T >	JOscParametersHelper_t
typedef JOscParametersInterface< T >	JOscParameters_t
typedef JOscParameters_t::JOscParameter_t	JOscParameter_t
typedef JOscParameters_t::JParameter_t	JParameter_t
typedef JOscParameters_t::argument_type	argument_type
typedef JOscParameters_t::value_type	value_type
typedef std::shared_ptr< JOscParameters_t >	pointer_type

Public Member Functions
	JOscParametersHelper ()
	Default constructor.
	JOscParametersHelper (const pointer_type &p)
	Constructor.
	JOscParametersHelper (const JOscParameters_t &parameters)
	Constructor.
template<class ... Args>
	JOscParametersHelper (const JOscParameters_t &parameters, const std::string &name, argument_type value, const Args &...args)
	Constructor.
void	configure (const pointer_type &p)
	Configure oscillation parameters.
void	configure (const JOscParameters_t &parameters)
	Configure oscillation parameters.
JOscParameters_t &	getParameters () const
	Get reference to oscillation parameters interface.
JOscParameters_t *	get () const
	Get pointer to oscillation parameters interface.
JOscParameter_t &	get (const std::string &name) const
	Get oscillation parameter.
void	set (const std::string &name, const value_type &value) const
	Set value for a given oscillation parameter.
template<class ... Args>
void	set (const std::string &name, const value_type &value, const Args &...args) const
	Set value for given list of oscillation parameters.
void	set (const JOscParametersInterface< value_type > &parameters) const
	Set oscillation parameters.
bool	is_valid () const
	Check validity of oscillation parameters.

Detailed Description

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

Helper class for oscillation parameters.

Definition at line 24 of file JOscParametersHelper.hh.

Member Typedef Documentation

JOscParametersHelper_t

template<class T >

JOscParametersHelper<T> JOSCPROB::JOscParametersHelper< T >::JOscParametersHelper_t

Definition at line 27 of file JOscParametersHelper.hh.

JOscParameters_t

template<class T >

JOscParametersInterface<T> JOSCPROB::JOscParametersHelper< T >::JOscParameters_t

Definition at line 28 of file JOscParametersHelper.hh.

JOscParameter_t

template<class T >

JOscParameters_t::JOscParameter_t JOSCPROB::JOscParametersHelper< T >::JOscParameter_t

Definition at line 30 of file JOscParametersHelper.hh.

JParameter_t

template<class T >

JOscParameters_t::JParameter_t JOSCPROB::JOscParametersHelper< T >::JParameter_t

Definition at line 31 of file JOscParametersHelper.hh.

argument_type

template<class T >

JOscParameters_t::argument_type JOSCPROB::JOscParametersHelper< T >::argument_type

Definition at line 33 of file JOscParametersHelper.hh.

value_type

template<class T >

JOscParameters_t::value_type JOSCPROB::JOscParametersHelper< T >::value_type

Definition at line 34 of file JOscParametersHelper.hh.

pointer_type

template<class T >

std::shared_ptr<JOscParameters_t> JOSCPROB::JOscParametersHelper< T >::pointer_type

Definition at line 36 of file JOscParametersHelper.hh.

Constructor & Destructor Documentation

JOscParametersHelper() [1/4]

template<class T >

JOSCPROB::JOscParametersHelper< T >::JOscParametersHelper ( )

inline

Default constructor.

Definition at line 44 of file JOscParametersHelper.hh.

                           :
      pointer_type()
    {}

JOscParametersHelper() [2/4]

template<class T >

JOSCPROB::JOscParametersHelper< T >::JOscParametersHelper ( const pointer_type & p )

inline

Constructor.

Parameters

p	pointer to oscillation parameters

Definition at line 54 of file JOscParametersHelper.hh.

                                                :
      pointer_type(p)
    {}

JOscParametersHelper() [3/4]

template<class T >

JOSCPROB::JOscParametersHelper< T >::JOscParametersHelper ( const JOscParameters_t & parameters )

inline

Constructor.

Parameters

parameters

oscillation parameters

Definition at line 64 of file JOscParametersHelper.hh.

    {
      this->configure(parameters);
    }

JOscParametersHelper() [4/4]

template<class T >

template<class ... Args>

JOSCPROB::JOscParametersHelper< T >::JOscParametersHelper ( const JOscParameters_t & parameters, const std::string & name, argument_type value, const Args &... args )

inline

Constructor.

Parameters

parameters	oscillation parameters
name	parameter name
value	parameter value
args	remaining pairs of parameter names and values

Definition at line 79 of file JOscParametersHelper.hh.

    {
      this->configure(parameters);
      this->set(name, value, args...);
    }

Member Function Documentation

configure() [1/2]

template<class T >

void JOSCPROB::JOscParametersHelper< T >::configure ( const pointer_type & p )

inline

Configure oscillation parameters.

Parameters

p	shared pointer to oscillation parameters

Definition at line 94 of file JOscParametersHelper.hh.

    {
      static_cast<pointer_type&>(*this);
    }

configure() [2/2]

template<class T >

void JOSCPROB::JOscParametersHelper< T >::configure ( const JOscParameters_t & parameters )

inline

Configure oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 105 of file JOscParametersHelper.hh.

    {
      using namespace std;
      using namespace JPP;
      
      JOscParameters_t* p = dynamic_cast<JOscParameters_t*>(parameters.clone());
 
      if (p != NULL) {
        reset(p);
      } else {
        THROW(JNullPointerException, "JOscParametersHelper::configure(): Unable to retrieve oscillation parameters interface.");
      }
    }

getParameters()

template<class T >

JOscParameters_t & JOSCPROB::JOscParametersHelper< T >::getParameters ( ) const

inline

Get reference to oscillation parameters interface.

Returns

reference to oscillation parameters interface

Definition at line 125 of file JOscParametersHelper.hh.

    {
      using namespace JPP;
 
      if (static_cast<const JOscParametersHelper_t&>(*this)) {
        return *(this->get());
      } else {
        THROW(JNullPointerException, "JOscParametersHelper::getParameters(): Oscillation parameters interface is not set.");
      }
    }

get() [1/2]

template<class T >

JOscParameters_t * JOSCPROB::JOscParametersHelper< T >::get ( ) const

inline

Get pointer to oscillation parameters interface.

Returns

pointer to oscillation parameters interface

Definition at line 142 of file JOscParametersHelper.hh.

    {
      return pointer_type::get();
    }

get() [2/2]

template<class T >

JOscParameter_t & JOSCPROB::JOscParametersHelper< T >::get ( const std::string & name ) const

inline

Get oscillation parameter.

Parameters

name	parameter name

Returns

parameter

Definition at line 154 of file JOscParametersHelper.hh.

    {
      return getParameters().get(name);
    }

set() [1/3]

template<class T >

void JOSCPROB::JOscParametersHelper< T >::set ( const std::string & name, const value_type & value ) const

inline

Set value for a given oscillation parameter.

Parameters

name	parameter name
value	parameter value

Definition at line 167 of file JOscParametersHelper.hh.

    {
      getParameters().set(name, value);
    }

set() [2/3]

template<class T >

template<class ... Args>

void JOSCPROB::JOscParametersHelper< T >::set ( const std::string & name, const value_type & value, const Args &... args ) const

inline

Set value for given list of oscillation parameters.

Parameters

name	parameter name
value	parameter value
args	remaining pairs of parameter names and values

Definition at line 182 of file JOscParametersHelper.hh.

    {
      this->set(name, value);
      this->set(args...);
    }

set() [3/3]

template<class T >

void JOSCPROB::JOscParametersHelper< T >::set ( const JOscParametersInterface< value_type > & parameters ) const

inline

Set oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 196 of file JOscParametersHelper.hh.

    {
      using namespace std;
      using namespace JPP;
 
      const JProperties properties = parameters.getProperties();
 
      for (JProperties::const_iterator i = properties.cbegin(); i != properties.cend(); ++i) {
        
        const JOscParameter<value_type>& parameter = i->second.getValue<const JOscParameter<value_type> >();
        
        this->set(i->first, parameter.getValue());
      }
    }

is_valid()

template<class T >

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

inline

Check validity of oscillation parameters.

Returns

true if all oscillation parameters are valid; else false

Definition at line 217 of file JOscParametersHelper.hh.

    {
      return getParameters().is_valid();
    }

---

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

• JOscParametersHelper.hh