ome-xml  5.2.0
OMEModel.h
1 /*
2  * #%L
3  * OME-XML C++ library for working with OME-XML metadata structures.
4  * %%
5  * Copyright © 2006 - 2016 Open Microscopy Environment:
6  * - Massachusetts Institute of Technology
7  * - National Institutes of Health
8  * - University of Dundee
9  * - Board of Regents of the University of Wisconsin-Madison
10  * - Glencoe Software, Inc.
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  *
15  * 1. Redistributions of source code must retain the above copyright notice,
16  * this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright notice,
18  * this list of conditions and the following disclaimer in the documentation
19  * and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
25  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * The views and conclusions contained in the software and documentation are
34  * those of the authors and should not be interpreted as representing official
35  * policies, either expressed or implied, of any organization.
36  * #L%
37  */
38 
39 #ifndef OME_XML_MODEL_OMEMODEL_H
40 #define OME_XML_MODEL_OMEMODEL_H
41 
42 #include <map>
43 #include <string>
44 #include <vector>
45 
46 #include <ome/compat/memory.h>
47 
48 #include <ome/xml/model/OMEModelObject.h>
49 
50 namespace ome
51 {
52  namespace xml
53  {
54  namespace model
55  {
56 
57  class Reference;
58 
62  class OMEModel
63  {
64  public:
66  typedef std::vector<ome::compat::shared_ptr<Reference> > reference_list_type;
68  typedef std::map<std::string, ome::compat::shared_ptr<OMEModelObject> > object_map_type;
70  typedef std::map<ome::compat::shared_ptr<OMEModelObject>, reference_list_type> reference_map_type;
72  typedef reference_map_type::size_type size_type;
73 
74  protected:
77  {}
78 
79  public:
81  virtual
83  {}
84 
85  private:
87  OMEModel (const OMEModel&);
88 
90  OMEModel&
91  operator= (const OMEModel&);
92 
93  public:
107  virtual
108  ome::compat::shared_ptr<OMEModelObject>
109  addModelObject (const std::string& id,
110  ome::compat::shared_ptr<OMEModelObject>& object) = 0;
111 
120  virtual
121  ome::compat::shared_ptr<OMEModelObject>
122  removeModelObject (const std::string& id) = 0;
123 
134  virtual
135  ome::compat::shared_ptr<OMEModelObject>
136  getModelObject (const std::string& id) const = 0;
137 
143  virtual
144  const object_map_type&
145  getModelObjects () const = 0;
146 
162  virtual
163  bool
164  addReference (ome::compat::shared_ptr<OMEModelObject>& a,
165  ome::compat::shared_ptr<Reference>& b) = 0;
166 
172  virtual
173  const reference_map_type&
174  getReferences () const = 0;
175 
186  virtual
187  size_type
188  resolveReferences () = 0;
189 
190  };
191 
192  }
193  }
194 }
195 
196 #endif // OME_XML_MODEL_OMEMODEL_H
197 
198 /*
199  * Local Variables:
200  * mode:C++
201  * End:
202  */
OME model interface (abstract top-level container)
Definition: OMEModel.h:62
virtual const object_map_type & getModelObjects() const =0
Retrieve all model objects from the model.
OMEModel()
Constructor.
Definition: OMEModel.h:76
std::vector< ome::compat::shared_ptr< Reference > > reference_list_type
A list of Reference objects.
Definition: OMEModel.h:66
virtual ~OMEModel()
Destructor.
Definition: OMEModel.h:82
std::map< std::string, ome::compat::shared_ptr< OMEModelObject > > object_map_type
A map of string model object identifiers to model objects.
Definition: OMEModel.h:68
virtual ome::compat::shared_ptr< OMEModelObject > removeModelObject(const std::string &id)=0
Remove a model object from the model.
Open Microscopy Environment C++ implementation.
std::map< ome::compat::shared_ptr< OMEModelObject >, reference_list_type > reference_map_type
A map of model objects to list of Reference objects.
Definition: OMEModel.h:70
virtual bool addReference(ome::compat::shared_ptr< OMEModelObject > &a, ome::compat::shared_ptr< Reference > &b)=0
Add a reference to a model object.
OMEModel & operator=(const OMEModel &)
Assignment operator (deleted).
reference_map_type::size_type size_type
Size type for reference map.
Definition: OMEModel.h:72
virtual const reference_map_type & getReferences() const =0
Retrieve all references from the model.
virtual ome::compat::shared_ptr< OMEModelObject > getModelObject(const std::string &id) const =0
Retrieve a model object from the model.
virtual ome::compat::shared_ptr< OMEModelObject > addModelObject(const std::string &id, ome::compat::shared_ptr< OMEModelObject > &object)=0
Add a model object to the model.
virtual size_type resolveReferences()=0
Resolve all references.