Add documentation headers across system modules
This commit is contained in:
@@ -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;
|
||||
|
||||
Reference in New Issue
Block a user