Chaste Release::3.1
SimpleStimulus.hpp
00001 /*
00002 
00003 Copyright (c) 2005-2012, University of Oxford.
00004 All rights reserved.
00005 
00006 University of Oxford means the Chancellor, Masters and Scholars of the
00007 University of Oxford, having an administrative office at Wellington
00008 Square, Oxford OX1 2JD, UK.
00009 
00010 This file is part of Chaste.
00011 
00012 Redistribution and use in source and binary forms, with or without
00013 modification, are permitted provided that the following conditions are met:
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright notice,
00017    this list of conditions and the following disclaimer in the documentation
00018    and/or other materials provided with the distribution.
00019  * Neither the name of the University of Oxford nor the names of its
00020    contributors may be used to endorse or promote products derived from this
00021    software without specific prior written permission.
00022 
00023 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00024 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00025 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00026 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00027 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00028 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00029 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00030 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00032 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033 
00034 */
00035 
00036 
00037 #ifndef _SIMPLESTIMULUS_HPP_
00038 #define _SIMPLESTIMULUS_HPP_
00039 
00040 #include "ChasteSerialization.hpp"
00041 #include <boost/serialization/base_object.hpp>
00042 
00043 #include "AbstractStimulusFunction.hpp"
00044 
00049 class SimpleStimulus : public AbstractStimulusFunction
00050 {
00052     friend class boost::serialization::access;
00059     template<class Archive>
00060     void serialize(Archive & archive, const unsigned int version)
00061     {
00062         // This calls serialize on the base class.
00063         archive & boost::serialization::base_object<AbstractStimulusFunction>(*this);
00064         archive & mMagnitudeOfStimulus;
00065         archive & mDuration;
00066         archive & mTimeOfStimulus;
00067     }
00068 
00069 private:
00074     double mMagnitudeOfStimulus;
00076     double mDuration;
00078     double mTimeOfStimulus;
00079 
00080 public:
00081 
00091     SimpleStimulus(double magnitudeOfStimulus, double duration, double timeOfStimulus=0.0);
00092 
00096     virtual ~SimpleStimulus();
00097 
00103     double GetStimulus(double time);
00104 };
00105 
00106 
00107 #include "SerializationExportWrapper.hpp"
00108 // Declare identifier for the serializer
00109 CHASTE_CLASS_EXPORT(SimpleStimulus)
00110 
00111 namespace boost
00112 {
00113 namespace serialization
00114 {
00119 template<class Archive>
00120 inline void load_construct_data(
00121     Archive & ar, SimpleStimulus * t, const unsigned int file_version)
00122 {
00129      ::new(t)SimpleStimulus(0.0, 0.0, 0.0);
00130 }
00131 }
00132 } // namespace ...
00133 
00134 #endif //_SIMPLESTIMULUS_HPP_
00135