Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
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() [1/2]

FixedModifier::FixedModifier ( )
inlineprivate

Private constructor for use by archiving only

Definition at line 71 of file FixedModifier.hpp.

◆ FixedModifier() [2/2]

FixedModifier::FixedModifier ( double  value)
inline

Constructor

Parameters
valueThe fixed value to use.

Definition at line 78 of file FixedModifier.hpp.

◆ ~FixedModifier()

virtual FixedModifier::~FixedModifier ( )
inlinevirtual

Default destructor.

Definition at line 86 of file FixedModifier.hpp.

Member Function Documentation

◆ Calc()

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

Perform the modification.

Parameters
paramthe current value of the quantity which is being modified
timethe current simulation time
Returns
the fixed value (ignores inputs)

Implements AbstractModifier.

Definition at line 38 of file FixedModifier.cpp.

References mValue.

◆ serialize()

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 Symbol Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Needed for serialization.

Definition at line 53 of file FixedModifier.hpp.

Member Data Documentation

◆ mValue

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: