magnes::JEquation::Parameter Class Reference

Representation of a parameter in an empirical equation. More...

#include <jequation.h>

Public Member Functions
	Parameter (const std::string &name, float value)
void	SetName (const std::string &name)
const std::string &	Name () const
void	SetValue (float value)
float	Value () const

Detailed Description

Representation of a parameter in an empirical equation.

Empirical Karplus-like relationships depends on several parameters determined frequently by fitting to empirical data, for instance Karplus Fourier-like relation ship depends on three parameters named A, B and C normally

Constructor & Destructor Documentation

Parameter()

magnes::JEquation::Parameter::Parameter ( const std::string &  name, float  value  )

inline

Parameters

name	the name of the set
value	the floating point numerical value for this parameter

Member Function Documentation

Name()

const std::string& magnes::JEquation::Parameter::Name ( ) const

inline

Returns

The name ot this parameter

SetName()

void magnes::JEquation::Parameter::SetName ( const std::string &  name )

inline

Parameters

name	Set the name of this parameter to name

SetValue()

void magnes::JEquation::Parameter::SetValue ( float  value )

inline

Set the numerical value of the parameter to

Parameters

value

Value()

float magnes::JEquation::Parameter::Value ( ) const

inline

Returns

the numerical value of the parameter

---

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

• /Users/armando/worksrc/magnes-code/trunk/jcoupling/jequation/jequation.h