Files
StorytellersBestFriend/sbf-cpp/Ranks.h
Tom Hicks 5501de76e2 Adds doxygen comments to SBF namespace.
Adds doxygen header to header files.
2023-04-16 04:08:33 -07:00

40 lines
1.2 KiB
C++

#ifndef RANKS_H__
#define RANKS_H__
/***************************************************************************************
* @file Ranks.h
*
* @brief Defines constants and functions for working with ranks.
* @copyright
* Copyright 2023 Tom Hicks
* Licensed under the MIT license see the LICENSE file for details.
***************************************************************************************/
#include <string>
#include <vector>
/** \addtogroup
* @{
*/
namespace SBF {
const int kRankPrimaryId = 1;
const std::string kRankPrimaryLabel = "Primary";
const int kRankSecondaryId = 2;
const std::string kRankSecondaryLabel = "Secondary";
const int kRankTertiaryId = 3;
const std::string kRankTertiaryLabel = "Tertiary";
const int kRanksCount = 3;
struct RankType {
int id;
std::string label;
};
const RankType kRanks[] {
{0, ""},
{kRankPrimaryId, kRankPrimaryLabel},
{kRankSecondaryId, kRankSecondaryLabel},
{kRankTertiaryId, kRankTertiaryLabel},
};
const RankType& GetRank(int rankId);
void FillRanks(std::vector<RankType> ranks);
} // End namespace SBF
/** @}*/
#endif // !defined RANKS_H__