RegularStimulusZeroNetCharge.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 _REGULARSTIMULUSZERONETCHARGE_HPP_
00031 #define _REGULARSTIMULUSZERONETCHARGE_HPP_
00032 
00033 #include "ChasteSerialization.hpp"
00034 #include <boost/serialization/base_object.hpp>
00035 #include "RegularStimulus.hpp"
00036 
00053 class RegularStimulusZeroNetCharge : public RegularStimulus
00054 {
00055 private:
00057     friend class boost::serialization::access;
00064     template<class Archive>
00065     void serialize(Archive & archive, const unsigned int version)
00066     {
00067         // This calls serialize on the base class.
00068         archive & boost::serialization::base_object<RegularStimulus>(*this);
00069     }
00070 
00071 public:
00081     RegularStimulusZeroNetCharge(double magnitudeOfStimulus, double duration, double period, double startTime, double stopTime=DBL_MAX);
00082 
00089     double GetStimulus(double time);
00090 
00091 };
00092 
00093 #include "SerializationExportWrapper.hpp"
00094 // Declare identifier for the serializer
00095 CHASTE_CLASS_EXPORT(RegularStimulusZeroNetCharge)
00096 
00097 namespace boost
00098 {
00099 namespace serialization
00100 {
00105 template<class Archive>
00106 inline void load_construct_data(
00107     Archive & ar, RegularStimulusZeroNetCharge * t, const unsigned int file_version)
00108 {
00115      ::new(t)RegularStimulusZeroNetCharge(0.0, 0.0, 0.1, 0.0, 1.0);
00116 }
00117 }
00118 } // namespace ...
00119 
00120 #endif //_REGULARSTIMULUS_HPP_

Generated on Tue May 31 14:31:42 2011 for Chaste by  doxygen 1.5.5