Add standardized documentation headers

Trenser.VehicleServiceSystem/Trenser.VehicleServiceSystem/models/JobCard.cpp

@@ -1,7 +1,22 @@
+/*
+File: JobCard.cpp
+Description: Implementation file containing the method definitions of the
+             JobCard class, including constructors, getters, and setters
+             for job card attributes.
+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 and default values.
+Parameter: None
+Return type: Constructor
+*/
 JobCard::JobCard()
     : m_id("JC" + std::to_string(++m_uid)),
     m_booking(nullptr),
@@ -9,6 +24,21 @@ JobCard::JobCard()
     m_technician(nullptr),
     m_status(util::ServiceJobStatus()) {}
 
+/*
+Function: JobCard
+Description: Parameterized constructor that initializes a job card with
+             booking, service, technician, and status details.
+Parameter: const std::string& bookingId - ID of the booking
+           ServiceBooking* booking - pointer to the booking object
+           Service* service - pointer to the service object
+           const std::string& serviceId - ID of the service
+           const std::string& technicianId - ID of the technician
+           User* technician - pointer to the technician object
+           const util::Timestamp& assignedDate - date when job was assigned
+           util::ServiceJobStatus status - current status of the job
+           const util::Timestamp& completionDate - date when job was completed
+Return type: Constructor
+*/
 JobCard::JobCard(const std::string& bookingId,
     ServiceBooking* booking,
     Service* service,
@@ -30,101 +60,221 @@ JobCard::JobCard(const std::string& bookingId,
     m_status(status),
     m_completionDate(completionDate) {}
 
+/*
+Function: getId
+Description: Retrieves the unique identifier of the job card.
+Parameter: None
+Return type: const std::string&
+*/
 const std::string& JobCard::getId() const
 {
     return m_id;
 }
 
+/*
+Function: getBookingId
+Description: Retrieves the booking ID associated with the job card.
+Parameter: None
+Return type: const std::string&
+*/
 const std::string& JobCard::getBookingId() const
 {
     return m_bookingId;
 }
 
+/*
+Function: getBooking
+Description: Retrieves the booking object associated with the job card.
+Parameter: None
+Return type: ServiceBooking*
+*/
 ServiceBooking* JobCard::getBooking() const
 {
     return m_booking;
 }
 
+/*
+Function: getService
+Description: Retrieves the service object associated with the job card.
+Parameter: None
+Return type: Service*
+*/
 Service* JobCard::getService() const
 {
     return m_service;
 }
 
+/*
+Function: getServiceId
+Description: Retrieves the service ID associated with the job card.
+Parameter: None
+Return type: const std::string&
+*/
 const std::string& JobCard::getServiceId() const
 {
     return m_serviceId;
 }
 
+/*
+Function: getTechnicianId
+Description: Retrieves the technician ID assigned to the job card.
+Parameter: None
+Return type: const std::string&
+*/
 const std::string& JobCard::getTechnicianId() const
 {
     return m_technicianId;
 }
 
+/*
+Function: getTechnician
+Description: Retrieves the technician object assigned to the job card.
+Parameter: None
+Return type: User*
+*/
 User* JobCard::getTechnician() const
 {
     return m_technician;
 }
 
+/*
+Function: getAssignedDate
+Description: Retrieves the date when the job was assigned.
+Parameter: None
+Return type: const util::Timestamp&
+*/
 const util::Timestamp& JobCard::getAssignedDate() const
 {
     return m_assignedDate;
 }
 
+/*
+Function: getStatus
+Description: Retrieves the current status of the job card.
+Parameter: None
+Return type: util::ServiceJobStatus
+*/
 util::ServiceJobStatus JobCard::getStatus() const
 {
     return m_status;
 }
 
+/*
+Function: getCompletionDate
+Description: Retrieves the completion date of the job card.
+Parameter: None
+Return type: const util::Timestamp&
+*/
 const util::Timestamp& JobCard::getCompletionDate() const
 {
     return m_completionDate;
 }
 
+/*
+Function: setId
+Description: Sets the unique identifier of the job card.
+Parameter: const std::string& id - new job card ID
+Return type: void
+*/
 void JobCard::setId(const std::string& id)
 {
     m_id = id;
 }
 
+/*
+Function: setBookingId
+Description: Sets the booking ID for the job card.
+Parameter: const std::string& bookingId - new booking ID
+Return type: void
+*/
 void JobCard::setBookingId(const std::string& bookingId)
 {
     m_bookingId = bookingId;
 }
 
+/*
+Function: setBooking
+Description: Sets the booking object for the job card.
+Parameter: ServiceBooking* booking - pointer to the booking object
+Return type: void
+*/
 void JobCard::setBooking(ServiceBooking* booking)
 {
     m_booking = booking;
 }
 
+/*
+Function: setService
+Description: Sets the service object for the job card.
+Parameter: Service* service - pointer to the service object
+Return type: void
+*/
 void JobCard::setService(Service* service)
 {
     m_service = service;
 }
 
+/*
+Function: setServiceId
+Description: Sets the service ID for the job card.
+Parameter: const std::string& serviceId - new service ID
+Return type: void
+*/
 void JobCard::setServiceId(const std::string& serviceId)
 {
     m_serviceId = serviceId;
 }
 
+/*
+Function: setTechnicianId
+Description: Sets the technician ID for the job card.
+Parameter: const std::string& technicianId - new technician ID
+Return type: void
+*/
 void JobCard::setTechnicianId(const std::string& technicianId)
 {
     m_technicianId = technicianId;
 }
 
+/*
+Function: setTechnician
+Description: Sets the technician object for the job card.
+Parameter: User* technician - pointer to the technician object
+Return type: void
+*/
 void JobCard::setTechnician(User* technician)
 {
     m_technician = technician;
 }
 
+/*
+Function: setAssignedDate
+Description: Sets the assigned date for the job card.
+Parameter: const util::Timestamp& assignedDate - new assigned date
+Return type: void
+*/
 void JobCard::setAssignedDate(const util::Timestamp& assignedDate)
 {
     m_assignedDate = assignedDate;
 }
 
+/*
+Function: setStatus
+Description: Sets the status of the job card.
+Parameter: util::ServiceJobStatus status - new job status
+Return type: void
+*/
 void JobCard::setStatus(util::ServiceJobStatus status)
 {
     m_status = status;
 }
 
+/*
+Function: setCompletionDate
+Description: Sets the completion date for the job card.
+Parameter: const util::Timestamp& completionDate - new completion date
+Return type: void
+*/
 void JobCard::setCompletionDate(const util::Timestamp& completionDate)
 {
     m_completionDate = completionDate;