JOSCPROB::JOscParametersInterface< T > Class Template Reference

Interface class for sets of oscillation parameters. More...

#include <JOscParametersInterface.hh>

Inheritance diagram for JOSCPROB::JOscParametersInterface< T >:

Public Types
typedef JOscParametersInterface< T >	JOscParametersInterface_t
typedef JOscParameter< T >	JOscParameter_t
typedef JOscParameter_t::JParameter_t	JParameter_t
typedef JParameter_t::argument_type	argument_type
typedef JClonable< JClonable_t > ::clone_type	clone_type

Public Member Functions
	JOscParametersInterface ()
	Default constructor. More...
	~JOscParametersInterface ()
	Virtual destructor. More...
virtual JProperties	getProperties (const JEquationParameters &equation=JOscParametersInterface_t::getEquationParameters())=0
	Get properties of this class. More...
virtual JProperties	getProperties (const JEquationParameters &equation=JOscParametersInterface_t::getEquationParameters()) const =0
	Get properties of this class. More...
JProperties &	getPropertiesInstance (const JEquationParameters &equation=JOscParametersInterface_t::getEquationParameters())
	Get instance of properties of this class. More...
JProperties &	getPropertiesInstance (const JEquationParameters &equation=JOscParametersInterface_t::getEquationParameters()) const
	Get instance of properties of this class. More...
JOscParametersInterface_t &	getParameters ()
	Get oscillation parameters. More...
void	set (const std::string &name, argument_type value)
	Set value for a given oscillation parameter. More...
template<class... Args>
void	set (const std::string &name, argument_type value, const Args &...args)
	Set value for given list of oscillation parameters. More...
void	set (const JOscParametersInterface_t &parameters)
	Set oscillation parameters. More...
bool	is_valid () const
	Check validity of oscillation parameters. More...
JReader &	read (JReader &in) override
	Binary stream input of oscillation parameters. More...
JWriter &	write (JWriter &out) const override
	Binary stream output of oscillation parameters. More...
virtual clone_type	clone () const override
	Get clone of this object. More...

Static Public Member Functions
static JEquationParameters &	getEquationParameters ()
	Get equation parameters. More...
static void	setEquationParameters (const JEquationParameters &equation)
	Set equation parameters. More...

Friends
std::istream &	operator>> (std::istream &in, JOscParametersInterface_t &parameters)
	Stream input of oscillation parameters. More...
std::ostream &	operator<< (std::ostream &out, const JOscParametersInterface_t &parameters)
	Stream output of oscillation parameters. More...

Detailed Description

template<class T = double>
class JOSCPROB::JOscParametersInterface< T >

Interface class for sets of oscillation parameters.

Definition at line 46 of file JOscParametersInterface.hh.

Member Typedef Documentation

template<class T = double>

typedef JOscParametersInterface<T> JOSCPROB::JOscParametersInterface< T >::JOscParametersInterface_t

Definition at line 52 of file JOscParametersInterface.hh.

template<class T = double>

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

Definition at line 53 of file JOscParametersInterface.hh.

template<class T = double>

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

Definition at line 55 of file JOscParametersInterface.hh.

template<class T = double>

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

Definition at line 57 of file JOscParametersInterface.hh.

template<class JClonable_t, class JDerived_t = JNullType>

typedef JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

template<class T = double>

JOSCPROB::JOscParametersInterface< T >::JOscParametersInterface ( )

inline

Default constructor.

Definition at line 63 of file JOscParametersInterface.hh.

    {}

template<class T = double>

JOSCPROB::JOscParametersInterface< T >::~JOscParametersInterface ( )

inline

Virtual destructor.

Definition at line 70 of file JOscParametersInterface.hh.

    {}

Member Function Documentation

template<class T = double>

virtual JProperties JOSCPROB::JOscParametersInterface< T >::getProperties ( const JEquationParameters &  equation = JOscParametersInterface_t::getEquationParameters() )

pure virtual

Get properties of this class.

Parameters

equation

equation parameters

Returns

properties of this class

template<class T = double>

virtual JProperties JOSCPROB::JOscParametersInterface< T >::getProperties ( const JEquationParameters &  equation = JOscParametersInterface_t::getEquationParameters() ) const

pure virtual

Get properties of this class.

Parameters

equation

equation parameters

Returns

properties of this class

template<class T = double>

JProperties& JOSCPROB::JOscParametersInterface< T >::getPropertiesInstance ( const JEquationParameters &  equation = JOscParametersInterface_t::getEquationParameters() )

inline

Get instance of properties of this class.

Parameters

equation

equation parameters

Returns

instance of properties of this class

Definition at line 98 of file JOscParametersInterface.hh.

    {
      static JProperties properties = getProperties(equation);

      return properties;
    }

template<class T = double>

JProperties& JOSCPROB::JOscParametersInterface< T >::getPropertiesInstance ( const JEquationParameters &  equation = JOscParametersInterface_t::getEquationParameters() ) const

inline

Get instance of properties of this class.

Parameters

equation

equation parameters

Returns

instance of properties of this class

Definition at line 112 of file JOscParametersInterface.hh.

    {
      static JProperties properties = getProperties(equation);

      return properties;
    }

