BioLCCC::Gradient Class Reference

An instance of Gradient describes an elution gradient. More...

#include <gradient.h>

Inheritance diagram for BioLCCC::Gradient:

Public Member Functions
	Gradient ()
	Constructs an empty elution gradient.
	Gradient (double initialConcentrationB, double finalConcentrationB, double time)
	Constructs a linear elution gradient.
Gradient	addPoint (GradientPoint iPoint)
	Extends the gradient with the point iPoint.
Gradient	addPoint (double iTime, double iConcentrationB)
	Extends the gradient with the point (iTime, iConcentrationB).

Detailed Description

An instance of Gradient describes an elution gradient.

An instance of Gradient keeps the shape of an elution gradient, i.e. the dependence of the concentration of component B on time. The shape is represented by a series of points (time, concentration of component B). The concentration in a moment of time between any two points is linearly interpolated.

Note that gradient must start with point at 0.0 min and contain only successive points.

Gradient is a public "heir" of std::vector, so see the corresponding reference (http://www.cplusplus.com/reference/stl/vector/) for help on other members and methods of this class.

Constructor & Destructor Documentation

Gradient()

BioLCCC::Gradient::Gradient	(	double	initialConcentrationB,
		double	finalConcentrationB,
		double	time
	)

Constructs a linear elution gradient.

Constructs a gradient with two points: (0.0, initialConcentrationB) and (time, finalConcentrationB).

Parameters

initialConcentrationB	Concentration of component B at 0.0 min.
finalConcentrationB	Concentration of component B at the end of the gradient.
time	The duration of the gradient.

Member Function Documentation

addPoint()

Gradient BioLCCC::Gradient::addPoint	(	double	iTime,
		double	iConcentrationB
	)

Extends the gradient with the point (iTime, iConcentrationB).

Valid values are iTime >= 0.0 and 0.0 <= iConcentrationB <= 100.0

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/biolccc/checkouts/latest/include/gradient.h
• /home/docs/checkouts/readthedocs.org/user_builds/biolccc/checkouts/latest/src/core/gradient.cpp