CellPropertyCollection.hpp

/*

Copyright (C) University of Oxford, 2005-2011

University of Oxford means the Chancellor, Masters and Scholars of the
University of Oxford, having an administrative office at Wellington
Square, Oxford OX1 2JD, UK.

This file is part of Chaste.

Chaste is free software: you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation, either version 2.1 of the License, or
(at your option) any later version.

Chaste is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
License for more details. The offer of Chaste under the terms of the
License is subject to the License being interpreted in accordance with
English Law and subject to any action against the University of Oxford
being under the jurisdiction of the English Courts.

You should have received a copy of the GNU Lesser General Public License
along with Chaste. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef CELLPROPERTYCOLLECTION_HPP_
#define CELLPROPERTYCOLLECTION_HPP_

#include <set>
#include <boost/shared_ptr.hpp>

#include "ChasteSerialization.hpp"
#include <boost/serialization/shared_ptr.hpp>
#include <boost/serialization/set.hpp>

#include "AbstractCellProperty.hpp"
#include "CellPropertyRegistry.hpp"
#include "Exception.hpp"

class CellPropertyCollection
{
private:
    typedef std::set<boost::shared_ptr<AbstractCellProperty> > CollectionType;

    typedef CollectionType::const_iterator ConstIteratorType;

    typedef CollectionType::iterator IteratorType;

    CollectionType mProperties;

    CellPropertyRegistry* mpCellPropertyRegistry;

    friend class boost::serialization::access;
    template<class Archive>
    void serialize(Archive & archive, const unsigned int version)
    {
        archive & mProperties;
        // archive & mpCellPropertyRegistry; Not required as archived by the CellPopulation.
    }

public:
    CellPropertyCollection();

    void AddProperty(const boost::shared_ptr<AbstractCellProperty>& rProp);

    CellPropertyRegistry* GetCellPropertyRegistry();

    void SetCellPropertyRegistry(CellPropertyRegistry* pRegistry);

    bool HasProperty(const boost::shared_ptr<AbstractCellProperty>& rProp) const;

    template<typename CLASS>
    bool HasProperty() const
    {
        for (ConstIteratorType it = mProperties.begin(); it != mProperties.end(); ++it)
        {
            if ((*it)->IsType<CLASS>())
            {
                return true;
            }
        }
        return false;
    }

    template<typename BASECLASS>
    bool HasPropertyType() const
    {
        for (ConstIteratorType it = mProperties.begin(); it != mProperties.end(); ++it)
        {
            if ((*it)->IsSubType<BASECLASS>())
            {
                return true;
            }
        }
        return false;
    }

    template<typename CLASS>
    void RemoveProperty()
    {
        for (IteratorType it = mProperties.begin(); it != mProperties.end(); ++it)
        {
            if ((*it)->IsType<CLASS>())
            {
                mProperties.erase(it);
                return;
            }
        }
        EXCEPTION("Collection does not contain the given property type.");
    }

    void RemoveProperty(const boost::shared_ptr<AbstractCellProperty>& rProp);

    unsigned GetSize() const;

    typedef CollectionType::iterator Iterator;

    Iterator Begin();

    Iterator End();

    boost::shared_ptr<AbstractCellProperty> GetProperty() const;

    template<typename CLASS>
    CellPropertyCollection GetProperties() const
    {
        CellPropertyCollection result;
        for (ConstIteratorType it = mProperties.begin(); it != mProperties.end(); ++it)
        {
            if ((*it)->IsType<CLASS>())
            {
                result.AddProperty(*it);
            }
        }
        return result;
    }

    template<typename BASECLASS>
    CellPropertyCollection GetPropertiesType() const
    {
        CellPropertyCollection result;
        for (ConstIteratorType it = mProperties.begin(); it != mProperties.end(); ++it)
        {
            if ((*it)->IsSubType<BASECLASS>())
            {
                result.AddProperty(*it);
            }
        }
        return result;
    }
};

#endif /* CELLPROPERTYCOLLECTION_HPP_ */