#include <TimeModifier.hpp>

Inheritance diagram for TimeModifier:

Collaboration diagram for TimeModifier:

Public Member Functions
	TimeModifier ()

virtual	~TimeModifier ()

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)

Friends
class	boost::serialization::access

Detailed Description

This is just an example class to show how you might specify a custom modifier to change a parameter through time. In this case it implements a sin(time)*default_parameter factor modifier.

Definition at line 51 of file TimeModifier.hpp.

Constructor & Destructor Documentation

◆ TimeModifier()

TimeModifier::TimeModifier ( )

inline

Constructor

Definition at line 73 of file TimeModifier.hpp.

◆ ~TimeModifier()

virtual TimeModifier::~TimeModifier ( )

inlinevirtual

Default destructor.

Definition at line 80 of file TimeModifier.hpp.

Member Function Documentation

◆ Calc()

double TimeModifier::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 new value for the quantity which is being modified

Implements AbstractModifier.

Definition at line 38 of file TimeModifier.cpp.

◆ serialize()

template<class Archive >

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

inlineprivate

Archive the member variables.

Parameters

archive
version

Definition at line 63 of file TimeModifier.hpp.

Friends And Related Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access

friend

Needed for serialization.

Definition at line 55 of file TimeModifier.hpp.

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

heart/src/odes/modifiers/TimeModifier.hpp
heart/src/odes/modifiers/TimeModifier.cpp

Public Member Functions

Private Member Functions

Friends