-
Notifications
You must be signed in to change notification settings - Fork 0
/
History.h
84 lines (71 loc) · 2.66 KB
/
History.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/* CSCI 200: Final Project
*
* Author: Alexander Capehart
* Resources used (Office Hours, Tutoring, Other Students, etc & in what capacity):
* - https://en.sfml-dev.org/forums/index.php?topic=10351.0 - Disable window resizing
* - https://cplusplus.com/reference/stack/stack/ - For stack usage
* - https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1VertexArray.php - For vertex array usage
* - https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1Vector2.php - For vector usage
* - https://cplusplus.com/reference/list/list/ - For list usage
* - https://stackoverflow.com/questions/34314892/high-cpu-usage-of-simple-program - To reduce CPU usage
* - https://www.sfml-dev.org/tutorials/2.5/graphics-draw.php - For vertex array and renderstates usage
* - https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1Rect.php - For rect usage
* - https://www.sfml-dev.org/documentation/2.5.1/classsf_1_1Drawable.php - For drawable implementation
* - https://cplusplus.com/doc/tutorial/other_data_types/ for enum creation/usage
* - Learned about for-each loops from Professor Paone
* - Confirmed proper project formatting from Professor Paone
*
* This program implements a game of klondike solitaire. This file implements the
* the the interface of the game history data structure.
*/
#ifndef HISTORY_H
#define HISTORY_H
#include <fstream>
#include <list>
#include <cmath>
#include "SolitaireInfo.h"
#include "Statistics.h"
/**
* @brief A log of past solitaire games
*/
class History final {
public:
/**
* @brief Create an uninitialized history instance
*/
History();
/**
* @brief Load the history from the expected "history.dat"
* file. Invalid entries are ignored
* @return true if the file was loaded successfully, false
* otherwise
*/
bool load();
/**
* @brief Add new game information to the history
* @param INFO The information to add
*/
void add( const SolitaireInfo INFO );
/**
* @brief Calculate statistics based on the history
* @return A set of calculated statistics
*/
Statistics getStatistics() const;
/**
* @brief Save the history to the expected "history.dat"
* file
* @return true if the file was saved successfully, false
* otherwise
*/
bool save() const;
private:
std::list<SolitaireInfo> mInfos;
/**
* @brief Attempt to read a solitaire info entry from the log
* @param logIn The input stream to the history file
* @param info The destination information data
* @return true if it was successfully read, false otherwise
*/
bool mLoadInfo( std::ifstream& historyIn, SolitaireInfo& info ) const;
};
#endif