Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
RegularStimulus.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36
37#ifndef _REGULARSTIMULUS_HPP_
38#define _REGULARSTIMULUS_HPP_
39
41#include <boost/serialization/base_object.hpp>
42
43#include "AbstractStimulusFunction.hpp"
44
49{
50private:
59 template<class Archive>
60 void serialize(Archive & archive, const unsigned int version)
61 {
62 // This calls serialize on the base class.
63 archive & boost::serialization::base_object<AbstractStimulusFunction>(*this);
64 archive & mMagnitudeOfStimulus;
65 archive & mDuration;
66 archive & mPeriod;
67 archive & mStartTime;
68 archive & mStopTime;
69 }
70
71protected:
72
76 double mDuration;
78 double mPeriod;
80 double mStartTime;
82 double mStopTime;
83
84public:
94 RegularStimulus(double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX);
95
102 double GetStimulus(double time);
103
107 double GetPeriod();
108
112 double GetMagnitude();
113
117 double GetDuration();
118
122 double GetStartTime();
123
133 void SetMagnitude(double magnitude);
134
140 void SetPeriod(double period);
141
147 void SetDuration(double duration);
148
154 void SetStartTime(double startTime);
155
161 void SetStopTime(double stopTime);
162};
163
165// Declare identifier for the serializer
167
168namespace boost
169{
170namespace serialization
171{
176template<class Archive>
177inline void load_construct_data(
178 Archive & ar, RegularStimulus * t, const unsigned int file_version)
179{
186 ::new(t)RegularStimulus(0.0, 0.0, 0.1, 0.0, 1.0);
187}
188}
189} // namespace ...
190
191#endif //_REGULARSTIMULUS_HPP_
gcov doesn't like this file...
#define CHASTE_CLASS_EXPORT(T)
void SetStopTime(double stopTime)
void SetMagnitude(double magnitude)
void SetPeriod(double period)
void serialize(Archive &archive, const unsigned int version)
void SetDuration(double duration)
void SetStartTime(double startTime)
double GetStimulus(double time)
friend class boost::serialization::access