Add documentation headers across system modules
This commit is contained in:
+17
@@ -1,5 +1,22 @@
|
||||
/*
|
||||
File: Trenser.VehicleServiceSystem.cpp
|
||||
Description: Entry point for the Vehicle Service Management System.
|
||||
Initializes the UserInterface and starts the application loop.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "UserInterface.h"
|
||||
|
||||
/*
|
||||
Function: main
|
||||
Description: The main entry point of the application.
|
||||
Creates a UserInterface object and invokes the run method to start the system.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- int: Exit status code (0 for successful execution).
|
||||
*/
|
||||
int main()
|
||||
{
|
||||
UserInterface userInterface;
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/*
|
||||
File: Controller.cpp
|
||||
Description: Implements the Controller class which manages authentication, user, service, inventory, payment, and notification operations in the Vehicle Service Management System.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include <stdexcept>
|
||||
#include "Controller.h"
|
||||
#include "User.h"
|
||||
@@ -130,6 +137,13 @@ void Controller::completePayment(const std::string& invoiceID, util::PaymentMode
|
||||
{
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getNotifications
|
||||
Description: Retrieves all notifications for the currently authenticated user.
|
||||
Converts them into a read-only vector before returning.
|
||||
Parameters: None
|
||||
Return type: util::Vector<const Notification*>
|
||||
*/
|
||||
util::Vector<const Notification*> Controller::getNotifications()
|
||||
{
|
||||
const User* authenticatedUser = m_authenticationManagementService.getAuthenticatedUser();
|
||||
@@ -147,6 +161,13 @@ util::Vector<const Notification*> Controller::getNotifications()
|
||||
return readOnlyNotifications;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: deleteNotification
|
||||
Description: Deletes a specific notification for the currently authenticated user.
|
||||
Parameters:
|
||||
- notificationID: std::string, the unique identifier of the notification
|
||||
Return type: void
|
||||
*/
|
||||
void Controller::deleteNotification(const std::string& notificationID)
|
||||
{
|
||||
const User* authenticatedUser = m_authenticationManagementService.getAuthenticatedUser();
|
||||
@@ -157,6 +178,15 @@ void Controller::deleteNotification(const std::string& notificationID)
|
||||
m_userManagementService.deleteNotification(notificationID, authenticatedUser->getId());
|
||||
}
|
||||
|
||||
/*
|
||||
Function: configureNotifications
|
||||
Description: Configures notification preferences for the authenticated user.
|
||||
Attaches or detaches the user from payment and service notifications.
|
||||
Parameters:
|
||||
- paymentNotifications: bool, enable/disable payment notifications
|
||||
- serviceNotifications: bool, enable/disable service notifications
|
||||
Return type: void
|
||||
*/
|
||||
void Controller::configureNotifications(bool paymentNotifications, bool serviceNotifications)
|
||||
{
|
||||
User* authenticatedUser = m_authenticationManagementService.getAuthenticatedUser();
|
||||
@@ -185,6 +215,13 @@ void Controller::configureNotifications(bool paymentNotifications, bool serviceN
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: runSystemChecks
|
||||
Description: Executes system checks including sending low stock alerts
|
||||
and payment reminders.
|
||||
Parameters: None
|
||||
Return type: void
|
||||
*/
|
||||
void Controller::runSystemChecks()
|
||||
{
|
||||
m_inventoryManagementService.sendLowStockAlerts();
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/*
|
||||
File: Controller.h
|
||||
Description: File contains the Controller class which manages authentication, user, service, inventory, payment, and notification operations in the Vehicle Service Management System.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include "Map.h"
|
||||
#include <string>
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/*
|
||||
File: Observer.h
|
||||
Description: Declares the Observer interface for handling notifications in the Vehicle Service Management System.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
class Notification;
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/*
|
||||
File: Subject.h
|
||||
Description: Declares the Subject interface for managing user attachments and detachments in the Observer design pattern within the Vehicle Service Management System.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
@@ -1,46 +1,128 @@
|
||||
/*
|
||||
File: DataStore.cpp
|
||||
Description: Implements the DataStore class which provides a centralized singleton repository
|
||||
for managing system data in the Vehicle Service Management System.
|
||||
Includes accessors for users, services, combo packages, service bookings,
|
||||
job cards, inventory items, invoices, and payments.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "DataStore.h"
|
||||
|
||||
/*
|
||||
Function: getInstance
|
||||
Description: Provides a singleton instance of the DataStore class.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to the single DataStore instance.
|
||||
*/
|
||||
DataStore& DataStore::getInstance()
|
||||
{
|
||||
static DataStore dataStore;
|
||||
return dataStore;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getUsers
|
||||
Description: Retrieves the internal map of users.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, User*> containing all users.
|
||||
*/
|
||||
util::Map<std::string, User*>& DataStore::getUsers()
|
||||
{
|
||||
return m_users;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getServices
|
||||
Description: Retrieves the internal map of services.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, Service*> containing all services.
|
||||
*/
|
||||
util::Map<std::string, Service*>& DataStore::getServices()
|
||||
{
|
||||
return m_services;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getComboPackages
|
||||
Description: Retrieves the internal map of combo packages.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, ComboPackage*> containing all combo packages.
|
||||
*/
|
||||
util::Map<std::string, ComboPackage*>& DataStore::getComboPackages()
|
||||
{
|
||||
return m_comboPackages;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getServiceBookings
|
||||
Description: Retrieves the internal map of service bookings.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, ServiceBooking*> containing all service bookings.
|
||||
*/
|
||||
util::Map<std::string, ServiceBooking*>& DataStore::getServiceBookings()
|
||||
{
|
||||
return m_serviceBookings;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getJobCards
|
||||
Description: Retrieves the internal map of job cards.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, JobCard*> containing all job cards.
|
||||
*/
|
||||
util::Map<std::string, JobCard*>& DataStore::getJobCards()
|
||||
{
|
||||
return m_jobCards;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getInventoryItems
|
||||
Description: Retrieves the internal map of inventory items.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, InventoryItem*> containing all inventory items.
|
||||
*/
|
||||
util::Map<std::string, InventoryItem*>& DataStore::getInventoryItems()
|
||||
{
|
||||
return m_inventoryItems;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getInvoices
|
||||
Description: Retrieves the internal map of invoices.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, Invoice*> containing all invoices.
|
||||
*/
|
||||
util::Map<std::string, Invoice*>& DataStore::getInvoices()
|
||||
{
|
||||
return m_invoices;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPayments
|
||||
Description: Retrieves the internal map of payments.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- Reference to util::Map<std::string, Payment*> containing all payments.
|
||||
*/
|
||||
util::Map<std::string, Payment*>& DataStore::getPayments()
|
||||
{
|
||||
return m_payments;
|
||||
|
||||
@@ -1,5 +1,11 @@
|
||||
#pragma once
|
||||
/*
|
||||
File: DataStore.h
|
||||
Description: Declares the DataStore singleton class responsible for managing collections of users, services, combo packages, service bookings, job cards, inventory items, invoices, and payments in the Vehicle Service Management System.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
|
||||
@@ -1,12 +1,41 @@
|
||||
/*
|
||||
File: ComboPackage.cpp
|
||||
Description: Implements the ComboPackage class which represents a bundled set of services in the Vehicle Service Management System.
|
||||
Provides constructors, accessors, and mutators for package details such as ID, name, discount percentage, state,
|
||||
and associated services.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "ComboPackage.h"
|
||||
|
||||
int ComboPackage::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: ComboPackage
|
||||
Description: Default constructor that initializes a new combo package with a unique ID,
|
||||
active state, and zero discount percentage.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new ComboPackage object.
|
||||
*/
|
||||
ComboPackage::ComboPackage()
|
||||
: m_id("CMP" + std::to_string(++m_uid)),
|
||||
m_status(util::State::ACTIVE),
|
||||
m_discountPercentage(0.0) {}
|
||||
|
||||
/*
|
||||
Function: ComboPackage
|
||||
Description: Parameterized constructor that initializes a new combo package with a unique ID,
|
||||
specified package name, discount percentage, active state, and associated services.
|
||||
Parameters:
|
||||
- packageName: Name of the combo package.
|
||||
- discountPercentage: Discount percentage applied to the package.
|
||||
- services: Map of services included in the package.
|
||||
Returns:
|
||||
- A new ComboPackage object.
|
||||
*/
|
||||
ComboPackage::ComboPackage(const std::string& packageName, double discountPercentage, const util::Map<std::string, Service*>& services)
|
||||
: m_id("CMP" + std::to_string(++m_uid)),
|
||||
m_packageName(packageName),
|
||||
@@ -14,51 +43,131 @@ ComboPackage::ComboPackage(const std::string& packageName, double discountPercen
|
||||
m_status(util::State::ACTIVE),
|
||||
m_services(services) {}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the combo package.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- const std::string& representing the package ID.
|
||||
*/
|
||||
const std::string& ComboPackage::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPackageName
|
||||
Description: Retrieves the name of the combo package.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- const std::string& representing the package name.
|
||||
*/
|
||||
const std::string& ComboPackage::getPackageName() const
|
||||
{
|
||||
return m_packageName;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getDiscountPercentage
|
||||
Description: Retrieves the discount percentage applied to the combo package.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- double representing the discount percentage.
|
||||
*/
|
||||
double ComboPackage::getDiscountPercentage() const
|
||||
{
|
||||
return m_discountPercentage;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getState
|
||||
Description: Retrieves the current state (ACTIVE/INACTIVE) of the combo package.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- util::State representing the package state.
|
||||
*/
|
||||
util::State ComboPackage::getState() const
|
||||
{
|
||||
return m_status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getServices
|
||||
Description: Retrieves the map of services included in the combo package.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- const util::Map<std::string, Service*>& representing the services.
|
||||
*/
|
||||
const util::Map<std::string, Service*>& ComboPackage::getServices() const
|
||||
{
|
||||
return m_services;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the combo package.
|
||||
Parameters:
|
||||
- id: New ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ComboPackage::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPackageName
|
||||
Description: Sets the name of the combo package.
|
||||
Parameters:
|
||||
- packageName: New package name string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ComboPackage::setPackageName(const std::string& packageName)
|
||||
{
|
||||
m_packageName = packageName;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setDiscountPercentage
|
||||
Description: Sets the discount percentage for the combo package.
|
||||
Parameters:
|
||||
- discountPercentage: New discount percentage value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ComboPackage::setDiscountPercentage(double discountPercentage)
|
||||
{
|
||||
m_discountPercentage = discountPercentage;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setServices
|
||||
Description: Sets the services included in the combo package.
|
||||
Parameters:
|
||||
- services: Map of services to be associated with the package.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ComboPackage::setServices(const util::Map<std::string, Service*>& services)
|
||||
{
|
||||
m_services = services;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setState
|
||||
Description: Sets the state (ACTIVE/INACTIVE) of the combo package.
|
||||
Parameters:
|
||||
- status: New state value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ComboPackage::setState(util::State status)
|
||||
{
|
||||
m_status = status;
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/*
|
||||
File: ComboPackage.h
|
||||
Description: Declares the ComboPackage class which represents a service package with a unique ID, package name, discount percentage, associated services, and status in the Vehicle Service Management System.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
@@ -1,13 +1,41 @@
|
||||
/*
|
||||
File: InventoryItem.cpp
|
||||
Description: Implements the InventoryItem class which represents an inventory item in the Vehicle Service Management System.
|
||||
Provides constructors, accessors, and mutators for item details such as ID, part name, quantity, price, and state.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "InventoryItem.h"
|
||||
|
||||
int InventoryItem::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: InventoryItem
|
||||
Description: Default constructor that initializes a new inventory item with a unique ID,
|
||||
active state, zero quantity, and zero price.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new InventoryItem object.
|
||||
*/
|
||||
InventoryItem::InventoryItem()
|
||||
: m_id("IIM" + std::to_string(++m_uid)),
|
||||
m_quantity(0),
|
||||
m_status(util::State::ACTIVE),
|
||||
m_price(0.0) {}
|
||||
|
||||
/*
|
||||
Function: InventoryItem
|
||||
Description: Parameterized constructor that initializes a new inventory item with a unique ID,
|
||||
specified part name, quantity, price, and active state.
|
||||
Parameters:
|
||||
- partName: Name of the inventory item.
|
||||
- quantity: Initial quantity of the item.
|
||||
- price: Price of the item.
|
||||
Returns:
|
||||
- A new InventoryItem object.
|
||||
*/
|
||||
InventoryItem::InventoryItem(const std::string& partName, int quantity, double price)
|
||||
: m_id("IIM" + std::to_string(++m_uid)),
|
||||
m_partName(partName),
|
||||
@@ -15,51 +43,131 @@ InventoryItem::InventoryItem(const std::string& partName, int quantity, double p
|
||||
m_status(util::State::ACTIVE),
|
||||
m_price(price) {}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the inventory item.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- const std::string& representing the item ID.
|
||||
*/
|
||||
const std::string& InventoryItem::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPartName
|
||||
Description: Retrieves the part name of the inventory item.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- const std::string& representing the part name.
|
||||
*/
|
||||
const std::string& InventoryItem::getPartName() const
|
||||
{
|
||||
return m_partName;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getQuantity
|
||||
Description: Retrieves the current quantity of the inventory item.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- int representing the quantity.
|
||||
*/
|
||||
int InventoryItem::getQuantity() const
|
||||
{
|
||||
return m_quantity;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPrice
|
||||
Description: Retrieves the price of the inventory item.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- double representing the price.
|
||||
*/
|
||||
double InventoryItem::getPrice() const
|
||||
{
|
||||
return m_price;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getState
|
||||
Description: Retrieves the current state (ACTIVE/INACTIVE) of the inventory item.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- util::State representing the item state.
|
||||
*/
|
||||
util::State InventoryItem::getState() const
|
||||
{
|
||||
return m_status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the inventory item.
|
||||
Parameters:
|
||||
- id: New ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void InventoryItem::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPartName
|
||||
Description: Sets the part name of the inventory item.
|
||||
Parameters:
|
||||
- partName: New part name string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void InventoryItem::setPartName(const std::string& partName)
|
||||
{
|
||||
m_partName = partName;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setQuantity
|
||||
Description: Sets the quantity of the inventory item.
|
||||
Parameters:
|
||||
- quantity: New quantity value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void InventoryItem::setQuantity(int quantity)
|
||||
{
|
||||
m_quantity = quantity;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPrice
|
||||
Description: Sets the price of the inventory item.
|
||||
Parameters:
|
||||
- price: New price value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void InventoryItem::setPrice(double price)
|
||||
{
|
||||
m_price = price;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setState
|
||||
Description: Sets the state (ACTIVE/INACTIVE) of the inventory item.
|
||||
Parameters:
|
||||
- status: New state value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void InventoryItem::setState(util::State status)
|
||||
{
|
||||
m_status = status;
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: InventoryItem.h
|
||||
Description: Declares the InventoryItem class which represents parts in the Vehicle Service Management System.
|
||||
Each item has a unique ID, part name, quantity, price, and status.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Enums.h"
|
||||
|
||||
@@ -1,7 +1,26 @@
|
||||
/*
|
||||
File: Invoice.cpp
|
||||
Description: Implements the Invoice class which represents an invoice in the Vehicle Service Management System.
|
||||
Provides constructors, accessors, and mutators for invoice details such as ID, booking, costs,
|
||||
discount percentage, total amount, payment details, and status.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "Invoice.h"
|
||||
|
||||
int Invoice::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: Invoice
|
||||
Description: Default constructor that initializes a new invoice with a unique ID,
|
||||
null booking, zero costs, zero discount, zero total amount,
|
||||
and default payment method and status.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new Invoice object.
|
||||
*/
|
||||
Invoice::Invoice()
|
||||
: m_id("INV" + std::to_string(++m_uid)),
|
||||
m_booking(nullptr),
|
||||
@@ -12,6 +31,24 @@ Invoice::Invoice()
|
||||
m_paymentMethod(util::PaymentMode()),
|
||||
m_status(util::PaymentStatus()) {}
|
||||
|
||||
/*
|
||||
Function: Invoice
|
||||
Description: Parameterized constructor that initializes a new invoice with a unique ID and specified details.
|
||||
Parameters:
|
||||
- bookingId: ID of the associated service booking.
|
||||
- booking: Pointer to the ServiceBooking object.
|
||||
- invoiceDate: Timestamp of when the invoice was created.
|
||||
- laborCost: Cost of labor for the service.
|
||||
- parts: Map of inventory items used in the service.
|
||||
- partsCost: Total cost of parts.
|
||||
- discountPercentage: Discount applied to the invoice.
|
||||
- totalAmount: Final total amount after discount.
|
||||
- paymentDate: Timestamp of when payment was made.
|
||||
- paymentMethod: Payment mode (ONLINE/OFFLINE).
|
||||
- status: Payment status (PENDING/COMPLETED).
|
||||
Returns:
|
||||
- A new Invoice object.
|
||||
*/
|
||||
Invoice::Invoice(
|
||||
const std::string& bookingId,
|
||||
ServiceBooking* booking,
|
||||
@@ -38,121 +75,289 @@ Invoice::Invoice(
|
||||
m_paymentMethod(paymentMethod),
|
||||
m_status(status) {}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the invoice.
|
||||
Returns:
|
||||
- const std::string& representing the invoice ID.
|
||||
*/
|
||||
const std::string& Invoice::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getBookingId
|
||||
Description: Retrieves the booking ID associated with the invoice.
|
||||
Returns:
|
||||
- const std::string& representing the booking ID.
|
||||
*/
|
||||
const std::string& Invoice::getBookingId() const
|
||||
{
|
||||
return m_bookingId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getBooking
|
||||
Description: Retrieves the pointer to the associated ServiceBooking.
|
||||
Returns:
|
||||
- ServiceBooking* representing the booking.
|
||||
*/
|
||||
ServiceBooking* Invoice::getBooking() const
|
||||
{
|
||||
return m_booking;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getInvoiceDate
|
||||
Description: Retrieves the timestamp of the invoice creation date.
|
||||
Returns:
|
||||
- const util::Timestamp& representing the invoice date.
|
||||
*/
|
||||
const util::Timestamp& Invoice::getInvoiceDate() const
|
||||
{
|
||||
return m_invoiceDate;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getLaborCost
|
||||
Description: Retrieves the labor cost associated with the invoice.
|
||||
Returns:
|
||||
- double representing the labor cost.
|
||||
*/
|
||||
double Invoice::getLaborCost() const
|
||||
{
|
||||
return m_laborCost;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getParts
|
||||
Description: Retrieves the map of inventory items used in the service.
|
||||
Returns:
|
||||
- const util::Map<int, InventoryItem*>& representing the parts.
|
||||
*/
|
||||
const util::Map<int, InventoryItem*>& Invoice::getParts() const
|
||||
{
|
||||
return m_parts;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPartsCost
|
||||
Description: Retrieves the total cost of parts used in the service.
|
||||
Returns:
|
||||
- double representing the parts cost.
|
||||
*/
|
||||
double Invoice::getPartsCost() const
|
||||
{
|
||||
return m_partsCost;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getDiscountPercentage
|
||||
Description: Retrieves the discount percentage applied to the invoice.
|
||||
Returns:
|
||||
- double representing the discount percentage.
|
||||
*/
|
||||
double Invoice::getDiscountPercentage() const
|
||||
{
|
||||
return m_discountPercentage;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getTotalAmount
|
||||
Description: Retrieves the total amount of the invoice after discount.
|
||||
Returns:
|
||||
- double representing the total amount.
|
||||
*/
|
||||
double Invoice::getTotalAmount() const
|
||||
{
|
||||
return m_totalAmount;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPaymentDate
|
||||
Description: Retrieves the timestamp of the payment date.
|
||||
Returns:
|
||||
- const util::Timestamp& representing the payment date.
|
||||
*/
|
||||
const util::Timestamp& Invoice::getPaymentDate() const
|
||||
{
|
||||
return m_paymentDate;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPaymentMethod
|
||||
Description: Retrieves the payment mode used for the invoice.
|
||||
Returns:
|
||||
- util::PaymentMode representing the payment method.
|
||||
*/
|
||||
util::PaymentMode Invoice::getPaymentMethod() const
|
||||
{
|
||||
return m_paymentMethod;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getStatus
|
||||
Description: Retrieves the payment status of the invoice.
|
||||
Returns:
|
||||
- util::PaymentStatus representing the payment status.
|
||||
*/
|
||||
util::PaymentStatus Invoice::getStatus() const
|
||||
{
|
||||
return m_status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the invoice.
|
||||
Parameters:
|
||||
- id: New invoice ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setBookingId
|
||||
Description: Sets the booking ID associated with the invoice.
|
||||
Parameters:
|
||||
- bookingId: New booking ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setBookingId(const std::string& bookingId)
|
||||
{
|
||||
m_bookingId = bookingId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setBooking
|
||||
Description: Sets the associated ServiceBooking pointer.
|
||||
Parameters:
|
||||
- booking: Pointer to the ServiceBooking object.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setBooking(ServiceBooking* booking)
|
||||
{
|
||||
m_booking = booking;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setInvoiceDate
|
||||
Description: Sets the invoice creation date.
|
||||
Parameters:
|
||||
- invoiceDate: New timestamp for the invoice date.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setInvoiceDate(const util::Timestamp& invoiceDate)
|
||||
{
|
||||
m_invoiceDate = invoiceDate;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setLaborCost
|
||||
Description: Sets the labor cost for the invoice.
|
||||
Parameters:
|
||||
- laborCost: New labor cost value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setLaborCost(double laborCost)
|
||||
{
|
||||
m_laborCost = laborCost;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setParts
|
||||
Description: Sets the inventory items used in the service.
|
||||
Parameters:
|
||||
- parts: Map of inventory items.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setParts(const util::Map<int, InventoryItem*>& parts)
|
||||
{
|
||||
m_parts = parts;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPartsCost
|
||||
Description: Sets the total cost of parts used in the service.
|
||||
Parameters:
|
||||
- partsCost: New parts cost value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setPartsCost(double partsCost)
|
||||
{
|
||||
m_partsCost = partsCost;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setDiscountPercentage
|
||||
Description: Sets the discount percentage applied to the invoice.
|
||||
Parameters:
|
||||
- discountPercentage: New discount percentage value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setDiscountPercentage(double discountPercentage)
|
||||
{
|
||||
m_discountPercentage = discountPercentage;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setTotalAmount
|
||||
Description: Sets the total amount of the invoice.
|
||||
Parameters:
|
||||
- totalAmount: New total amount value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setTotalAmount(double totalAmount)
|
||||
{
|
||||
m_totalAmount = totalAmount;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPaymentDate
|
||||
Description: Sets the payment date for the invoice.
|
||||
Parameters:
|
||||
- paymentDate: New timestamp for the payment date.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setPaymentDate(const util::Timestamp& paymentDate)
|
||||
{
|
||||
m_paymentDate = paymentDate;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPaymentMethod
|
||||
Description: Sets the payment mode for the invoice.
|
||||
Parameters:
|
||||
- paymentMethod: New payment mode value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setPaymentMethod(util::PaymentMode paymentMethod)
|
||||
{
|
||||
m_paymentMethod = paymentMethod;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setStatus
|
||||
Description: Sets the payment status of the invoice.
|
||||
Parameters:
|
||||
- status: New payment status value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Invoice::setStatus(util::PaymentStatus status)
|
||||
{
|
||||
m_status = status;
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: Invoice.h
|
||||
Description: Declares the Invoice class which represents billing details for a service booking in the Vehicle Service Management System.
|
||||
Each invoice includes booking information, labor cost, parts used, discount percentage, total amount, payment details, and status.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
@@ -1,7 +1,25 @@
|
||||
/*
|
||||
File: JobCard.cpp
|
||||
Description: Implements the JobCard class which represents a technician’s job assignment in the Vehicle Service Management System.
|
||||
Provides constructors, accessors, and mutators for job details such as ID, booking, service, technician,
|
||||
assigned date, completion date, and job status.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "JobCard.h"
|
||||
|
||||
int JobCard::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: JobCard
|
||||
Description: Default constructor that initializes a new job card with a unique ID,
|
||||
null booking, null service, null technician, and default job status.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new JobCard object.
|
||||
*/
|
||||
JobCard::JobCard()
|
||||
: m_id("JC" + std::to_string(++m_uid)),
|
||||
m_booking(nullptr),
|
||||
@@ -9,6 +27,22 @@ JobCard::JobCard()
|
||||
m_technician(nullptr),
|
||||
m_status(ServiceJobStatus()) {}
|
||||
|
||||
/*
|
||||
Function: JobCard
|
||||
Description: Parameterized constructor that initializes a new job card with a unique ID and specified details.
|
||||
Parameters:
|
||||
- bookingId: ID of the associated service booking.
|
||||
- booking: Pointer to the ServiceBooking object.
|
||||
- service: Pointer to the Service object.
|
||||
- serviceId: ID of the associated service.
|
||||
- technicianId: ID of the assigned technician.
|
||||
- technician: Pointer to the User object representing the technician.
|
||||
- assignedDate: Timestamp of when the job was assigned.
|
||||
- status: Current status of the job (STARTED/COMPLETED).
|
||||
- completionDate: Timestamp of when the job was completed.
|
||||
Returns:
|
||||
- A new JobCard object.
|
||||
*/
|
||||
JobCard::JobCard(const std::string& bookingId,
|
||||
ServiceBooking* booking,
|
||||
Service* service,
|
||||
@@ -30,101 +64,241 @@ JobCard::JobCard(const std::string& bookingId,
|
||||
m_status(status),
|
||||
m_completionDate(completionDate) {}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the job card.
|
||||
Returns:
|
||||
- const std::string& representing the job card ID.
|
||||
*/
|
||||
const std::string& JobCard::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getBookingId
|
||||
Description: Retrieves the booking ID associated with the job card.
|
||||
Returns:
|
||||
- const std::string& representing the booking ID.
|
||||
*/
|
||||
const std::string& JobCard::getBookingId() const
|
||||
{
|
||||
return m_bookingId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getBooking
|
||||
Description: Retrieves the pointer to the associated ServiceBooking.
|
||||
Returns:
|
||||
- ServiceBooking* representing the booking.
|
||||
*/
|
||||
ServiceBooking* JobCard::getBooking() const
|
||||
{
|
||||
return m_booking;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getService
|
||||
Description: Retrieves the pointer to the associated Service.
|
||||
Returns:
|
||||
- Service* representing the service.
|
||||
*/
|
||||
Service* JobCard::getService() const
|
||||
{
|
||||
return m_service;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getServiceId
|
||||
Description: Retrieves the service ID associated with the job card.
|
||||
Returns:
|
||||
- const std::string& representing the service ID.
|
||||
*/
|
||||
const std::string& JobCard::getServiceId() const
|
||||
{
|
||||
return m_serviceId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getTechnicianId
|
||||
Description: Retrieves the technician ID associated with the job card.
|
||||
Returns:
|
||||
- const std::string& representing the technician ID.
|
||||
*/
|
||||
const std::string& JobCard::getTechnicianId() const
|
||||
{
|
||||
return m_technicianId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getTechnician
|
||||
Description: Retrieves the pointer to the assigned technician.
|
||||
Returns:
|
||||
- User* representing the technician.
|
||||
*/
|
||||
User* JobCard::getTechnician() const
|
||||
{
|
||||
return m_technician;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getAssignedDate
|
||||
Description: Retrieves the timestamp of when the job was assigned.
|
||||
Returns:
|
||||
- const util::Timestamp& representing the assigned date.
|
||||
*/
|
||||
const util::Timestamp& JobCard::getAssignedDate() const
|
||||
{
|
||||
return m_assignedDate;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getStatus
|
||||
Description: Retrieves the current status of the job.
|
||||
Returns:
|
||||
- ServiceJobStatus representing the job status.
|
||||
*/
|
||||
ServiceJobStatus JobCard::getStatus() const
|
||||
{
|
||||
return m_status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getCompletionDate
|
||||
Description: Retrieves the timestamp of when the job was completed.
|
||||
Returns:
|
||||
- const util::Timestamp& representing the completion date.
|
||||
*/
|
||||
const util::Timestamp& JobCard::getCompletionDate() const
|
||||
{
|
||||
return m_completionDate;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the job card.
|
||||
Parameters:
|
||||
- id: New job card ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setBookingId
|
||||
Description: Sets the booking ID associated with the job card.
|
||||
Parameters:
|
||||
- bookingId: New booking ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setBookingId(const std::string& bookingId)
|
||||
{
|
||||
m_bookingId = bookingId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setBooking
|
||||
Description: Sets the associated ServiceBooking pointer.
|
||||
Parameters:
|
||||
- booking: Pointer to the ServiceBooking object.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setBooking(ServiceBooking* booking)
|
||||
{
|
||||
m_booking = booking;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setService
|
||||
Description: Sets the associated Service pointer.
|
||||
Parameters:
|
||||
- service: Pointer to the Service object.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setService(Service* service)
|
||||
{
|
||||
m_service = service;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setServiceId
|
||||
Description: Sets the service ID associated with the job card.
|
||||
Parameters:
|
||||
- serviceId: New service ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setServiceId(const std::string& serviceId)
|
||||
{
|
||||
m_serviceId = serviceId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setTechnicianId
|
||||
Description: Sets the technician ID associated with the job card.
|
||||
Parameters:
|
||||
- technicianId: New technician ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setTechnicianId(const std::string& technicianId)
|
||||
{
|
||||
m_technicianId = technicianId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setTechnician
|
||||
Description: Sets the pointer to the assigned technician.
|
||||
Parameters:
|
||||
- technician: Pointer to the User object.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setTechnician(User* technician)
|
||||
{
|
||||
m_technician = technician;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setAssignedDate
|
||||
Description: Sets the timestamp of when the job was assigned.
|
||||
Parameters:
|
||||
- assignedDate: New timestamp for the assigned date.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setAssignedDate(const util::Timestamp& assignedDate)
|
||||
{
|
||||
m_assignedDate = assignedDate;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setStatus
|
||||
Description: Sets the current status of the job.
|
||||
Parameters:
|
||||
- status: New job status value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setStatus(ServiceJobStatus status)
|
||||
{
|
||||
m_status = status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setCompletionDate
|
||||
Description: Sets the timestamp of when the job was completed.
|
||||
Parameters:
|
||||
- completionDate: New timestamp for the completion date.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void JobCard::setCompletionDate(const util::Timestamp& completionDate)
|
||||
{
|
||||
m_completionDate = completionDate;
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: JobCard.h
|
||||
Description: Declares the JobCard class which represents a technician’s job assignment in the Vehicle Service Management System.
|
||||
Each job card includes booking details, associated service, technician information, assigned and completion dates, and job status.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Timestamp.h"
|
||||
|
||||
@@ -1,11 +1,39 @@
|
||||
/*
|
||||
File: Notification.cpp
|
||||
Description: Implements the Notification class which represents system notifications in the Vehicle Service Management System.
|
||||
Provides constructors, accessors, and mutators for notification details such as ID, recipient, title, message, and timestamp.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "Notification.h"
|
||||
|
||||
int Notification::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: Notification
|
||||
Description: Default constructor that initializes a new notification with a unique ID and null recipient.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new Notification object.
|
||||
*/
|
||||
Notification::Notification()
|
||||
: m_id("NOT" + std::to_string(++m_uid)),
|
||||
m_recipient(nullptr) {}
|
||||
|
||||
/*
|
||||
Function: Notification
|
||||
Description: Parameterized constructor that initializes a new notification with a unique ID and specified details.
|
||||
Parameters:
|
||||
- recipientUserId: ID of the recipient user.
|
||||
- recipient: Pointer to the User object representing the recipient.
|
||||
- title: Title of the notification.
|
||||
- message: Message content of the notification.
|
||||
- createdAt: Timestamp of when the notification was created.
|
||||
Returns:
|
||||
- A new Notification object.
|
||||
*/
|
||||
Notification::Notification(const std::string& recipientUserId, User* recipient, const std::string& title, const std::string& message, const util::Timestamp& createdAt)
|
||||
: m_id("NOT" + std::to_string(++m_uid)),
|
||||
m_recipientUserId(recipientUserId),
|
||||
@@ -14,61 +42,145 @@ Notification::Notification(const std::string& recipientUserId, User* recipient,
|
||||
m_message(message),
|
||||
m_createdAt(createdAt) {}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the notification.
|
||||
Returns:
|
||||
- const std::string& representing the notification ID.
|
||||
*/
|
||||
const std::string& Notification::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getRecipientUserId
|
||||
Description: Retrieves the recipient user ID associated with the notification.
|
||||
Returns:
|
||||
- const std::string& representing the recipient user ID.
|
||||
*/
|
||||
const std::string& Notification::getRecipientUserId() const
|
||||
{
|
||||
return m_recipientUserId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getRecipient
|
||||
Description: Retrieves the pointer to the recipient user.
|
||||
Returns:
|
||||
- User* representing the recipient.
|
||||
*/
|
||||
User* Notification::getRecipient() const
|
||||
{
|
||||
return m_recipient;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getTitle
|
||||
Description: Retrieves the title of the notification.
|
||||
Returns:
|
||||
- const std::string& representing the notification title.
|
||||
*/
|
||||
const std::string& Notification::getTitle() const
|
||||
{
|
||||
return m_title;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getMessage
|
||||
Description: Retrieves the message content of the notification.
|
||||
Returns:
|
||||
- const std::string& representing the notification message.
|
||||
*/
|
||||
const std::string& Notification::getMessage() const
|
||||
{
|
||||
return m_message;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getCreatedAt
|
||||
Description: Retrieves the timestamp of when the notification was created.
|
||||
Returns:
|
||||
- const util::Timestamp& representing the creation timestamp.
|
||||
*/
|
||||
const util::Timestamp& Notification::getCreatedAt() const
|
||||
{
|
||||
return m_createdAt;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the notification.
|
||||
Parameters:
|
||||
- id: New notification ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Notification::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setRecipientUserId
|
||||
Description: Sets the recipient user ID for the notification.
|
||||
Parameters:
|
||||
- recipientUserId: New recipient user ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Notification::setRecipientUserId(const std::string& recipientUserId)
|
||||
{
|
||||
m_recipientUserId = recipientUserId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setRecipient
|
||||
Description: Sets the recipient user pointer for the notification.
|
||||
Parameters:
|
||||
- recipient: Pointer to the User object.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Notification::setRecipient(User* recipient)
|
||||
{
|
||||
m_recipient = recipient;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setTitle
|
||||
Description: Sets the title of the notification.
|
||||
Parameters:
|
||||
- title: New notification title string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Notification::setTitle(const std::string& title)
|
||||
{
|
||||
m_title = title;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setMessage
|
||||
Description: Sets the message content of the notification.
|
||||
Parameters:
|
||||
- message: New notification message string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Notification::setMessage(const std::string& message)
|
||||
{
|
||||
m_message = message;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setCreatedAt
|
||||
Description: Sets the timestamp of when the notification was created.
|
||||
Parameters:
|
||||
- createdAt: New timestamp value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Notification::setCreatedAt(const util::Timestamp& createdAt)
|
||||
{
|
||||
m_createdAt = createdAt;
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: Notification.h
|
||||
Description: Declares the Notification class which represents system messages sent to users in the Vehicle Service Management System.
|
||||
Each notification includes a unique ID, recipient details, title, message content, and timestamp of creation.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Timestamp.h"
|
||||
|
||||
@@ -1,12 +1,40 @@
|
||||
/*
|
||||
File: Service.cpp
|
||||
Description: Implements the Service class which represents a vehicle service in the Vehicle Service Management System.
|
||||
Provides constructors, accessors, and mutators for service details such as ID, name, required inventory items,
|
||||
labor cost, and state.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "Service.h"
|
||||
|
||||
int Service::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: Service
|
||||
Description: Default constructor that initializes a new service with a unique ID,
|
||||
active state, and zero labor cost.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new Service object.
|
||||
*/
|
||||
Service::Service()
|
||||
: m_id("SRV" + std::to_string(++m_uid)),
|
||||
m_status(util::State::ACTIVE),
|
||||
m_laborCost(0.0) {}
|
||||
|
||||
/*
|
||||
Function: Service
|
||||
Description: Parameterized constructor that initializes a new service with a unique ID and specified details.
|
||||
Parameters:
|
||||
- name: Name of the service.
|
||||
- requiredInventoryItems: Map of inventory items required for the service.
|
||||
- laborCost: Labor cost associated with the service.
|
||||
Returns:
|
||||
- A new Service object.
|
||||
*/
|
||||
Service::Service(const std::string& name, const util::Map<std::string, InventoryItem*>& requiredInventoryItems, double laborCost)
|
||||
: m_id("SRV" + std::to_string(++m_uid)),
|
||||
m_name(name),
|
||||
@@ -14,51 +42,121 @@ Service::Service(const std::string& name, const util::Map<std::string, Inventory
|
||||
m_status(util::State::ACTIVE),
|
||||
m_laborCost(laborCost) {}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the service.
|
||||
Returns:
|
||||
- const std::string& representing the service ID.
|
||||
*/
|
||||
const std::string& Service::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getName
|
||||
Description: Retrieves the name of the service.
|
||||
Returns:
|
||||
- const std::string& representing the service name.
|
||||
*/
|
||||
const std::string& Service::getName() const
|
||||
{
|
||||
return m_name;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getRequiredInventoryItems
|
||||
Description: Retrieves the map of inventory items required for the service.
|
||||
Returns:
|
||||
- const util::Map<std::string, InventoryItem*>& representing the required inventory items.
|
||||
*/
|
||||
const util::Map<std::string, InventoryItem*>& Service::getRequiredInventoryItems() const
|
||||
{
|
||||
return m_requiredInventoryItems;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getLaborCost
|
||||
Description: Retrieves the labor cost associated with the service.
|
||||
Returns:
|
||||
- double representing the labor cost.
|
||||
*/
|
||||
double Service::getLaborCost() const
|
||||
{
|
||||
return m_laborCost;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getState
|
||||
Description: Retrieves the current state (ACTIVE/INACTIVE) of the service.
|
||||
Returns:
|
||||
- util::State representing the service state.
|
||||
*/
|
||||
util::State Service::getState() const
|
||||
{
|
||||
return m_status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the service.
|
||||
Parameters:
|
||||
- id: New service ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Service::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setName
|
||||
Description: Sets the name of the service.
|
||||
Parameters:
|
||||
- name: New service name string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Service::setName(const std::string& name)
|
||||
{
|
||||
m_name = name;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setRequiredInventoryItems
|
||||
Description: Sets the inventory items required for the service.
|
||||
Parameters:
|
||||
- requiredInventoryItems: Map of inventory items.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Service::setRequiredInventoryItems(const util::Map<std::string, InventoryItem*>& requiredInventoryItems)
|
||||
{
|
||||
m_requiredInventoryItems = requiredInventoryItems;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setLaborCost
|
||||
Description: Sets the labor cost for the service.
|
||||
Parameters:
|
||||
- laborCost: New labor cost value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Service::setLaborCost(double laborCost)
|
||||
{
|
||||
m_laborCost = laborCost;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setState
|
||||
Description: Sets the state (ACTIVE/INACTIVE) of the service.
|
||||
Parameters:
|
||||
- status: New state value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void Service::setState(util::State status)
|
||||
{
|
||||
m_status = status;
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: Service.h
|
||||
Description: Declares the Service class which represents a vehicle service in the Vehicle Service Management System.
|
||||
Each service includes a unique ID, name, required inventory items, labor cost, and status.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
@@ -1,12 +1,48 @@
|
||||
/*
|
||||
File: ServiceBooking.cpp
|
||||
Description: Implements the ServiceBooking class which represents a customer’s service booking in the Vehicle Service Management System.
|
||||
Provides constructors, accessors, and mutators for booking details such as ID, status, services, customer,
|
||||
vehicle information, assigned technician, and discount percentage.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "ServiceBooking.h"
|
||||
|
||||
int ServiceBooking::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: ServiceBooking
|
||||
Description: Default constructor that initializes a new service booking with a unique ID,
|
||||
null customer, and zero discount percentage.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new ServiceBooking object.
|
||||
*/
|
||||
ServiceBooking::ServiceBooking()
|
||||
: m_id("SRV" + std::to_string(++m_uid)),
|
||||
m_customer(nullptr),
|
||||
m_discountPercentage(0.0) {}
|
||||
|
||||
/*
|
||||
Function: ServiceBooking
|
||||
Description: Parameterized constructor that initializes a new service booking with a unique ID and specified details.
|
||||
Parameters:
|
||||
- id: Booking ID string.
|
||||
- status: Current status of the booking (e.g., PENDING, COMPLETED).
|
||||
- services: Map of services included in the booking.
|
||||
- customerId: ID of the customer.
|
||||
- customer: Pointer to the User object representing the customer.
|
||||
- vehicleNumber: Vehicle registration number.
|
||||
- vehicleBrand: Brand of the vehicle.
|
||||
- vehicleModel: Model of the vehicle.
|
||||
- assignedTechnicianId: ID of the assigned technician.
|
||||
- assignedTechnician: Name of the assigned technician.
|
||||
- discountPercentage: Discount applied to the booking.
|
||||
Returns:
|
||||
- A new ServiceBooking object.
|
||||
*/
|
||||
ServiceBooking::ServiceBooking(
|
||||
const std::string& id,
|
||||
util::ServiceJobStatus status,
|
||||
@@ -35,111 +71,265 @@ ServiceBooking::ServiceBooking(
|
||||
{
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the service booking.
|
||||
Returns:
|
||||
- const std::string& representing the booking ID.
|
||||
*/
|
||||
const std::string& ServiceBooking::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getStatus
|
||||
Description: Retrieves the current status of the service booking.
|
||||
Returns:
|
||||
- util::ServiceJobStatus representing the booking status.
|
||||
*/
|
||||
util::ServiceJobStatus ServiceBooking::getStatus() const
|
||||
{
|
||||
return m_status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getServices
|
||||
Description: Retrieves the map of services included in the booking.
|
||||
Returns:
|
||||
- const util::Map<std::string, Service*>& representing the services.
|
||||
*/
|
||||
const util::Map<std::string, Service*>& ServiceBooking::getServices() const
|
||||
{
|
||||
return m_services;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getCustomerId
|
||||
Description: Retrieves the customer ID associated with the booking.
|
||||
Returns:
|
||||
- const std::string& representing the customer ID.
|
||||
*/
|
||||
const std::string& ServiceBooking::getCustomerId() const
|
||||
{
|
||||
return m_customerId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getCustomer
|
||||
Description: Retrieves the pointer to the associated customer.
|
||||
Returns:
|
||||
- User* representing the customer.
|
||||
*/
|
||||
User* ServiceBooking::getCustomer() const
|
||||
{
|
||||
return m_customer;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getVehicleNumber
|
||||
Description: Retrieves the vehicle registration number.
|
||||
Returns:
|
||||
- const std::string& representing the vehicle number.
|
||||
*/
|
||||
const std::string& ServiceBooking::getVehicleNumber() const
|
||||
{
|
||||
return m_vehicleNumber;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getVehicleBrand
|
||||
Description: Retrieves the brand of the vehicle.
|
||||
Returns:
|
||||
- const std::string& representing the vehicle brand.
|
||||
*/
|
||||
const std::string& ServiceBooking::getVehicleBrand() const
|
||||
{
|
||||
return m_vehicleBrand;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getVehicleModel
|
||||
Description: Retrieves the model of the vehicle.
|
||||
Returns:
|
||||
- const std::string& representing the vehicle model.
|
||||
*/
|
||||
const std::string& ServiceBooking::getVehicleModel() const
|
||||
{
|
||||
return m_vehicleModel;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getAssignedTechnicianId
|
||||
Description: Retrieves the ID of the assigned technician.
|
||||
Returns:
|
||||
- const std::string& representing the technician ID.
|
||||
*/
|
||||
const std::string& ServiceBooking::getAssignedTechnicianId() const
|
||||
{
|
||||
return m_assignedTechnicianId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getAssignedTechnician
|
||||
Description: Retrieves the name of the assigned technician.
|
||||
Returns:
|
||||
- const std::string& representing the technician name.
|
||||
*/
|
||||
const std::string& ServiceBooking::getAssignedTechnician() const
|
||||
{
|
||||
return m_assignedTechnician;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getDiscountPercentage
|
||||
Description: Retrieves the discount percentage applied to the booking.
|
||||
Returns:
|
||||
- double representing the discount percentage.
|
||||
*/
|
||||
double ServiceBooking::getDiscountPercentage() const
|
||||
{
|
||||
return m_discountPercentage;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the service booking.
|
||||
Parameters:
|
||||
- id: New booking ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setStatus
|
||||
Description: Sets the current status of the service booking.
|
||||
Parameters:
|
||||
- status: New booking status value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setStatus(const util::ServiceJobStatus& status)
|
||||
{
|
||||
m_status = status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setServices
|
||||
Description: Sets the services included in the booking.
|
||||
Parameters:
|
||||
- services: Map of services.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setServices(const util::Map<std::string, Service*>& services)
|
||||
{
|
||||
m_services = services;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setCustomerId
|
||||
Description: Sets the customer ID associated with the booking.
|
||||
Parameters:
|
||||
- customerId: New customer ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setCustomerId(const std::string& customerId)
|
||||
{
|
||||
m_customerId = customerId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setCustomer
|
||||
Description: Sets the pointer to the associated customer.
|
||||
Parameters:
|
||||
- customer: Pointer to the User object.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setCustomer(User* customer)
|
||||
{
|
||||
m_customer = customer;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setVehicleNumber
|
||||
Description: Sets the vehicle registration number.
|
||||
Parameters:
|
||||
- vehicleNumber: New vehicle number string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setVehicleNumber(const std::string& vehicleNumber)
|
||||
{
|
||||
m_vehicleNumber = vehicleNumber;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setVehicleBrand
|
||||
Description: Sets the brand of the vehicle.
|
||||
Parameters:
|
||||
- vehicleBrand: New vehicle brand string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setVehicleBrand(const std::string& vehicleBrand)
|
||||
{
|
||||
m_vehicleBrand = vehicleBrand;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setVehicleModel
|
||||
Description: Sets the model of the vehicle.
|
||||
Parameters:
|
||||
- vehicleModel: New vehicle model string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setVehicleModel(const std::string& vehicleModel)
|
||||
{
|
||||
m_vehicleModel = vehicleModel;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setAssignedTechnicianId
|
||||
Description: Sets the ID of the assigned technician.
|
||||
Parameters:
|
||||
- assignedTechnicianId: New technician ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setAssignedTechnicianId(const std::string& assignedTechnicianId)
|
||||
{
|
||||
m_assignedTechnicianId = assignedTechnicianId;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setAssignedTechnician
|
||||
Description: Sets the name of the assigned technician.
|
||||
Parameters:
|
||||
- assignedTechnician: New technician name string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setAssignedTechnician(const std::string& assignedTechnician)
|
||||
{
|
||||
m_assignedTechnician = assignedTechnician;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setDiscountPercentage
|
||||
Description: Sets the discount percentage applied to the booking.
|
||||
Parameters:
|
||||
- discountPercentage: New discount percentage value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceBooking::setDiscountPercentage(double discountPercentage)
|
||||
{
|
||||
m_discountPercentage = discountPercentage;
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: ServiceBooking.h
|
||||
Description: Declares the ServiceBooking class which represents a customer’s service booking in the Vehicle Service Management System.
|
||||
Each booking includes a unique ID, status, associated services, customer details, vehicle information, assigned technician, and discount percentage.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
@@ -1,14 +1,45 @@
|
||||
/*
|
||||
File: User.cpp
|
||||
Description: Implements the User class which represents system users in the Vehicle Service Management System.
|
||||
Provides constructors, destructor, accessors, and mutators for user details such as ID, username,
|
||||
password, name, phone, email, role, state, and notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "User.h"
|
||||
#include "Notification.h"
|
||||
#include "Enums.h"
|
||||
|
||||
int User::m_uid = 0;
|
||||
|
||||
/*
|
||||
Function: User
|
||||
Description: Default constructor that initializes a new user with a unique ID,
|
||||
default role as CUSTOMER, and active state.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- A new User object.
|
||||
*/
|
||||
User::User()
|
||||
: m_id("USR" + std::to_string(++m_uid)),
|
||||
m_type(util::UserType::CUSTOMER),
|
||||
m_status(util::State::ACTIVE) {}
|
||||
|
||||
/*
|
||||
Function: User
|
||||
Description: Parameterized constructor that initializes a new user with a unique ID and specified details.
|
||||
Parameters:
|
||||
- userName: Username for login.
|
||||
- password: Password for authentication.
|
||||
- name: Full name of the user.
|
||||
- phone: Phone number of the user.
|
||||
- email: Email address of the user.
|
||||
- role: Role of the user (CUSTOMER, ADMIN, TECHNICIAN, etc.).
|
||||
Returns:
|
||||
- A new User object.
|
||||
*/
|
||||
User::User(const std::string& userName, const std::string& password, const std::string& name, const std::string& phone, const std::string& email, util::UserType role)
|
||||
: m_id("USR" + std::to_string(++m_uid)),
|
||||
m_userName(userName),
|
||||
@@ -19,6 +50,14 @@ User::User(const std::string& userName, const std::string& password, const std::
|
||||
m_type(role),
|
||||
m_status(util::State::ACTIVE) {}
|
||||
|
||||
/*
|
||||
Function: ~User
|
||||
Description: Destructor that cleans up dynamically allocated notifications associated with the user.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
User::~User()
|
||||
{
|
||||
for (int index = 0; index < m_notifications.getSize(); index++)
|
||||
@@ -27,81 +66,191 @@ User::~User()
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getId
|
||||
Description: Retrieves the unique ID of the user.
|
||||
Returns:
|
||||
- const std::string& representing the user ID.
|
||||
*/
|
||||
const std::string& User::getId() const
|
||||
{
|
||||
return m_id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getUserName
|
||||
Description: Retrieves the username of the user.
|
||||
Returns:
|
||||
- const std::string& representing the username.
|
||||
*/
|
||||
const std::string& User::getUserName() const
|
||||
{
|
||||
return m_userName;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPassword
|
||||
Description: Retrieves the password of the user.
|
||||
Returns:
|
||||
- const std::string& representing the password.
|
||||
*/
|
||||
const std::string& User::getPassword() const
|
||||
{
|
||||
return m_password;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getName
|
||||
Description: Retrieves the full name of the user.
|
||||
Returns:
|
||||
- const std::string& representing the name.
|
||||
*/
|
||||
const std::string& User::getName() const
|
||||
{
|
||||
return m_name;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPhone
|
||||
Description: Retrieves the phone number of the user.
|
||||
Returns:
|
||||
- const std::string& representing the phone number.
|
||||
*/
|
||||
const std::string& User::getPhone() const
|
||||
{
|
||||
return m_phone;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getEmail
|
||||
Description: Retrieves the email address of the user.
|
||||
Returns:
|
||||
- const std::string& representing the email.
|
||||
*/
|
||||
const std::string& User::getEmail() const
|
||||
{
|
||||
return m_email;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getNotifications
|
||||
Description: Retrieves the map of notifications associated with the user.
|
||||
Returns:
|
||||
- util::Map<std::string, Notification*>& representing the notifications.
|
||||
*/
|
||||
util::Map<std::string, Notification*>& User::getNotifications()
|
||||
{
|
||||
return m_notifications;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getUserType
|
||||
Description: Retrieves the role of the user.
|
||||
Returns:
|
||||
- util::UserType representing the user role.
|
||||
*/
|
||||
util::UserType User::getUserType() const
|
||||
{
|
||||
return m_type;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getState
|
||||
Description: Retrieves the current state (ACTIVE/INACTIVE) of the user.
|
||||
Returns:
|
||||
- util::State representing the user state.
|
||||
*/
|
||||
util::State User::getState() const
|
||||
{
|
||||
return m_status;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setId
|
||||
Description: Sets the unique ID of the user.
|
||||
Parameters:
|
||||
- id: New user ID string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setId(const std::string& id)
|
||||
{
|
||||
m_id = id;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setUserName
|
||||
Description: Sets the username of the user.
|
||||
Parameters:
|
||||
- userName: New username string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setUserName(const std::string& userName)
|
||||
{
|
||||
m_userName = userName;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPassword
|
||||
Description: Sets the password of the user.
|
||||
Parameters:
|
||||
- password: New password string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setPassword(const std::string& password)
|
||||
{
|
||||
m_password = password;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setName
|
||||
Description: Sets the full name of the user.
|
||||
Parameters:
|
||||
- name: New name string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setName(const std::string& name)
|
||||
{
|
||||
m_name = name;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setPhone
|
||||
Description: Sets the phone number of the user.
|
||||
Parameters:
|
||||
- phone: New phone number string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setPhone(const std::string& phone)
|
||||
{
|
||||
m_phone = phone;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setEmail
|
||||
Description: Sets the email address of the user.
|
||||
Parameters:
|
||||
- email: New email string.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setEmail(const std::string& email)
|
||||
{
|
||||
m_email = email;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: addNotification
|
||||
Description: Adds a new notification to the user’s notification map.
|
||||
Parameters:
|
||||
- notification: Pointer to the Notification object.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::addNotification(Notification* notification)
|
||||
{
|
||||
if (notification)
|
||||
@@ -110,11 +259,27 @@ void User::addNotification(Notification* notification)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setRole
|
||||
Description: Sets the role of the user.
|
||||
Parameters:
|
||||
- role: New user role value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setRole(util::UserType role)
|
||||
{
|
||||
m_type = role;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: setState
|
||||
Description: Sets the state (ACTIVE/INACTIVE) of the user.
|
||||
Parameters:
|
||||
- status: New state value.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void User::setState(util::State status)
|
||||
{
|
||||
m_status = status;
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: User.h
|
||||
Description: Declares the User class which represents system users in the Vehicle Service Management System.
|
||||
Each user has a unique ID, credentials, personal details, notifications, role type, and status.
|
||||
The User class also implements the Observer interface to handle notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
+8
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: AuthenticationManagementService.h
|
||||
Description: Declares the AuthenticationManagementService class which manages user authentication in the Vehicle Service Management System.
|
||||
Provides functionality for login, logout, password change, and retrieving the currently authenticated user.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "DataStore.h"
|
||||
|
||||
+8
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: InventoryManagementService.h
|
||||
Description: Declares the InventoryManagementService class which manages inventory operations in the Vehicle Service Management System.
|
||||
Provides functionality to retrieve, add, and remove inventory items, send low stock alerts, and handle notifications using the Observer pattern.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
+8
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: NotificationManagementService.h
|
||||
Description: Declares the NotificationManagementService abstract class which defines the contract for managing notifications in the Vehicle Service Management System.
|
||||
Implements the Subject interface and provides pure virtual methods for sending notifications and managing user subscriptions (attach/detach).
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Subject.h"
|
||||
|
||||
+46
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: PaymentManagementService.cpp
|
||||
Description: Implements the PaymentManagementService class which manages payment-related operations
|
||||
in the Vehicle Service Management System. Provides functionality for attaching/detaching observers,
|
||||
sending notifications, and issuing payment reminders based on invoice status and thresholds.
|
||||
Author: Trenser
|
||||
Date: 20-May-2026
|
||||
*/
|
||||
|
||||
#include <stdexcept>
|
||||
#include "PaymentManagementService.h"
|
||||
#include "Invoice.h"
|
||||
@@ -10,6 +19,14 @@
|
||||
|
||||
util::Map<std::string, User*> PaymentManagementService::m_observers{};
|
||||
|
||||
/*
|
||||
Function: attach
|
||||
Description: Attaches a user as an observer to the PaymentManagementService for receiving notifications.
|
||||
Parameters:
|
||||
- user: Pointer to the User object to be attached.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void PaymentManagementService::attach(User* user)
|
||||
{
|
||||
if (user)
|
||||
@@ -22,6 +39,14 @@ void PaymentManagementService::attach(User* user)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: detach
|
||||
Description: Detaches a user from the observer list of the PaymentManagementService.
|
||||
Parameters:
|
||||
- user: Pointer to the User object to be detached.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void PaymentManagementService::detach(User* user)
|
||||
{
|
||||
if (user)
|
||||
@@ -34,6 +59,18 @@ void PaymentManagementService::detach(User* user)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: sendNotification
|
||||
Description: Sends a notification to a user if they are registered as an observer.
|
||||
Parameters:
|
||||
- user: Pointer to the User object to receive the notification.
|
||||
- title: Title of the notification.
|
||||
- message: Message content of the notification.
|
||||
Returns:
|
||||
- void
|
||||
Throws:
|
||||
- std::runtime_error if notification creation fails.
|
||||
*/
|
||||
void PaymentManagementService::sendNotification(User* user, const std::string& title, const std::string& message)
|
||||
{
|
||||
if (user)
|
||||
@@ -60,6 +97,15 @@ void PaymentManagementService::sendNotification(User* user, const std::string& t
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: sendPaymentReminders
|
||||
Description: Iterates through all invoices in the datastore and sends payment reminders to customers
|
||||
whose invoices are pending beyond the configured threshold duration.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void PaymentManagementService::sendPaymentReminders()
|
||||
{
|
||||
auto& invoicesMap = m_dataStore.getInvoices();
|
||||
|
||||
+9
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: PaymentManagementService.h
|
||||
Description: Declares the PaymentManagementService class which manages payment operations in the Vehicle Service Management System.
|
||||
Provides functionality to generate invoices, retrieve customer invoices, complete payments, send payment reminders,
|
||||
and handle notifications using the Observer pattern.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
+37
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: ServiceManagementService.cpp
|
||||
Description: Implements the ServiceManagementService class which manages service-related operations
|
||||
in the Vehicle Service Management System. Provides functionality for attaching/detaching observers
|
||||
and sending notifications to users regarding service events.
|
||||
Author: Trenser
|
||||
Date: 20-May-2026
|
||||
*/
|
||||
|
||||
#include <stdexcept>
|
||||
#include "ServiceManagementService.h"
|
||||
#include "User.h"
|
||||
@@ -6,6 +15,14 @@
|
||||
|
||||
util::Map<std::string, User*> ServiceManagementService::m_observers{};
|
||||
|
||||
/*
|
||||
Function: attach
|
||||
Description: Attaches a user as an observer to the ServiceManagementService for receiving notifications.
|
||||
Parameters:
|
||||
- user: Pointer to the User object to be attached.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceManagementService::attach(User* user)
|
||||
{
|
||||
if (user)
|
||||
@@ -18,6 +35,14 @@ void ServiceManagementService::attach(User* user)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: detach
|
||||
Description: Detaches a user from the observer list of the ServiceManagementService.
|
||||
Parameters:
|
||||
- user: Pointer to the User object to be detached.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void ServiceManagementService::detach(User* user)
|
||||
{
|
||||
if (user)
|
||||
@@ -30,6 +55,18 @@ void ServiceManagementService::detach(User* user)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: sendNotification
|
||||
Description: Sends a notification to a user if they are registered as an observer.
|
||||
Parameters:
|
||||
- user: Pointer to the User object to receive the notification.
|
||||
- title: Title of the notification.
|
||||
- message: Message content of the notification.
|
||||
Returns:
|
||||
- void
|
||||
Throws:
|
||||
- std::runtime_error if notification creation fails.
|
||||
*/
|
||||
void ServiceManagementService::sendNotification(User* user, const std::string& title, const std::string& message)
|
||||
{
|
||||
if (user)
|
||||
|
||||
+9
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: ServiceManagementService.h
|
||||
Description: Declares the ServiceManagementService class which manages services, combo packages, service bookings, and job cards
|
||||
in the Vehicle Service Management System. Provides functionality to purchase services or packages, create and remove
|
||||
services, assign and complete jobs, cancel bookings, and handle notifications using the Observer pattern.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
+30
@@ -1,8 +1,27 @@
|
||||
/*
|
||||
File: UserManagementService.cpp
|
||||
Description: Implements the UserManagementService class which manages user-related operations
|
||||
in the Vehicle Service Management System. Provides functionality for retrieving user notifications
|
||||
and deleting notifications by ID.
|
||||
Author: Trenser
|
||||
Date: 20-May-2026
|
||||
*/
|
||||
|
||||
#include <stdexcept>
|
||||
#include "UserManagementService.h"
|
||||
#include "User.h"
|
||||
#include "Vector.h"
|
||||
|
||||
/*
|
||||
Function: getUserNotifications
|
||||
Description: Retrieves all notifications associated with a given user ID.
|
||||
Parameters:
|
||||
- userID: The unique ID of the user whose notifications are to be retrieved.
|
||||
Returns:
|
||||
- util::Vector<Notification*> containing all notifications for the user.
|
||||
Throws:
|
||||
- std::runtime_error if no user is found with the given UserID or if the User object is invalid.
|
||||
*/
|
||||
util::Vector<Notification*> UserManagementService::getUserNotifications(const std::string& userID)
|
||||
{
|
||||
auto& usersMap = m_dataStore.getUsers();
|
||||
@@ -28,6 +47,17 @@ util::Vector<Notification*> UserManagementService::getUserNotifications(const st
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: deleteNotification
|
||||
Description: Deletes a specific notification associated with a given user ID.
|
||||
Parameters:
|
||||
- notificationID: The unique ID of the notification to be deleted.
|
||||
- userID: The unique ID of the user whose notification is to be deleted.
|
||||
Returns:
|
||||
- void
|
||||
Throws:
|
||||
- std::runtime_error if no user is found with the given UserID or if no notification is found with the given NotificationID.
|
||||
*/
|
||||
void UserManagementService::deleteNotification(const std::string& notificationID, const std::string& userID)
|
||||
{
|
||||
auto& usersMap = m_dataStore.getUsers();
|
||||
|
||||
+8
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: UserManagementService.h
|
||||
Description: Declares the UserManagementService class which manages user-related operations in the Vehicle Service Management System.
|
||||
Provides functionality to create, update, retrieve, and remove users, as well as manage user notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include "Map.h"
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: Config.h
|
||||
Description: Defines configuration constants for system thresholds in the Vehicle Service Management System.
|
||||
Includes limits for inventory stock alerts and payment reminder intervals.
|
||||
Author: Trenser
|
||||
Date: 21-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
namespace config
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: Enums.h
|
||||
Description: Declares enumerations and utility functions for user types, payment modes, payment status,
|
||||
service job status, and state management in the Vehicle Service Management System.
|
||||
Provides string conversion and parsing functions for each enum type.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <stdexcept>
|
||||
|
||||
@@ -34,6 +43,14 @@ namespace util
|
||||
INACTIVE
|
||||
};
|
||||
|
||||
/*
|
||||
Function: getUserTypeString
|
||||
Description: Converts a UserType enum value to its corresponding string representation.
|
||||
Parameters:
|
||||
- type: UserType enum value.
|
||||
Returns:
|
||||
- std::string representing the UserType.
|
||||
*/
|
||||
inline std::string getUserTypeString(UserType type)
|
||||
{
|
||||
switch (type)
|
||||
@@ -48,6 +65,16 @@ namespace util
|
||||
throw std::invalid_argument("Invalid UserType");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getUserType
|
||||
Description: Converts a string value to its corresponding UserType enum.
|
||||
Parameters:
|
||||
- value: std::string representing the UserType.
|
||||
Returns:
|
||||
- UserType enum value.
|
||||
Throws:
|
||||
- std::invalid_argument if the string does not match a valid UserType.
|
||||
*/
|
||||
inline UserType getUserType(const std::string& value)
|
||||
{
|
||||
if (value == "ADMIN")
|
||||
@@ -65,6 +92,14 @@ namespace util
|
||||
throw std::invalid_argument("Invalid UserType string");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPaymentModeString
|
||||
Description: Converts a PaymentMode enum value to its corresponding string representation.
|
||||
Parameters:
|
||||
- mode: PaymentMode enum value.
|
||||
Returns:
|
||||
- std::string representing the PaymentMode.
|
||||
*/
|
||||
inline std::string getPaymentModeString(PaymentMode mode)
|
||||
{
|
||||
switch (mode)
|
||||
@@ -77,6 +112,16 @@ namespace util
|
||||
throw std::invalid_argument("Invalid PaymentMode");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPaymentMode
|
||||
Description: Converts a string value to its corresponding PaymentMode enum.
|
||||
Parameters:
|
||||
- value: std::string representing the PaymentMode.
|
||||
Returns:
|
||||
- PaymentMode enum value.
|
||||
Throws:
|
||||
- std::invalid_argument if the string does not match a valid PaymentMode.
|
||||
*/
|
||||
inline PaymentMode getPaymentMode(const std::string& value)
|
||||
{
|
||||
if (value == "ONLINE")
|
||||
@@ -90,6 +135,14 @@ namespace util
|
||||
throw std::invalid_argument("Invalid PaymentMode string");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPaymentStatusString
|
||||
Description: Converts a PaymentStatus enum value to its corresponding string representation.
|
||||
Parameters:
|
||||
- status: PaymentStatus enum value.
|
||||
Returns:
|
||||
- std::string representing the PaymentStatus.
|
||||
*/
|
||||
inline std::string getPaymentStatusString(PaymentStatus status)
|
||||
{
|
||||
switch (status)
|
||||
@@ -102,6 +155,16 @@ namespace util
|
||||
throw std::invalid_argument("Invalid PaymentStatus");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getPaymentStatus
|
||||
Description: Converts a string value to its corresponding PaymentStatus enum.
|
||||
Parameters:
|
||||
- value: std::string representing the PaymentStatus.
|
||||
Returns:
|
||||
- PaymentStatus enum value.
|
||||
Throws:
|
||||
- std::invalid_argument if the string does not match a valid PaymentStatus.
|
||||
*/
|
||||
inline PaymentStatus getPaymentStatus(const std::string& value)
|
||||
{
|
||||
if (value == "PENDING")
|
||||
@@ -117,6 +180,14 @@ namespace util
|
||||
throw std::invalid_argument("Invalid PaymentStatus string");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getServiceJobStatusString
|
||||
Description: Converts a ServiceJobStatus enum value to its corresponding string representation.
|
||||
Parameters:
|
||||
- status: ServiceJobStatus enum value.
|
||||
Returns:
|
||||
- std::string representing the ServiceJobStatus.
|
||||
*/
|
||||
inline std::string getServiceJobStatusString(ServiceJobStatus status)
|
||||
{
|
||||
switch (status)
|
||||
@@ -129,6 +200,16 @@ namespace util
|
||||
throw std::invalid_argument("Invalid ServiceJobStatus");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getServiceJobStatus
|
||||
Description: Converts a string value to its corresponding ServiceJobStatus enum.
|
||||
Parameters:
|
||||
- value: std::string representing the ServiceJobStatus.
|
||||
Returns:
|
||||
- ServiceJobStatus enum value.
|
||||
Throws:
|
||||
- std::invalid_argument if the string does not match a valid ServiceJobStatus.
|
||||
*/
|
||||
inline ServiceJobStatus getServiceJobStatus(const std::string& value)
|
||||
{
|
||||
if (value == "STARTED")
|
||||
@@ -142,6 +223,14 @@ namespace util
|
||||
throw std::invalid_argument("Invalid ServiceJobStatus string");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getStateString
|
||||
Description: Converts a State enum value to its corresponding string representation.
|
||||
Parameters:
|
||||
- status: State enum value.
|
||||
Returns:
|
||||
- std::string representing the State.
|
||||
*/
|
||||
inline std::string getStateString(State status)
|
||||
{
|
||||
switch (status)
|
||||
@@ -154,6 +243,16 @@ namespace util
|
||||
throw std::invalid_argument("Invalid State");
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getState
|
||||
Description: Converts a string value to its corresponding State enum.
|
||||
Parameters:
|
||||
- value: std::string representing the State.
|
||||
Returns:
|
||||
- State enum value.
|
||||
Throws:
|
||||
- std::invalid_argument if the string does not match a valid State.
|
||||
*/
|
||||
inline State getState(const std::string& value)
|
||||
{
|
||||
if (value == "ACTIVE")
|
||||
|
||||
@@ -1 +1,8 @@
|
||||
/*
|
||||
File: Utility.h
|
||||
Description:
|
||||
Author: Trenser
|
||||
Date: 20-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
@@ -1,8 +1,27 @@
|
||||
/*
|
||||
File: AdminMenu.cpp
|
||||
Description: Implements the AdminMenu class which provides the administrator’s console interface
|
||||
in the Vehicle Service Management System. Handles menu display, user input, and
|
||||
admin-specific operations such as inventory management, technician management,
|
||||
service creation, combo package management, job assignment, and notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "AdminMenu.h"
|
||||
#include "InputHelper.h"
|
||||
#include "OutputHelper.h"
|
||||
#include "MenuHelper.h"
|
||||
|
||||
/*
|
||||
Function: showMenu
|
||||
Description: Displays the admin menu in a loop until the user chooses to logout.
|
||||
Handles exceptions and ensures smooth user interaction.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void AdminMenu::showMenu()
|
||||
{
|
||||
bool isMenuActive = true;
|
||||
@@ -85,6 +104,14 @@ void AdminMenu::removeComboPackage()
|
||||
{
|
||||
}
|
||||
|
||||
/*
|
||||
Function: viewNotifications
|
||||
Description: Displays notifications for the admin and allows deletion of notifications.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void AdminMenu::viewNotifications()
|
||||
{
|
||||
viewAndDeleteNotification(m_controller);
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: AdminMenu.h
|
||||
Description: Declares the AdminMenu class which provides the administrative console menu in the Vehicle Service Management System.
|
||||
Supports operations such as inventory management, job assignment, service creation/removal, technician management,
|
||||
combo package handling, notification viewing, and account management functions like logout and password change.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include "Controller.h"
|
||||
|
||||
|
||||
@@ -1,8 +1,27 @@
|
||||
/*
|
||||
File: CustomerMenu.cpp
|
||||
Description: Implements the CustomerMenu class which provides the customer’s console interface
|
||||
in the Vehicle Service Management System. Handles menu display, user input, and
|
||||
customer-specific operations such as booking services, viewing history, managing payments,
|
||||
invoices, and notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "CustomerMenu.h"
|
||||
#include "InputHelper.h"
|
||||
#include "OutputHelper.h"
|
||||
#include "MenuHelper.h"
|
||||
|
||||
/*
|
||||
Function: showMenu
|
||||
Description: Displays the customer menu in a loop until the user chooses to logout.
|
||||
Handles exceptions and ensures smooth user interaction.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void CustomerMenu::showMenu()
|
||||
{
|
||||
bool isMenuActive = true;
|
||||
@@ -64,11 +83,27 @@ void CustomerMenu::viewInvoices()
|
||||
{
|
||||
}
|
||||
|
||||
/*
|
||||
Function: viewNotifications
|
||||
Description: Displays notifications for the customer and allows deletion of notifications.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void CustomerMenu::viewNotifications()
|
||||
{
|
||||
viewAndDeleteNotification(m_controller);
|
||||
}
|
||||
|
||||
/*
|
||||
Function: getNotificationPreference (static helper)
|
||||
Description: Helper function to configure notification preferences for a specific service.
|
||||
Parameters:
|
||||
- serviceName: Name of the service for which notifications are being configured.
|
||||
Returns:
|
||||
- bool: True if notifications are enabled, False if disabled.
|
||||
*/
|
||||
static bool getNotificationPreference(const std::string& serviceName)
|
||||
{
|
||||
int choice;
|
||||
@@ -94,6 +129,14 @@ static bool getNotificationPreference(const std::string& serviceName)
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: configureNotifications
|
||||
Description: Allows the customer to configure notification preferences for payment and service management.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void CustomerMenu::configureNotifications()
|
||||
{
|
||||
bool paymentServiceNotifications = getNotificationPreference("Payment Management Service");
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: CustomerMenu.h
|
||||
Description: Declares the CustomerMenu class which provides the customer-facing console menu in the Vehicle Service Management System.
|
||||
Supports operations such as account management, service selection, combo package booking, viewing service history,
|
||||
handling payments and invoices, and managing notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include "Controller.h"
|
||||
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: MenuHelper.h
|
||||
Description: Provides inline utility functions to support menu operations in the Vehicle Service Management System.
|
||||
Includes helper functions for selecting, displaying, and managing notifications, as well as
|
||||
integrating with the controller for user interactions.
|
||||
Author: Trenser
|
||||
Date: 21-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include <iomanip>
|
||||
#include "Vector.h"
|
||||
@@ -6,6 +15,16 @@
|
||||
#include "InputHelper.h"
|
||||
#include "OutputHelper.h"
|
||||
|
||||
/*
|
||||
Function: selectNotification
|
||||
Description: Displays a list of notifications with index, ID, title, and timestamp,
|
||||
then allows the user to select one by index.
|
||||
Parameters:
|
||||
- notifications: Vector of Notification pointers to be displayed.
|
||||
Returns:
|
||||
- const Notification* representing the selected notification.
|
||||
- nullptr if no notifications are available or if the selection is invalid.
|
||||
*/
|
||||
inline const Notification* selectNotification(const util::Vector<const Notification*>& notifications)
|
||||
{
|
||||
if (notifications.getSize() == 0)
|
||||
@@ -47,6 +66,14 @@ inline const Notification* selectNotification(const util::Vector<const Notificat
|
||||
return indexedNotifications[selectedIndex];
|
||||
}
|
||||
|
||||
/*
|
||||
Function: displayNotification
|
||||
Description: Displays detailed information about a single notification, including ID, title, timestamp, and message.
|
||||
Parameters:
|
||||
- notification: Pointer to the Notification object to be displayed.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
inline void displayNotification(const Notification* notification)
|
||||
{
|
||||
util::clear();
|
||||
@@ -62,6 +89,14 @@ inline void displayNotification(const Notification* notification)
|
||||
std::cout << "Message : " << notification->getMessage() << std::endl;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: viewAndDeleteNotification
|
||||
Description: Allows the user to view a notification and then delete it from the system using the controller.
|
||||
Parameters:
|
||||
- controller: Reference to the Controller object used to manage notifications.
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
inline void viewAndDeleteNotification(Controller& controller)
|
||||
{
|
||||
util::clear();
|
||||
|
||||
@@ -1,8 +1,26 @@
|
||||
/*
|
||||
File: TechnicianMenu.cpp
|
||||
Description: Implements the TechnicianMenu class which provides the technician’s console interface
|
||||
in the Vehicle Service Management System. Handles menu display, user input, and
|
||||
technician-specific operations such as completing jobs and viewing notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "TechnicianMenu.h"
|
||||
#include "InputHelper.h"
|
||||
#include "OutputHelper.h"
|
||||
#include "MenuHelper.h"
|
||||
|
||||
/*
|
||||
Function: showMenu
|
||||
Description: Displays the technician menu in a loop until the user chooses to logout.
|
||||
Handles exceptions and ensures smooth user interaction.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void TechnicianMenu::showMenu()
|
||||
{
|
||||
bool isMenuActive = true;
|
||||
@@ -36,6 +54,14 @@ void TechnicianMenu::completeJob()
|
||||
{
|
||||
}
|
||||
|
||||
/*
|
||||
Function: viewNotifications
|
||||
Description: Displays notifications for the technician and allows deletion of notifications.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void TechnicianMenu::viewNotifications()
|
||||
{
|
||||
viewAndDeleteNotification(m_controller);
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
/*
|
||||
File: TechnicianMenu.h
|
||||
Description: Declares the TechnicianMenu class which provides the technician-facing console menu in the Vehicle Service Management System.
|
||||
Supports operations such as viewing assigned jobs, completing jobs, and managing notifications.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include "Controller.h"
|
||||
|
||||
|
||||
@@ -1,7 +1,24 @@
|
||||
/*
|
||||
File: UserInterface.cpp
|
||||
Description: Implements the UserInterface class which provides the main entry point for the Vehicle Service Management System.
|
||||
Handles system checks, displays the main menu, and manages user operations such as login and customer registration.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#include "UserInterface.h"
|
||||
#include "InputHelper.h"
|
||||
#include "OutputHelper.h"
|
||||
|
||||
/*
|
||||
Function: run
|
||||
Description: Runs the Vehicle Service Management System interface.
|
||||
Performs system checks, displays the main menu, and processes user input until exit.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void UserInterface::run()
|
||||
{
|
||||
m_controller.runSystemChecks();
|
||||
@@ -27,6 +44,14 @@ void UserInterface::run()
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
Function: handleOperation
|
||||
Description: Processes the user’s menu choice and executes the corresponding action.
|
||||
Parameters:
|
||||
- choice: Integer representing the selected menu option.
|
||||
Returns:
|
||||
- bool: True if the menu should remain active, False if exit is selected.
|
||||
*/
|
||||
bool UserInterface::handleOperation(int choice)
|
||||
{
|
||||
switch (choice)
|
||||
@@ -47,11 +72,27 @@ bool UserInterface::handleOperation(int choice)
|
||||
return true;
|
||||
}
|
||||
|
||||
/*
|
||||
Function: login
|
||||
Description: Handles the login process for existing users.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void UserInterface::login()
|
||||
{
|
||||
|
||||
}
|
||||
|
||||
/*
|
||||
Function: registerCustomer
|
||||
Description: Handles the registration process for new customers.
|
||||
Parameters:
|
||||
- None
|
||||
Returns:
|
||||
- void
|
||||
*/
|
||||
void UserInterface::registerCustomer()
|
||||
{
|
||||
|
||||
|
||||
@@ -1,3 +1,12 @@
|
||||
/*
|
||||
File: UserInterface.h
|
||||
Description: Declares the UserInterface class which provides the main console interface for the Vehicle Service Management System.
|
||||
Handles user interactions such as login, customer registration, and role-based menu navigation
|
||||
for Admin, Technician, and Customer modules.
|
||||
Author: Trenser
|
||||
Date: 19-May-2026
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
#include "Controller.h"
|
||||
#include "AdminMenu.h"
|
||||
|
||||
Reference in New Issue
Block a user