magnes::JEquation::ParameterSet Class Reference

A set of parameters. More...

#include <jequation.h>

Public Member Functions
	ParameterSet ()
	Empty constructor.
	ParameterSet (const std::string &name)
	Construct an empty parameter set with name n.
const std::vector< Parameter > &	Set () const
std::vector< Parameter > &	Set ()
std::string	Name () const
void	SetName (const std::string &name)
ParameterSet &	operator<< (Parameter f)
	Implemented for convenience Syntactic sugar to write long lists of parameters.
void	Save (std::ostream &s) const

Detailed Description

A set of parameters.

Each set of parameters is represented by an instantiation of this class, for instance A, B and C parameters in Karplus equation

Member Function Documentation

Name()

std::string magnes::JEquation::ParameterSet::Name ( ) const

inline

Returns

name of the set

Save()

void magnes::JEquation::ParameterSet::Save

(

std::ostream &

s

)

const

Save this parameter set to stream s

Set() [1/2]

const std::vector<Parameter>& magnes::JEquation::ParameterSet::Set ( ) const

inline

Returns

a const stl vector of parameters

Set() [2/2]

std::vector<Parameter>& magnes::JEquation::ParameterSet::Set ( )

inline

Returns

a non const stl vector of parameters

SetName()

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

inline

Set the name of the set to name

---

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

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