template<class T = double>

JOscParametersInterface_t& JOSCPROB::JOscParametersInterface< T >::getParameters ( )

inline

Get oscillation parameters.

Returns

reference to oscillation parameters

Definition at line 125 of file JOscParametersInterface.hh.

    {
      return static_cast<JOscParametersInterface_t&>(*this);
    }

template<class T = double>

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

inline

Set value for a given oscillation parameter.

Parameters

name	parameter name
value	parameter value

Definition at line 137 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;

      JProperties& properties = this->getPropertiesInstance();

      JOscParameter_t& parameter = properties.getValue<JOscParameter_t>(name);

      parameter.setValue(value);
    }

template<class T = double>

template<class... Args>

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

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 159 of file JOscParametersInterface.hh.

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

template<class T = double>

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

inline

Set oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 173 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;

      const JProperties& properties = parameters.getPropertiesInstance();

      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::JOscParametersInterface< T >::is_valid ( ) const

inline

Check validity of oscillation parameters.

Returns

true if all oscillation parameters are valid; else false

Definition at line 193 of file JOscParametersInterface.hh.

    {
      bool valid = true;
      
      const JProperties& properties = this->getPropertiesInstance();

      for (JProperties::const_iterator i = properties.cbegin(); i != properties.cend() && valid; ++i) {
        
        const JOscParameter_t& parameter = i->second.getValue<const JOscParameter_t>();
        
        valid = parameter.is_valid();
      }

      return valid;
    }

template<class T = double>

static JEquationParameters& JOSCPROB::JOscParametersInterface< T >::getEquationParameters ( )

inlinestatic

Get equation parameters.

Returns

equation parameters

Definition at line 215 of file JOscParametersInterface.hh.

    {
      static JEquationParameters equation("=", "\n\r;,", "./", "#");

      return equation;
    }

template<class T = double>

static void JOSCPROB::JOscParametersInterface< T >::setEquationParameters ( const JEquationParameters &  equation )

inlinestatic

Set equation parameters.

Parameters

equation

equation parameters

Definition at line 228 of file JOscParametersInterface.hh.

    {
      getEquationParameters() = equation;
    }

template<class T = double>

JReader& JOSCPROB::JOscParametersInterface< T >::read ( JReader &  in )

inlineoverridevirtual

Binary stream input of oscillation parameters.

Parameters

in	input stream

Returns

input stream

Implements JIO::JSerialisable.

Definition at line 240 of file JOscParametersInterface.hh.

    {
      JProperties& properties = this->getPropertiesInstance();

      for (JProperties::iterator i = properties.begin(); i != properties.end(); ++i) {
        
        bool is_defined;
        T    value;
        
        if ((in >> is_defined >> value) && is_defined) {

          JOscParameter_t& parameter = i->second.getValue<JOscParameter_t>();
          
          parameter.setValue(value);
        }
      }

      return in;
    }

template<class T = double>

JWriter& JOSCPROB::JOscParametersInterface< T >::write ( JWriter &  out ) const

inlineoverridevirtual

Binary stream output of oscillation parameters.

Parameters

out	output stream

Returns

output stream

Implements JIO::JSerialisable.

Definition at line 267 of file JOscParametersInterface.hh.

    {
      const JProperties& properties = this->getPropertiesInstance();

      for (JProperties::const_iterator i = properties.cbegin(); i != properties.cend(); ++i) {

        const JOscParameter_t& parameter = i->second.getValue<const JOscParameter_t>();

        out << parameter.isDefined() << parameter.getValue();
      }

      return out;
    }

template<class JClonable_t, class JDerived_t = JNullType>

virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const

inlineoverridevirtualinherited

Get clone of this object.

Returns

pointer to newly created object

Reimplemented in JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, JPHYSICS::JPD0Transformer_t< JArgument_t >, JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, JPHYSICS::JPDFTransformer_t< JArgument_t >, JLANG::JClonable< JMatch< hit_type > >, JLANG::JClonable< JMatch< hit_type >, JMatch3D >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 > >, and JLANG::JClonable< JMatch< JTRIGGER::JHitR1 >, JMatch3G< JTRIGGER::JHitR1 > >.

Definition at line 69 of file JClonable.hh.

    {
      return new JDerived_t(static_cast<const JDerived_t&>(*this));
    }

Friends And Related Function Documentation

template<class T = double>

std::istream& operator>> ( std::istream &  in, JOscParametersInterface_t &  parameters  )

friend

Stream input of oscillation parameters.

Parameters

in	input stream
parameters	oscillation parameters

Returns

input stream

Definition at line 289 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;
      
      JStringStream is(in);

      if (getFileStatus(is.str().c_str())) {
        is.load();
      }

      JProperties& properties = parameters.getPropertiesInstance();
      is >> properties;

      return in;
    }

template<class T = double>

std::ostream& operator<< ( std::ostream &  out, const JOscParametersInterface_t &  parameters  )

friend

Stream output of oscillation parameters.

Parameters

out	output stream
parameters	oscillation parameters

Returns

output stream

Definition at line 314 of file JOscParametersInterface.hh.

    {
      return out << parameters.getPropertiesInstance();
    }

---

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

• JOscParametersInterface.hh