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 std::shared_ptr < JOscParameters_t >	pointer_type

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

Detailed Description

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

Helper class for oscillation parameters.

Definition at line 24 of file JOscParametersHelper.hh.

Member Typedef Documentation

template<class T = double>

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

Definition at line 27 of file JOscParametersHelper.hh.

template<class T = double>

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

Definition at line 28 of file JOscParametersHelper.hh.

template<class T = double>

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

Definition at line 30 of file JOscParametersHelper.hh.

template<class T = double>

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

Definition at line 31 of file JOscParametersHelper.hh.

template<class T = double>

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

Definition at line 32 of file JOscParametersHelper.hh.

template<class T = double>

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

Definition at line 34 of file JOscParametersHelper.hh.

Constructor & Destructor Documentation

template<class T = double>

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

inline

Default constructor.

Definition at line 42 of file JOscParametersHelper.hh.

    {}

template<class T = double>

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

inline

Constructor.

Parameters

parameters

oscillation parameters

Definition at line 51 of file JOscParametersHelper.hh.

    {
      this->configure(parameters);
    }

template<class T = double>

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 66 of file JOscParametersHelper.hh.

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

Member Function Documentation

template<class T = double>

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

inlinevirtual

Configure oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 81 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.");
      }
    }

template<class T = double>

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

inline

Get reference to oscillation parameters interface.

Returns

reference to oscillation parameters interface

Definition at line 101 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.");
      }
    }

template<class T = double>

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

inlinevirtual

Set value for a given oscillation parameter.

Parameters

name	parameter name
value	parameter value

Definition at line 119 of file JOscParametersHelper.hh.

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

template<class T = double>

template<class... Args>

void JOSCPROB::JOscParametersHelper< T >::set ( const std::string &  name, argument_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 134 of file JOscParametersHelper.hh.

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

template<class T = double>

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

inline

Set oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 148 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_t& parameter = i->second.getValue<const JOscParameter_t>();
        
        this->set(i->first, parameter.getValue());
      }
    }

template<class T = double>

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 168 of file JOscParametersHelper.hh.

    {
      return getParameters().is_valid();
    }

---

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

• JOscParametersHelper.hh