diff --git a/include/BusFCFSStrategy.h b/include/BusFCFSStrategy.h index ab01db3..4b9964d 100644 --- a/include/BusFCFSStrategy.h +++ b/include/BusFCFSStrategy.h @@ -6,6 +6,9 @@ #define AUTO_BUS_GUI_BUS_FCFS_STRATEGY_H #include "BusStrategyBase.h" +/** + * 实现先来先服务策略的控制器类 + */ class BusFCFSStrategy : public BusStrategyBase { int GetBusDirection() override; diff --git a/include/BusSCANStrategy.h b/include/BusSCANStrategy.h index 3ef96c3..acdecc9 100644 --- a/include/BusSCANStrategy.h +++ b/include/BusSCANStrategy.h @@ -6,7 +6,9 @@ #define AUTO_BUS_GUI_BUS_SCAN_STRATEGY_H #include "BusStrategyBase.h" - +/** + * 实现顺便服务策略的控制器类 + */ class BusSCANStrategy : public BusStrategyBase { int GetBusDirection() override; diff --git a/include/BusSSTFStrategy.h b/include/BusSSTFStrategy.h index 0aed03f..fffc1db 100644 --- a/include/BusSSTFStrategy.h +++ b/include/BusSSTFStrategy.h @@ -6,6 +6,9 @@ #define AUTO_BUS_GUI_BUS_SSTF_STRATEGY_H #include "BusStrategyBase.h" +/** + * 实现最短寻找时间策略的控制器类 + */ class BusSSTFStrategy : public BusStrategyBase { int GetBusDirection() override; diff --git a/include/BusStrategyBase.h b/include/BusStrategyBase.h index 97d3477..0f4b145 100644 --- a/include/BusStrategyBase.h +++ b/include/BusStrategyBase.h @@ -13,6 +13,9 @@ #include "busModel.h" #include "Settings.h" +/** + * 策略控制基类 + */ class BusStrategyBase : public QObject { Q_OBJECT diff --git a/include/BusWidget.h b/include/BusWidget.h index 572784b..e5701aa 100644 --- a/include/BusWidget.h +++ b/include/BusWidget.h @@ -28,7 +28,9 @@ public: explicit BusItem(const QPixmap& pixmap); }; - +/** + * 公交车显示动画控制类 + */ class BusWidget { public: diff --git a/include/Settings.h b/include/Settings.h index e3b0093..fb95dc2 100644 --- a/include/Settings.h +++ b/include/Settings.h @@ -5,9 +5,15 @@ #ifndef AUTO_BUS_GUI_SETTINGS_H #define AUTO_BUS_GUI_SETTINGS_H +/** + * 设置控制类 + */ class Settings { public: + /** + * 设置每一tick的持续时间 + */ const static int tick = 2000; }; #endif //AUTO_BUS_GUI_SETTINGS_H diff --git a/include/StrategyFactory.h b/include/StrategyFactory.h index cf509fc..0644a2e 100644 --- a/include/StrategyFactory.h +++ b/include/StrategyFactory.h @@ -12,6 +12,9 @@ #include "BusSSTFStrategy.h" #include "BusSCANStrategy.h" +/** + * 策略控制对象工厂类 + */ class StrategyFactory { public: diff --git a/include/define.h b/include/define.h index 75a5664..4f4f9d3 100644 --- a/include/define.h +++ b/include/define.h @@ -12,7 +12,7 @@ #define BUS_FCFS 0 // 先来先服务 #define BUS_SSTF 1 // 最短寻找时间优先 #define BUS_SCAN 2 // 顺便服务 -#define BUS_RUNNING 0 -#define BUS_END 2 +#define BUS_RUNNING 0 // 公交车运行状态 +#define BUS_END 2 // 公交车停止状态 #endif //AUTO_BUS_GUI_DEFINE_H diff --git a/include/queryModel.h b/include/queryModel.h index 331f123..b901182 100644 --- a/include/queryModel.h +++ b/include/queryModel.h @@ -6,6 +6,9 @@ #define AUTO_BUS_GUI_QUERY_MODEL_H #include "railsModel.h" +/** + * 表示一个请求的结构体 + */ struct bus_query { /** * 请求产生的时间 @@ -30,6 +33,9 @@ struct bus_query { typedef struct bus_query bus_query_t; +/** + * 公交车请求控制类 + */ class QueryModel { public: diff --git a/include/railsModel.h b/include/railsModel.h index 6330598..96a23b2 100644 --- a/include/railsModel.h +++ b/include/railsModel.h @@ -6,6 +6,9 @@ #define AUTO_BUS_GUI_RAILS_MODEL_H #include "cstdlib" +/** + * 站点结构体 + */ struct rail_node{ /** * 站点的编号 @@ -35,6 +38,9 @@ struct rail_node{ typedef struct rail_node rail_node_t; +/** + * 轨道站点控制类 + */ class RailsModel { diff --git a/src/header/centralwidget.h b/src/header/centralwidget.h index 6293c2e..c3a1b45 100644 --- a/src/header/centralwidget.h +++ b/src/header/centralwidget.h @@ -23,6 +23,9 @@ namespace Ui } QT_END_NAMESPACE +/** + * 主框架的策略控制类 + */ class CentralWidget : public QWidget { Q_OBJECT diff --git a/src/header/mainwindow.h b/src/header/mainwindow.h index d8e461d..a831c90 100644 --- a/src/header/mainwindow.h +++ b/src/header/mainwindow.h @@ -22,6 +22,9 @@ namespace Ui } QT_END_NAMESPACE +/** + * 主窗口的策略控制类 + */ class MainWindow : public QMainWindow { Q_OBJECT