OpenTTD Source 20260421-master-gc2fbc6fdeb
BaseProvider< T > Class Template Reference
Inheritance diagram for BaseProvider< T >:
PriorityBaseProvider< T >

Data Structures

struct  ProviderSorter
 Sorter for BaseProvider. More...

Public Member Functions

constexpr BaseProvider (std::string_view name, std::string_view description)
 Create the provider.
virtual ~BaseProvider ()=default
 Ensure the destructor of the sub classes are called as well.
std::string_view GetName () const
 Get the name of this provider.
std::string_view GetDescription () const
 Get a description of this provider.

Protected Attributes

const std::string_view name
 The name of the provider.
const std::string_view description
 A description of the provider.

Detailed Description

template<typename T>
class BaseProvider< T >

Definition at line 54 of file provider_manager.h.

Constructor & Destructor Documentation

◆ BaseProvider()

template<typename T>
BaseProvider< T >::BaseProvider ( std::string_view name,
std::string_view description )
inlineconstexpr

Create the provider.

Parameters
nameThe name of the provider.
descriptionA description of the provider.

Definition at line 61 of file provider_manager.h.

References description, and name.

Referenced by PriorityBaseProvider< T >::PriorityBaseProvider().

Member Function Documentation

◆ GetDescription()

template<typename T>
std::string_view BaseProvider< T >::GetDescription ( ) const
inline

Get a description of this provider.

Returns
The description.

Definition at line 75 of file provider_manager.h.

References description.

◆ GetName()

template<typename T>
std::string_view BaseProvider< T >::GetName ( ) const
inline

Get the name of this provider.

Returns
Our name.

Definition at line 69 of file provider_manager.h.

References name.

Field Documentation

◆ description

template<typename T>
const std::string_view BaseProvider< T >::description
protected

A description of the provider.

Definition at line 93 of file provider_manager.h.

Referenced by BaseProvider(), GetDescription(), and PriorityBaseProvider< T >::PriorityBaseProvider().

◆ name

template<typename T>
const std::string_view BaseProvider< T >::name
protected

The name of the provider.

Definition at line 92 of file provider_manager.h.

Referenced by BaseProvider(), GetName(), and PriorityBaseProvider< T >::PriorityBaseProvider().


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