inholland/ros2-assignments
3
1
Fork 0
generated from wessel/boilerplate
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(documentation): Rename ALL node mentions to TILMANN naming conventions

Browse Source
This commit is contained in:
Vincent Kompjoeteraar Winter
2025-10-09 21:49:12 +02:00
parent fbb3600c2c
commit a019e9033b
16 changed files with 50 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/architecture/nodes/ExamResultGenerator.md
View File

@@ -1,4 +1,4 @@
# ExamResultGenerator (`assignments::one::exam_result_generator`)
# ExamResultGenerator (`assignments::one::g2_2025_exam_result_generator_node`)
## Overview
The `ExamResultGenerator` is the core node responsible for simulating exam result generation.
@@ -15,7 +15,7 @@ grades, and publishes them to the system.
```cpp
ExamResultGenerator()
```
- Initializes ROS2 node with name `exam_result_generator`
- Initializes ROS2 node with name `g2_2025_exam_result_generator_node`
- Sets up random number generation infrastructure
- Creates DatabaseManager instance with node logger
- Establishes ROS2 publishers, subscribers, and timers
@@ -33,7 +33,7 @@ ExamResultGenerator()
- Selects random student-course combination from queue
- Stores result in database and publishes to ROS2 topic
**`void student_management_callback(const g2_2025_interfaces::msg::Student::SharedPtr msg)`**
**`void student_management_callback(const g2_2025_assign1_interfaces_pkg::msg::Student::SharedPtr msg)`**
- Toggles combinations in/out of processing queue
- Updates database with new enrollments

8
doc/architecture/nodes/FinalGradeDeterminator.md
View File

@@ -1,4 +1,4 @@
# FinalGradeDeterminator (`assignments::one::final_grade_determinator`)
# FinalGradeDeterminator (`assignments::one::g2_2025_final_grade_determinator_node`)
## Overview
The `FinalGradeDeterminator` node collects exam results for student-course combinations, triggers grade calculation when enough results are gathered, and stores final grades in the database. It interacts with ROS2 publishers, subscribers, and service clients to manage the grading workflow.
@@ -13,7 +13,7 @@ The `FinalGradeDeterminator` node collects exam results for student-course combi
```cpp
FinalGradeDeterminator()
```
- Initializes ROS2 node with name `final_grade_determinator`
- Initializes ROS2 node with name `g2_2025_final_grade_determinator_node`
- Declares and retrieves `grade_collection_amount` parameter
- Sets up `DatabaseManager`
- Creates publisher for student course management
@@ -22,7 +22,7 @@ FinalGradeDeterminator()
**Core Functions**
**`void exam_results_callback(const g2_2025_interfaces::msg::Exam::SharedPtr msg)`**
**`void exam_results_callback(const g2_2025_assign1_interfaces_pkg::msg::Exam::SharedPtr msg)`**
- Updates internal map with received exam result for student-course combo
- Checks if enough results have been collected
- Triggers grade calculation request when threshold is met
@@ -32,7 +32,7 @@ FinalGradeDeterminator()
- Sends async request with collected exam grades for the student-course combination
- Uses callback to handle service response
**`void grade_calculator_response(rclcpp::Client<g2_2025_interfaces::srv::Exams>::SharedFuture future, StudentCourse studentCourseCombo)`**
**`void grade_calculator_response(rclcpp::Client<g2_2025_assign1_interfaces_pkg::srv::Exams>::SharedFuture future, StudentCourse studentCourseCombo)`**
- Verifies database connection
- Publishes final student message to ROS2 topic
- Logs final grade information

4
doc/architecture/nodes/GradeCalculator.md
View File

@@ -1,4 +1,4 @@
# GradeCalculator (`assignments::one::grade_calculator::GradeCalculator`)
# GradeCalculator (`assignments::one::g2_2025_grade_calculator_node::GradeCalculator`)
## Overview
The `GradeCalculator` node provides a ROS2 service for calculating student exam grades. It processes exam scores, applies custom logic for specific student names, and ensures grade results are within valid bounds.
@@ -9,7 +9,7 @@ The `GradeCalculator` node provides a ROS2 service for calculating student exam
```cpp
GradeCalculator()
```
- Initializes ROS2 node with name `grade_calculator`
- Initializes ROS2 node with name `g2_2025_grade_calculator_node`
- Creates a ROS2 service server for `grade_calculator_service`
- Binds the service callback to handle grade calculation requests
- Logs service startup

16
doc/architecture/nodes/RetakeGradeDeterminator.md
View File

