FixedModifier Class Reference

#include <FixedModifier.hpp>

Inheritance diagram for FixedModifier:

Collaboration diagram for FixedModifier:

Public Member Functions
	FixedModifier (double value)
virtual	~FixedModifier ()
virtual double	Calc (double param, double time)
Public Member Functions inherited from AbstractModifier
	AbstractModifier (void)
virtual	~AbstractModifier ()

Private Member Functions
template<class Archive >
void	serialize (Archive &archive, const unsigned int version)
	FixedModifier ()

Private Attributes
double	mValue

Friends
class	boost::serialization::access

Detailed Description

This class just returns a fixed value, regardless of the parameter's default or the time.

Definition at line 49 of file FixedModifier.hpp.

Constructor & Destructor Documentation

FixedModifier::FixedModifier ( )

inlineprivate

Private constructor for use by archiving only

Definition at line 71 of file FixedModifier.hpp.

FixedModifier::FixedModifier ( double  value )

inline

Constructor

Parameters

value

The fixed value to use.

Definition at line 78 of file FixedModifier.hpp.

virtual FixedModifier::~FixedModifier ( )

inlinevirtual

Default destructor.

Definition at line 86 of file FixedModifier.hpp.

Member Function Documentation

double FixedModifier::Calc ( double  param, double  time  )

virtual

Perform the modification.

Parameters

param	the current value of the quantity which is being modified
time	the current simulation time

Returns

the fixed value (ignores inputs)

Implements AbstractModifier.

Definition at line 38 of file FixedModifier.cpp.

References mValue.

template<class Archive >

void FixedModifier::serialize ( Archive &  archive, const unsigned int  version  )

inlineprivate

Archive the member variables.

Parameters

archive
version

Definition at line 61 of file FixedModifier.hpp.

References mValue.

Friends And Related Function Documentation

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 53 of file FixedModifier.hpp.

Member Data Documentation

double FixedModifier::mValue

private

Fixed value to clamp parameter at

Definition at line 68 of file FixedModifier.hpp.

Referenced by Calc(), and serialize().

---

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

• heart/src/odes/modifiers/FixedModifier.hpp
• heart/src/odes/modifiers/FixedModifier.cpp