S1S2Stimulus.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 #ifndef S1S2STIMULUS_HPP_
00030 #define S1S2STIMULUS_HPP_
00031 
00032 #include "ChasteSerialization.hpp"
00033 #include <boost/serialization/base_object.hpp>
00034 
00035 #include "MultiStimulus.hpp"
00036 #include "RegularStimulus.hpp" // For archiving this needs to be here.
00037 
00053 class S1S2Stimulus : public MultiStimulus
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<MultiStimulus>(*this);
00069         archive & mS2Index;
00070         archive & mNumS2FrequencyValues;
00071     }
00072 
00076     unsigned mS2Index;
00080     unsigned mNumS2FrequencyValues;
00081 
00085     S1S2Stimulus(){};
00086 
00087 public:
00088 
00100     S1S2Stimulus(double magnitude, double stimulusDuration, double s1Duration, double s1Period, double startTime, std::vector<double> s2Periods);
00101 
00108      double GetStimulus(double time);
00109 
00115      void SetS2ExperimentPeriodIndex(unsigned index);
00116 
00120      unsigned GetNumS2FrequencyValues();
00121 };
00122 
00123 #include "SerializationExportWrapper.hpp"
00124 // Declare identifier for the serializer
00125 CHASTE_CLASS_EXPORT(S1S2Stimulus);
00126 
00127 #endif /*S1S2STIMULUS_HPP_*/

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