Chaste Release::3.1
AbstractCellProperty.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 ABSTRACTCELLPROPERTY_HPP_
00037 #define ABSTRACTCELLPROPERTY_HPP_
00038 
00039 #include <boost/shared_ptr.hpp>
00040 #include "ChasteSerialization.hpp"
00041 #include "Identifiable.hpp"
00042 
00049 class AbstractCellProperty : public Identifiable
00050 {
00051 private:
00052 
00056     unsigned mCellCount;
00057 
00059     friend class boost::serialization::access;
00066     template<class Archive>
00067     void serialize(Archive & archive, const unsigned int version)
00068     {
00069         archive & mCellCount;
00070     }
00071 
00072 public:
00076     AbstractCellProperty();
00077 
00081     virtual ~AbstractCellProperty();
00082 
00094     template<class CLASS>
00095     bool IsType() const
00096     {
00097         CLASS ref_obj;
00098         return IsSame(&ref_obj);
00099     }
00100 
00108     template<class BASECLASS>
00109     bool IsSubType() const
00110     {
00111         // We put a const_cast in here so users don't have to worry about whether the
00112         // property object they are testing is const or not.
00113         BASECLASS* p_subclass = dynamic_cast<BASECLASS*>(const_cast<AbstractCellProperty*>(this));
00114         return (p_subclass != NULL);
00115     }
00116 
00121     bool IsSame(const AbstractCellProperty* pOther) const;
00122 
00127     bool IsSame(boost::shared_ptr<const AbstractCellProperty> pOther) const;
00128 
00132     void IncrementCellCount();
00133 
00137     void DecrementCellCount();
00138 
00142     unsigned GetCellCount() const;
00143 
00144 };
00145 
00146 #endif /* ABSTRACTCELLPROPERTY_HPP_ */