OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
OgreNameGenerator.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2014 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __NameGenerator_H__
29 #define __NameGenerator_H__
30 
31 #include "OgreString.h"
32 
33 #if defined ( OGRE_GCC_VISIBILITY )
34 # pragma GCC visibility push(default)
35 #endif
36 
37 #include <sstream>
38 
39 #if defined ( OGRE_GCC_VISIBILITY )
40 # pragma GCC visibility pop
41 #endif
42 
43 #include "OgreHeaderPrefix.h"
44 
46 
47 namespace Ogre {
55  class _OgreExport NameGenerator
57  {
58  protected:
60  unsigned long long int mNext;
62  public:
64  : mPrefix(rhs.mPrefix), mNext(rhs.mNext) {}
65 
66  NameGenerator(const String& prefix) : mPrefix(prefix), mNext(1) {}
67 
70  {
72  StringStream s;
73  s << mPrefix << mNext++;
74  return s.str();
75  }
76 
78  void reset()
79  {
81  mNext = 1ULL;
82  }
83 
85  void setNext(unsigned long long int val)
86  {
88  mNext = val;
89  }
90 
92  unsigned long long int getNext() const
93  {
94  // lock even on get because 64-bit may not be atomic read
96  return mNext;
97  }
98  };
99 
102 }
103 
104 #include "OgreHeaderSuffix.h"
105 
106 #endif
#define _OgreExport
Definition: OgrePlatform.h:255
Utility class to generate a sequentially numbered series of names.
NameGenerator(const String &prefix)
_StringStreamBase StringStream
#define OGRE_LOCK_AUTO_MUTEX
unsigned long long int getNext() const
Get the internal counter.
unsigned long long int mNext
_StringBase String
Definition: OgreCommon.h:53
void reset()
Reset the internal counter.
NameGenerator(const NameGenerator &rhs)
String generate()
Generate a new name.
void setNext(unsigned long long int val)
Manually set the internal counter (use caution)