Chaste  Release::2018.1
CellPropertyCollection.cpp
1 /*
2 
3 Copyright (c) 2005-2018, University of Oxford.
4 All rights reserved.
5 
6 University of Oxford means the Chancellor, Masters and Scholars of the
7 University of Oxford, having an administrative office at Wellington
8 Square, Oxford OX1 2JD, UK.
9 
10 This file is part of Chaste.
11 
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
14  * Redistributions of source code must retain the above copyright notice,
15  this list of conditions and the following disclaimer.
16  * Redistributions in binary form must reproduce the above copyright notice,
17  this list of conditions and the following disclaimer in the documentation
18  and/or other materials provided with the distribution.
19  * Neither the name of the University of Oxford nor the names of its
20  contributors may be used to endorse or promote products derived from this
21  software without specific prior written permission.
22 
23 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 
34 */
35 
36 #include "CellPropertyCollection.hpp"
37 
39  : mpCellPropertyRegistry(nullptr)
40 {
41 }
42 
44 {
46  {
47  /*
48  * If no cell population has taken ownership of the registry and assigned
49  * this class a pointer, then store a pointer to the singleton.
50  */
52  }
54 }
55 
57 {
58  mpCellPropertyRegistry = pRegistry;
59 }
60 
61 void CellPropertyCollection::AddProperty(const boost::shared_ptr<AbstractCellProperty>& rProp)
62 {
63  if (HasProperty(rProp))
64  {
65  EXCEPTION("That property object is already in the collection.");
66  }
67  mProperties.insert(rProp);
68 }
69 
70 bool CellPropertyCollection::HasProperty(const boost::shared_ptr<AbstractCellProperty>& rProp) const
71 {
72  return (mProperties.find(rProp) != mProperties.end());
73 }
74 
75 void CellPropertyCollection::RemoveProperty(const boost::shared_ptr<AbstractCellProperty>& rProp)
76 {
77  IteratorType it = mProperties.find(rProp);
78  if (it == mProperties.end())
79  {
80  EXCEPTION("Collection does not contain the given property.");
81  }
82  else
83  {
84  mProperties.erase(it);
85  }
86 }
87 
89 {
90  return mProperties.size();
91 }
92 
94 {
95  return mProperties.begin();
96 }
97 
99 {
100  return mProperties.end();
101 }
102 
103 boost::shared_ptr<AbstractCellProperty> CellPropertyCollection::GetProperty() const
104 {
105  if (GetSize() == 1)
106  {
107  return *mProperties.begin();
108  }
109  else
110  {
111  EXCEPTION("Can only call GetProperty on a collection of size 1.");
112  }
113 }
CollectionType::iterator IteratorType
CollectionType::iterator Iterator
boost::shared_ptr< AbstractCellProperty > GetProperty() const
#define EXCEPTION(message)
Definition: Exception.hpp:143
CellPropertyRegistry * mpCellPropertyRegistry
static CellPropertyRegistry * Instance()
void SetCellPropertyRegistry(CellPropertyRegistry *pRegistry)
void AddProperty(const boost::shared_ptr< AbstractCellProperty > &rProp)
CellPropertyRegistry * GetCellPropertyRegistry()