Chaste Release::3.1
AbstractCardiacCellWithModifiers.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 #ifndef ABSTRACTCARDIACCELLWITHMODIFIERS_HPP_
00037 #define ABSTRACTCARDIACCELLWITHMODIFIERS_HPP_
00038 
00039 #include <boost/shared_ptr.hpp>
00040 #include <map>
00041 #include <string>
00042 
00043 // These come first to avoid compiler errors on Boost 1.33.1/PETSc 2.2
00044 #include "AbstractCvodeCell.hpp"
00045 #include "AbstractCardiacCell.hpp"
00046 
00047 #include "AbstractModifier.hpp"
00048 #include "AbstractIvpOdeSolver.hpp"
00049 #include "AbstractStimulusFunction.hpp"
00050 
00055 template<class CARDIAC_CELL>
00056 class AbstractCardiacCellWithModifiers : public CARDIAC_CELL
00057 {
00058 private:
00060     std::map<std::string, boost::shared_ptr<AbstractModifier>* > mModifiersMap;
00061 
00062 protected:
00069     void AddModifier(std::string modifierName, boost::shared_ptr<AbstractModifier>& pModifier);
00070 
00071 public:
00083     AbstractCardiacCellWithModifiers(boost::shared_ptr<AbstractIvpOdeSolver> pOdeSolver,
00084                                      unsigned numberOfStateVariables,
00085                                      unsigned voltageIndex,
00086                                      boost::shared_ptr<AbstractStimulusFunction> pIntracellularStimulus);
00087 
00094     boost::shared_ptr<AbstractModifier> GetModifier(const std::string& rModifierName);
00095 
00103     bool HasModifier(const std::string& rModifierName) const;
00104 
00111     void SetModifier(const std::string& rModifierName, boost::shared_ptr<AbstractModifier>& pNewModifier);
00112 
00113 };
00114 
00115 #endif // ABSTRACTCARDIACCELLWITHMODIFIERS_HPP_