SimpleStimulus.hpp

00001 /*
00002 
00003 Copyright (C) University of Oxford, 2005-2011
00004 
00005 University of Oxford means the Chancellor, Masters and Scholars of the
00006 University of Oxford, having an administrative office at Wellington
00007 Square, Oxford OX1 2JD, UK.
00008 
00009 This file is part of Chaste.
00010 
00011 Chaste is free software: you can redistribute it and/or modify it
00012 under the terms of the GNU Lesser General Public License as published
00013 by the Free Software Foundation, either version 2.1 of the License, or
00014 (at your option) any later version.
00015 
00016 Chaste is distributed in the hope that it will be useful, but WITHOUT
00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
00019 License for more details. The offer of Chaste under the terms of the
00020 License is subject to the License being interpreted in accordance with
00021 English Law and subject to any action against the University of Oxford
00022 being under the jurisdiction of the English Courts.
00023 
00024 You should have received a copy of the GNU Lesser General Public License
00025 along with Chaste. If not, see <http://www.gnu.org/licenses/>.
00026 
00027 */
00028 
00029 
00030 #ifndef _SIMPLESTIMULUS_HPP_
00031 #define _SIMPLESTIMULUS_HPP_
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include <boost/serialization/base_object.hpp>
00035 
00036 #include "AbstractStimulusFunction.hpp"
00037 
00042 class SimpleStimulus : public AbstractStimulusFunction
00043 {
00045     friend class boost::serialization::access;
00052     template<class Archive>
00053     void serialize(Archive & archive, const unsigned int version)
00054     {
00055         // This calls serialize on the base class.
00056         archive & boost::serialization::base_object<AbstractStimulusFunction>(*this);
00057         archive & mMagnitudeOfStimulus;
00058         archive & mDuration;
00059         archive & mTimeOfStimulus;
00060     }
00061 
00062 private:
00067     double mMagnitudeOfStimulus;
00069     double mDuration;
00071     double mTimeOfStimulus;
00072 
00073 public:
00074 
00084     SimpleStimulus(double magnitudeOfStimulus, double duration, double timeOfStimulus=0.0);
00085 
00089     virtual ~SimpleStimulus();
00090 
00096     double GetStimulus(double time);
00097 };
00098 
00099 
00100 #include "SerializationExportWrapper.hpp"
00101 // Declare identifier for the serializer
00102 CHASTE_CLASS_EXPORT(SimpleStimulus)
00103 
00104 namespace boost
00105 {
00106 namespace serialization
00107 {
00112 template<class Archive>
00113 inline void load_construct_data(
00114     Archive & ar, SimpleStimulus * t, const unsigned int file_version)
00115 {
00122      ::new(t)SimpleStimulus(0.0, 0.0, 0.0);
00123 }
00124 }
00125 } // namespace ...
00126 
00127 #endif //_SIMPLESTIMULUS_HPP_
00128 

Generated on Mon Apr 18 11:35:28 2011 for Chaste by  doxygen 1.5.5