openfluid::utils::KillableSingleton< T > Class Template Reference

Detailed Description

template<typename T>
class openfluid::utils::KillableSingleton< T >

Singleton template class implementing a killable singleton design. This implementation is not thread safe.

Warning

This template class does not work in a cross-dll context on Windows. Due to this restriction, it MUST NOT BE USED in the OpenFLUID framework.

Example of use to design an Example class as a killable singleton

#include <openfluid/utils/KillableSingleton.hpp>
 
class ExampleKillable : public openfluid::utils::KillableSingleton<ExampleKillable>
{
  friend class openfluid::utils::KillableSingleton<ExampleKillable>;
 
  private:
 
    ExampleKillable();
 
    ~ExampleKillable();
 
 
  public:
 
    // some public members
};

#include <utils/KillableSingleton.hpp>

Static Public Member Functions
static T *	instance ()
static void	kill ()

Protected Member Functions
	KillableSingleton ()=default
	~KillableSingleton ()

Static Protected Attributes
static T *	mp_Instance

Constructor & Destructor Documentation

KillableSingleton()

template<typename T >

openfluid::utils::KillableSingleton< T >::KillableSingleton ( )

protecteddefault

~KillableSingleton()

template<typename T >

openfluid::utils::KillableSingleton< T >::~KillableSingleton ( )

inlineprotected

Member Function Documentation

instance()

template<typename T >

static T* openfluid::utils::KillableSingleton< T >::instance ( )

inlinestatic

Returns a pointer to the singleton object. Instantiates the class if it not has not been instantiated before or it has been killed before.

Returns

A pointer to the singleton object

kill()

template<typename T >

static void openfluid::utils::KillableSingleton< T >::kill ( )

inlinestatic

Kills the singleton class

Member Data Documentation

mp_Instance

template<typename T >

T * openfluid::utils::KillableSingleton< T >::mp_Instance

staticprotected

---

The documentation for this class was generated from the following file:

• utils/KillableSingleton.hpp