TimeModifier Class Reference

#include <Modifiers.hpp>

Inherits AbstractModifier.

Collaboration diagram for TimeModifier:

List of all members.

Public Member Functions

 TimeModifier ()
virtual double Calc (double param, double time)

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 79 of file Modifiers.hpp.


Constructor & Destructor Documentation

TimeModifier::TimeModifier (  )  [inline]

Constructor

Definition at line 85 of file Modifiers.hpp.


Member Function Documentation

virtual double TimeModifier::Calc ( double  param,
double  time 
) [inline, 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 96 of file Modifiers.hpp.


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

Generated by  doxygen 1.6.2