Gobelijn API documentation  - generated for commit a0cbea7
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
AbstractFactory::ConstantFactory< TResult, TArgs > Class Template Reference

A factory class template that always returns a constant, pre-defined value. More...

#include <constant-factory.h>

Inheritance diagram for AbstractFactory::ConstantFactory< TResult, TArgs >:
Inheritance graph
Collaboration diagram for AbstractFactory::ConstantFactory< TResult, TArgs >:
Collaboration graph

Public Member Functions

 ConstantFactory (const TResult &value)
 Creates a factory that always produces the given value. More...
 
TResult Create (TArgs...) final
 Instructs this factory to create a value. More...
 
virtual ~ConstantFactory ()=default
 
- Public Member Functions inherited from AbstractFactory::Factory< TResult, TArgs...>
virtual ~Factory ()
 Destructor needs to be virtual. More...
 

Private Attributes

TResult m_value
 

Detailed Description

template<typename TResult, typename... TArgs>
class AbstractFactory::ConstantFactory< TResult, TArgs >

A factory class template that always returns a constant, pre-defined value.

Any arguments are always discarded.

Definition at line 29 of file constant-factory.h.

Constructor & Destructor Documentation

template<typename TResult, typename... TArgs>
AbstractFactory::ConstantFactory< TResult, TArgs >::ConstantFactory ( const TResult &  value)
inline

Creates a factory that always produces the given value.

Definition at line 33 of file constant-factory.h.

template<typename TResult, typename... TArgs>
virtual AbstractFactory::ConstantFactory< TResult, TArgs >::~ConstantFactory ( )
virtualdefault

Member Function Documentation

template<typename TResult, typename... TArgs>
TResult AbstractFactory::ConstantFactory< TResult, TArgs >::Create ( TArgs...  )
inlinefinalvirtual

Instructs this factory to create a value.

Implements AbstractFactory::Factory< TResult, TArgs...>.

Definition at line 36 of file constant-factory.h.

References AbstractFactory::ConstantFactory< TResult, TArgs >::m_value.

Member Data Documentation

template<typename TResult, typename... TArgs>
TResult AbstractFactory::ConstantFactory< TResult, TArgs >::m_value
private

Definition at line 42 of file constant-factory.h.

Referenced by AbstractFactory::ConstantFactory< TResult, TArgs >::Create().

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