FireSTARR
Loading...
Searching...
No Matches
fs::Score Class Reference

The WeatherSHIELD score for a specific year. More...

#include <Score.h>

Public Member Functions

constexpr MathSize average () const noexcept
 Average match percentage for the year.
 
constexpr MathSize grade () const noexcept
 Grade for this year.
 
constexpr YearSize year () const noexcept
 Year this Score is for.
 
constexpr Score (const YearSize year, const MathSize average, const MathSize grade) noexcept
 Constructor.
 

Private Attributes

MathSize average_
 Average match percentage for the year.
 
MathSize grade_
 Grade for this year.
 
YearSize year_
 Year this Score is for.
 

Detailed Description

The WeatherSHIELD score for a specific year.

Constructor & Destructor Documentation

◆ Score()

fs::Score::Score ( const YearSize year,
const MathSize average,
const MathSize grade )
inlineconstexprnoexcept

Constructor.

Parameters
yearYear Score is from
averageAverage match percentage
gradeCalculated grade

Member Function Documentation

◆ average()

MathSize fs::Score::average ( ) const
inlinenodiscardconstexprnoexcept

Average match percentage for the year.

Returns
Average match percentage for the year

◆ grade()

MathSize fs::Score::grade ( ) const
inlinenodiscardconstexprnoexcept

Grade for this year.

Returns
Grade for this year

◆ year()

YearSize fs::Score::year ( ) const
inlinenodiscardconstexprnoexcept

Year this Score is for.

Returns
Year this Score is for

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