21e9ac3801aaec50ea67e367e32bc6bdb3bca925
[cs356-p1-elevator.git] / stop.hpp
1 /*
2  * CS356 Project 01 -- Elevator Simulator
3  *
4  * Stop Class Specification
5  */
6
7 #ifndef STOP_HPP
8 #define STOP_HPP
9
10 #include "position.hpp"
11 #include "direction.hpp"
12
13 class Stop
14 {
15         public:
16                 /* PURPOSE: Construct a new Stop object, and set the floor and direction
17                  *
18                  * REQUIRE: Nothing
19                  *
20                  * PROMISE: A new Stop object will be created
21                  */
22                 Stop (int floor, enum direction mydirection);
23
24                 /*
25                  * PURPOSE: Check if this and another Stop object is equivalent
26                  *
27                  * REQUIRE: rhs is a valid Stop object
28                  *
29                  * PROMISE: Return true if this and rhs are equivalent, false otherwise
30                  */
31                 bool operator== (Stop& rhs);
32
33         private:
34                 /* Storage for the floor */
35                 Position _floor;
36
37                 /* Storage for the direction */
38                 enum direction _direction;
39 };
40
41 #endif /* STOP_HPP */
42
43 /* vim: set ts=4 sts=4 sw=4 noexpandtab textwidth=112: */