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