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 JParameter_t::value_type	value_type
typedef JClonable< JClonable_t >::clone_type	clone_type

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

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

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

Detailed Description

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

Interface class for sets of oscillation parameters.

Definition at line 46 of file JOscParametersInterface.hh.

Member Typedef Documentation

JOscParametersInterface_t

template<class T >

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

Definition at line 52 of file JOscParametersInterface.hh.

JOscParameter_t

template<class T >

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

Definition at line 53 of file JOscParametersInterface.hh.

JParameter_t

template<class T >

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

Definition at line 55 of file JOscParametersInterface.hh.

argument_type

template<class T >

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

Definition at line 57 of file JOscParametersInterface.hh.

value_type

template<class T >

JParameter_t::value_type JOSCPROB::JOscParametersInterface< T >::value_type

Definition at line 58 of file JOscParametersInterface.hh.

clone_type

template<class JClonable_t , class JDerived_t >

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

JOscParametersInterface()

template<class T >

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

inline

Default constructor.

Definition at line 64 of file JOscParametersInterface.hh.

    {}

~JOscParametersInterface()

template<class T >

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

inline

Virtual destructor.

Definition at line 71 of file JOscParametersInterface.hh.

    {}

Member Function Documentation

getProperties() [1/2]

template<class T >

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

getProperties() [2/2]

template<class T >

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

getParameters()

template<class T >

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

inline

Get oscillation parameters.

Returns

reference to oscillation parameters

Definition at line 98 of file JOscParametersInterface.hh.

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

get() [1/2]

template<class T >

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

inline

Get oscillation parameter.

Parameters

name	parameter name

Returns

parameter

Definition at line 110 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JProperties properties = this->getProperties();
 
      const JOscParameter_t& parameter = properties.getValue<const JOscParameter_t>(name);
      
      return parameter;
    }

get() [2/2]

template<class T >

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

inline

Get oscillation parameter.

Parameters

name	parameter name

Returns

parameter

Definition at line 129 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JProperties properties = this->getProperties();
 
      JOscParameter_t& parameter = properties.getValue<JOscParameter_t>(name);
      
      return parameter;
    }

set() [1/3]

template<class T >

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

inline

Set value for a given oscillation parameter.

Parameters

name	parameter name
value	parameter value

Definition at line 148 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;
 
      JProperties properties = this->getProperties();
 
      JOscParameter_t& parameter = properties.getValue<JOscParameter_t>(name);
 
      parameter.setValue(value);
    }

set() [2/3]

template<class T >

template<class ... Args>

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

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

set() [3/3]

template<class T >

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

inline

Set oscillation parameters.

Parameters

parameters

oscillation parameters

Definition at line 184 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;
 
      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());
      }
    }

is_valid()

template<class T >

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

    {
      bool valid = true;
 
      const JProperties properties = this->getProperties();
 
      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;
    }

equals()

template<class T >

bool JOSCPROB::JOscParametersInterface< T >::equals ( const JOscParametersInterface< value_type > & parameters ) const

inline

Check whether these oscillation parameters are equal to given oscillation parameters.

Parameters

oscillation

parameters

Returns

true if equal; else false

Definition at line 228 of file JOscParametersInterface.hh.

    {
      using namespace std;
      using namespace JPP;
 
      bool equal = true;
 
      JProperties properties = this->getProperties();
 
      for (JProperties::const_iterator i = properties.cbegin(); i != properties.cend() && equal; ++i) {
 
        const JOscParameter_t& parameter = i->second.getValue<const JOscParameter_t>();
        
        equal = (parameter == parameters.get(i->first));
      }
 
      return equal;
    }

operator==()

template<class T >

bool JOSCPROB::JOscParametersInterface< T >::operator== ( const JOscParametersInterface< value_type > & parameters )

inline

Equal operator.

Parameters

parameters

set of oscillation parameters

Returns

true if this set of oscillation parameters is equal to the given set; else false

Definition at line 254 of file JOscParametersInterface.hh.

    { 
      return this->equals(parameters);
    }

operator!=()

template<class T >

bool JOSCPROB::JOscParametersInterface< T >::operator!= ( const JOscParametersInterface< value_type > & parameters )

inline

Not equal operator.

Parameters

parameters

set of oscillation parameters

Returns

true if this set of oscillation parameters is equal to the given set; else false

Definition at line 266 of file JOscParametersInterface.hh.

    {
      return !this->equals(parameters);
    }

getEquationParameters()

template<class T >

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

inlinestatic

Get equation parameters.

Returns

equation parameters

Definition at line 277 of file JOscParametersInterface.hh.

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

setEquationParameters()

template<class T >

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

inlinestatic

Set equation parameters.

Parameters

equation

equation parameters

Definition at line 290 of file JOscParametersInterface.hh.

    {
      getEquationParameters() = equation;
    }

read()

template<class T >

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

    {
      JProperties properties = this->getProperties();
      
      for (JProperties::iterator i = properties.begin(); i != properties.end(); ++i) {
        
        bool       is_defined;
        value_type value;
        
        if ((in >> is_defined >> value) && is_defined) {
 
          JOscParameter_t& parameter = i->second.getValue<JOscParameter_t>();
          
          parameter.setValue(value);
        }
      }
 
      return in;
    }

write()

template<class T >

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

    {
      const JProperties properties = this->getProperties();
      
      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;
    }

clone()

template<class JClonable_t , class JDerived_t >

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::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.

Definition at line 69 of file JClonable.hh.

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

Friends And Related Symbol Documentation

operator>>

template<class T >

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

    {
      using namespace std;
      using namespace JPP;
      
      JStringStream is(in);
 
      if (getFileStatus(is.str().c_str())) {
        is.load();
      }
 
      JProperties properties = parameters.getProperties();
      is >> properties;
 
      return in;
    }

operator<<

template<class T >

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

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

---

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

• JOscParametersInterface.hh