ThemeMetric< T > Class Template Reference

The theme specific data. More...

#include <ThemeMetric.h>

Inheritance diagram for ThemeMetric< T >:

Collaboration diagram for ThemeMetric< T >:

Public Member Functions
	ThemeMetric (std::string sGroup="", std::string sName="")
	ThemeMetric (const ThemeMetric< T > &cpy)
void	Load (const std::string &sGroup, const std::string &sName)
	Load the chosen metric from the .ini file.
void	ChangeGroup (const std::string &sGroup)
void	Read () override
	Actually read the metric and get its data.
void	PushSelf (Lua *L)
void	Clear () override
auto	GetName () const -> const std::string &
	Retrieve the metric's name.
auto	GetGroup () const -> const std::string &
	Retrieve the metric's group.
auto	GetValue () const -> const T &
	Retrieve the metric's value.
	operator const T & () const
auto	IsLoaded () const -> bool
auto	operator== (const T &input) const -> bool

Protected Attributes
std::string	m_sGroup
	the metric's group.
std::string	m_sName
	the metric's name.
LuaReference	m_Value
	the metric's value.
T	m_currentValue
bool	m_bCallEachTime { false }

Detailed Description

template<class T>
class ThemeMetric< T >

The theme specific data.

Each piece of data is to correspond to a type.

Member Function Documentation

Clear()

template<class T >

void ThemeMetric< T >::Clear ( )

inlineoverridevirtual

Implements IThemeMetric.

GetGroup()

template<class T >

auto ThemeMetric< T >::GetGroup ( ) const -> const std::string&

inline

Retrieve the metric's group.

Returns

the metric's group.

GetName()

template<class T >

auto ThemeMetric< T >::GetName ( ) const -> const std::string&

inline

Retrieve the metric's name.

Returns

the metric's name.

GetValue()

template<class T >

auto ThemeMetric< T >::GetValue ( ) const -> const T&

inline

Retrieve the metric's value.

Returns

the metric's value.

Load()

template<class T >

void ThemeMetric< T >::Load ( const std::string &  sGroup, const std::string &  sName  )

inline

Load the chosen metric from the .ini file.

Parameters

sGroup	the group the metric is in.
sName	the name of the metric.

Read()

template<class T >

void ThemeMetric< T >::Read ( )

inlineoverridevirtual

Actually read the metric and get its data.

Implements IThemeMetric.

Reimplemented in ThemeMetricDifficultiesToShow, and ThemeMetricStepsTypesToShow.

Member Data Documentation

m_sGroup

template<class T >

std::string ThemeMetric< T >::m_sGroup

protected

the metric's group.

In metrics.ini, it is usually done as such: [GroupName]

---

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

• /home/runner/work/etterna/etterna/src/Etterna/Models/Misc/ThemeMetric.h