Spinning Topp Logo BlackTopp Studios
inc
objectrange.h
Go to the documentation of this file.
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 /*
41  *
42  * Software, Files, Libraries and all other items referenced in this clause refers only
43  * to the contents of this file and associated documentation.
44  *
45  * Pugixml parser - version 1.0
46  * --------------------------------------------------------
47  * Copyright © 2006-2012, by Arseny Kapoulkine (arseny.kapoulkine@gmail.com)
48  * Report bugs and download new versions at http://pugixml.org/
49  *
50  * This library is distributed under the MIT License. See notice at the end
51  * of this file.
52  *
53  * This work is based on the pugxml parser, which is:
54  * Copyright © 2003, by Kristen Wegner (kristen@tima.net)
55  */
56 
57 #ifndef _xmlobjectrange_h
58 #define _xmlobjectrange_h
59 
60 /// @file
61 /// @brief Contains the implementation of the ObjectRange class template
62 
63 #include "datatypes.h"
64 
65 
66 
67 namespace Mezzanine
68 {
69  namespace XML
70  {
71  /// @brief Used by the xml system to pass around iterable ranges.
72  template <typename It> class ObjectRange
73  {
74  private:
75  /// @brief The iterator at the beginning of the range
76  It Begin;
77 
78  /// @brief The Iterator one past the end of the range
79  It End;
80 
81  public:
82 
83  /// @brief Used to get the template type
84  typedef It const_iterator;
85 
86  /// @brief Initializing constructor
87  /// @param InitBegin Default beginning of the range.
88  /// @param InitEnd Default end of the range.
89  ObjectRange(It InitBegin, It InitEnd): Begin(InitBegin), End(InitEnd)
90  { }
91 
92  /// @brief The Beginning of an iterable range
93  /// @return
94  It begin() const { return Begin; }
95 
96  /// @brief The end of an iterable range
97  /// @return
98  It end() const { return End; }
99  };
100  }
101 }// /namespace Mezzanine
102 
103 
104 
105 #endif // Include guard
106 
107 /*
108  *
109  * Software, Files, Libraries and all other items referenced in this clause refers only
110  * to the contents of this file and associated documentation.
111  *
112  * Copyright © 2006-2012 Arseny Kapoulkine
113  *
114  * Permission is hereby granted, free of charge, to any person
115  * obtaining a copy of this software and associated documentation
116  * files (the "Software"), to deal in the Software without
117  * restriction, including without limitation the rights to use,
118  * copy, modify, merge, publish, distribute, sublicense, and/or sell
119  * copies of the Software, and to permit persons to whom the
120  * Software is furnished to do so, subject to the following
121  * conditions:
122  *
123  * The above copyright notice and this permission notice shall be
124  * included in all copies or substantial portions of the Software.
125  *
126  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
127  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
128  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
129  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
130  * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
131  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
132  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
133  * OTHER DEALINGS IN THE SOFTWARE.
134  */
ObjectRange(It InitBegin, It InitEnd)
Initializing constructor.
Definition: objectrange.h:89
All the definitions for datatypes as well as some basic conversion functions are defined here...
Used by the xml system to pass around iterable ranges.
Definition: objectrange.h:72
It begin() const
The Beginning of an iterable range.
Definition: objectrange.h:94
It end() const
The end of an iterable range.
Definition: objectrange.h:98
It const_iterator
Used to get the template type.
Definition: objectrange.h:84
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56