MultiStimulus.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 MULTISTIMULUS_HPP_
00031 #define MULTISTIMULUS_HPP_
00032 
00033 #include <vector>
00034 
00035 #include "ChasteSerialization.hpp"
00036 #include <boost/serialization/base_object.hpp>
00037 #include <boost/serialization/vector.hpp>
00038 #include <boost/shared_ptr.hpp>
00039 #include <boost/serialization/shared_ptr.hpp>
00040 
00041 #include "AbstractStimulusFunction.hpp"
00042 
00051 class MultiStimulus : public AbstractStimulusFunction
00052 {
00053 private:
00055     friend class boost::serialization::access;
00062     template<class Archive>
00063     void serialize(Archive & archive, const unsigned int version)
00064     {
00065         // This calls serialize on the base class.
00066         archive & boost::serialization::base_object<AbstractStimulusFunction>(*this);
00067         archive & mStimuli;
00068     }
00069 protected:
00071     std::vector<boost::shared_ptr<AbstractStimulusFunction> > mStimuli;
00072 
00073 public:
00077     ~MultiStimulus();
00078 
00084      void AddStimulus(boost::shared_ptr<AbstractStimulusFunction> pStimulus);
00085 
00092      virtual double GetStimulus(double time);
00093 
00098      void Clear();
00099 };
00100 
00101 #include "SerializationExportWrapper.hpp"
00102 // Declare identifier for the serializer
00103 CHASTE_CLASS_EXPORT(MultiStimulus)
00104 
00105 #endif /*MULTISTIMULUS_HPP_*/

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