singleton.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef PXR_BASE_TF_SINGLETON_H
25 #define PXR_BASE_TF_SINGLETON_H
26 
104 
105 #include "pxr/pxr.h"
106 
107 #include <atomic>
108 
109 PXR_NAMESPACE_OPEN_SCOPE
110 
118 template <class T>
119 class TfSingleton {
120 public:
134  inline static T& GetInstance() {
135  T *p = _instance.load();
136  if (!p) {
137  p = _CreateInstance(_instance);
138  }
139  return *p;
140  }
141 
146  inline static bool CurrentlyExists() {
147  return static_cast<bool>(_instance.load());
148  }
149 
168  inline static void SetInstanceConstructed(T& instance);
169 
178  inline static void DeleteInstance();
179 
180 private:
181  static T *_CreateInstance(std::atomic<T *> &instance);
182 
183  static std::atomic<T *> _instance;
184 };
185 
186 PXR_NAMESPACE_CLOSE_SCOPE
187 
188 #endif
Manage a single instance of an object (see.
Definition: singleton.h:119
static void SetInstanceConstructed(T &instance)
Indicate that the sole instance object has already been created.
static T & GetInstance()
Return a reference to an object of type T, creating it if necessary.
Definition: singleton.h:134
static bool CurrentlyExists()
Return whether or not the single object of type T is currently in existence.
Definition: singleton.h:146
static void DeleteInstance()
Destroy the sole instance object of type T, if it exists.