Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
Classes | Macros
Singleton.hxx File Reference
#include "utils/macros.h"

Go to the source code of this file.

Classes

class  Singleton< T >
 Singleton class. More...
 

Macros

#define DEFINE_SINGLETON_INSTANCE(T)   template<> T* Singleton<T>::instance_ = nullptr
 Helper macro the the customer may (but is not required to) use for ensuring that the singleton instance is found by the linker.
 

Detailed Description

Copyright
Copyright (c) 2013, Balazs Racz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Utility class to ensure a particular class has only a single object, and access it via a static reference.

Author
Balazs Racz
Date
19 July 2013

Definition in file Singleton.hxx.

Macro Definition Documentation

◆ DEFINE_SINGLETON_INSTANCE

#define DEFINE_SINGLETON_INSTANCE (   T)    template<> T* Singleton<T>::instance_ = nullptr

Helper macro the the customer may (but is not required to) use for ensuring that the singleton instance is found by the linker.

Must appear in a single .cxx file.

Parameters
Tthe class name that is a Singleton.

Definition at line 98 of file Singleton.hxx.