generated from kitswas/CPP-project-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
173 lines (171 loc) · 8.24 KB
/
index.html
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
<!-- HTML header for doxygen 1.9.7-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Scheduler Sim: A CPU Scheduling Algorithm Simulator in C++</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-custom.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript">
DoxygenAwesomeFragmentCopyButton.init()
</script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Scheduler Sim
</div>
<div id="projectbrief">A CPU Scheduling Algorithm Simulator in C++.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">A CPU Scheduling Algorithm <a class="el" href="classSimulator.html">Simulator</a> in C++ </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_README"></a> This repository was a part of my undergraduate coursework. <br />
It has now been made open-source under the MIT License.</p>
<p>The project simulates the execution of processes on a CPU.</p>
<h1><a class="anchor" id="usage"></a>
Usage</h1>
<p>Follow the on-screen prompts to provide input. <br />
The program creates two files:</p>
<ol type="1">
<li><code>processes.txt</code> - Contains the final results when the simulation completes. <br />
An empty file indicates that no processes have completed execution. Run the program again with a higher simulation time.</li>
<li><code>status.txt</code> - Logs the events _(arrival, execution, completion, etc. of processes)_ in the simulator.</li>
</ol>
<h1><a class="anchor" id="design"></a>
Design</h1>
<p>There are 3 types of schedulers implemented in this project:</p>
<ol type="1">
<li>First Come First Serve (<a class="el" href="classFCFS.html">FCFS</a>)</li>
<li>Round Robin (<a class="el" href="classRR.html">RR</a>)</li>
<li>Completely Fair <a class="el" href="classScheduler.html" title="Abstract class for all scheduler types.">Scheduler</a> (<a class="el" href="classCFS.html">CFS</a>)</li>
</ol>
<p>The project uses a <a href="https://en.wikipedia.org/wiki/Strategy_pattern">Strategy Pattern</a> to implement the schedulers.</p>
<h1><a class="anchor" id="setting-up-your-workspace"></a>
Setting up your workspace</h1>
<p>This project has a <a href="https://editorconfig.org/">.editorconfig file</a> to enforce project level coding standards. <br />
CLion has built-in support, VSCode requires <a href="https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig">a plugin</a>.</p>
<h1><a class="anchor" id="how-to-run"></a>
How to run</h1>
<p>This project requires <a href="https://cmake.org/">CMake</a> to build. Your IDE (VSCode or CLion) should automatically detect the CMakeLists.txt file and build the project. Install extensions for CMake support if prompted. <br />
If you are using the command line, you can run the following commands:</p>
<div class="fragment"><div class="line">cmake -B build</div>
<div class="line">cmake --build build --config Debug</div>
</div><!-- fragment --><p>Then execute the following commands to run the program:</p>
<p>Windows:</p>
<div class="fragment"><div class="line">.\build\executable</div>
</div><!-- fragment --><p>Linux:</p>
<div class="fragment"><div class="line">./build/executable</div>
</div><!-- fragment --><h1><a class="anchor" id="generating-documentation"></a>
Generating Documentation</h1>
<p>This project uses <a href="https://www.doxygen.nl/index.html">Doxygen</a> to generate documentation. <br />
If Doxygen is available on your system, <br />
You can generate the documentation by running the following command:</p>
<div class="fragment"><div class="line">doxygen Doxyfile</div>
</div><!-- fragment --><p>Once done, you can open the generated documentation by opening the <a href="docs/index.html"><code>docs/index.html</code></a> file in your browser.</p>
<p>This repository has automated workflow via Github Actions. Documentation is auto-generated. <br />
Disable Actions on your own fork or delete the <a href="./.github/workflows">workflows</a> folder if you do not want to be billed. <br />
This is <b>not my responsiblity.</b> </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>