@@ -1,4 +1,4 @@
# RetakeGradeDeterminator (`assignments::one::retake_grade_determinator`)
# RetakeGradeDeterminator (`assignments::one::g2_2025_retake_grade_determinator_node`)
## Overview
The `RetakeGradeDeterminator` node handles the processing of retake exams for students who have
@@ -16,7 +16,7 @@ final retake grades.
```cpp
RetakeGradeDeterminator(std::unique_ptr<DatabaseManager> db_manager = nullptr)
```
- Initializes ROS2 node with name `retake_grade_determinator`
- Initializes ROS2 node with name `g2_2025_retake_grade_determinator_node`
- Sets up `DatabaseManager` (optional injection for testing)
- Creates publisher for student course management
- Subscribes to exam results topic with retake-specific callback
@@ -25,7 +25,7 @@ RetakeGradeDeterminator(std::unique_ptr<DatabaseManager> db_manager = nullptr)
**Core Functions**
**`void exam_results_callback(const g2_2025_interfaces::msg::Exam::SharedPtr msg)`**
**`void exam_results_callback(const g2_2025_assign1_interfaces_pkg::msg::Exam::SharedPtr msg)`**
- Only processes exam results when `retake_allowed_` flag is true
- Triggers grade calculation request when threshold is met
@@ -33,7 +33,7 @@ RetakeGradeDeterminator(std::unique_ptr<DatabaseManager> db_manager = nullptr)
- Waits for grade calculator service to be available
- Sends async request with collected retake exam grades
**`void grade_calculator_response(rclcpp::Client<g2_2025_interfaces::srv::Exams>::SharedFuture future, StudentCourse studentCourseCombo)`**
**`void grade_calculator_response(rclcpp::Client<g2_2025_assign1_interfaces_pkg::srv::Exams>::SharedFuture future, StudentCourse studentCourseCombo)`**
- Clears collected exam data from internal map
- Updates retake status in database for the student-course combination
- Publishes final student message to ROS2 topic with timestamp
@@ -41,20 +41,20 @@ RetakeGradeDeterminator(std::unique_ptr<DatabaseManager> db_manager = nullptr)
**Action Server Callbacks**
**`rclcpp_action::GoalResponse goal_callback(const rclcpp_action::GoalUUID& uuid, std::shared_ptr<const g2_2025_interfaces::action::Retake::Goal> goal)`**
**`rclcpp_action::GoalResponse goal_callback(const rclcpp_action::GoalUUID& uuid, std::shared_ptr<const g2_2025_assign1_interfaces_pkg::action::Retake::Goal> goal)`**
- Accepts retake goal requests for specific student-course combinations
- Logs received retake requests with student and course information
- Returns `ACCEPT_AND_EXECUTE` for all valid requests
**`rclcpp_action::CancelResponse cancel_callback(const std::shared_ptr<rclcpp_action::ServerGoalHandle<g2_2025_interfaces::action::Retake>> goal_handle)`**
**`rclcpp_action::CancelResponse cancel_callback(const std::shared_ptr<rclcpp_action::ServerGoalHandle<g2_2025_assign1_interfaces_pkg::action::Retake>> goal_handle)`**
- Handles retake action cancellation requests
- Returns `ACCEPT` for all cancellation requests
**`void spawn_callback_thread(const std::shared_ptr<rclcpp_action::ServerGoalHandle<g2_2025_interfaces::action::Retake>> goal_handle)`**
**`void spawn_callback_thread(const std::shared_ptr<rclcpp_action::ServerGoalHandle<g2_2025_assign1_interfaces_pkg::action::Retake>> goal_handle)`**
- Creates detached thread for asynchronous retake action execution
- Ensures non-blocking retake processing
**`void async_execute_callback_thread(const std::shared_ptr<rclcpp_action::ServerGoalHandle<g2_2025_interfaces::action::Retake>> goal_handle)`**
**`void async_execute_callback_thread(const std::shared_ptr<rclcpp_action::ServerGoalHandle<g2_2025_assign1_interfaces_pkg::action::Retake>> goal_handle)`**
- Enables retake exam processing by setting `retake_allowed_` flag
- Publishes student enrollment message to trigger exam generation
- Creates and returns successful action result

4
doc/architecture/nodes/RetakeScheduler.md
View File

@@ -1,4 +1,4 @@
# RetakeScheduler (`assignments::one::retake_scheduler`)
# RetakeScheduler (`assignments::one::g2_2025_retake_scheduler_node`)
## Overview
The `RetakeScheduler` node automatically identifies students who have failed courses and schedules retake exams for them. It periodically queries the database for failing students and sends retake action requests to the `RetakeGradeDeterminator` node to initiate the retake process.
@@ -13,7 +13,7 @@ The `RetakeScheduler` node automatically identifies students who have failed cou
```cpp
RetakeScheduler(std::unique_ptr<DatabaseManager> db_manager = nullptr)
```
- Initializes ROS2 node with name `retake_scheduler`
- Initializes ROS2 node with name `g2_2025_retake_scheduler_node`
- Sets up `DatabaseManager` (optional injection for testing)
- Creates ROS2 action client for retake action communication
- Initializes wall timer for periodic failing student checks