google-labs-jules[bot]
86488cec48
Key changes include: - **Added Comprehensive Doxygen Comments:** - Reviewed all header files in `include/MedicalLib/`. - Added Doxygen comments for public methods, structs, and their member variables to ensure full API coverage as per the project's coding standards. - Addressed all Doxygen warnings related to undocumented public members. - **Restructured Sphinx Documentation:** - Created a new `docs/api/` directory to house detailed documentation for each component. - Replaced the single `api.rst` file with a well-organized structure using a `toctree`. - Created individual `.rst` pages for each organ, class, and major component. - **Enabled Graph Generation:** - Configured Doxygen to generate class hierarchy and collaboration graphs. - Ensured the build process includes these graphs in the final documentation, providing visual context for the library's structure. - **Verified Build Process:** - Installed all necessary dependencies (`doxygen`, `graphviz`, python packages). - Successfully ran the Doxygen and Sphinx build process to generate the final HTML documentation, ensuring all changes are correctly integrated. This work results in a professional, navigable, and maintainable documentation site for the MedicalLib library.
118 lines
4.1 KiB
C++
118 lines
4.1 KiB
C++
#pragma once
|
|
|
|
#include <vector>
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
// Forward-declare the Organ class to avoid circular dependencies
|
|
class Organ;
|
|
|
|
/**
|
|
* @brief Represents blood pressure values.
|
|
*/
|
|
struct BloodPressure {
|
|
double systolic_mmHg = 120.0; ///< Systolic pressure in mmHg.
|
|
double diastolic_mmHg = 80.0; ///< Diastolic pressure in mmHg.
|
|
};
|
|
|
|
/**
|
|
* @brief Represents the composition of the patient's blood.
|
|
*/
|
|
struct Blood {
|
|
BloodPressure bloodPressure; ///< The patient's blood pressure.
|
|
double oxygenSaturation = 98.0; ///< Peripheral oxygen saturation (SpO2) as a percentage.
|
|
double co2PartialPressure_mmHg = 40.0; ///< Partial pressure of CO2 in arterial blood (PaCO2).
|
|
double glucose_mg_per_dL = 100.0; ///< Blood glucose level in mg/dL.
|
|
double angiotensin_au = 0.0; ///< Concentration of angiotensin, a hormone for BP control, in arbitrary units.
|
|
double toxins_au = 0.0; ///< Concentration of toxins in the blood, in arbitrary units.
|
|
};
|
|
|
|
/**
|
|
* @brief Holds all the vital signs and other medical information for a patient.
|
|
*/
|
|
struct Patient {
|
|
int patientId; ///< The unique ID for the patient.
|
|
Blood blood; ///< The patient's blood composition and vitals.
|
|
std::vector<std::unique_ptr<Organ>> organs; ///< A collection of all the patient's simulated organs.
|
|
};
|
|
|
|
// Define MEDICAL_LIB_EXPORT for exporting symbols from the DLL
|
|
#if defined(_WIN32)
|
|
#if defined(MEDICAL_LIB_EXPORT)
|
|
#define MEDICAL_LIB_API __declspec(dllexport)
|
|
#else
|
|
#define MEDICAL_LIB_API __declspec(dllimport)
|
|
#endif
|
|
#else
|
|
#define MEDICAL_LIB_API
|
|
#endif
|
|
|
|
/**
|
|
* @brief Initializes a new patient with baseline vital signs and a 12-lead heart.
|
|
* @param patientId The ID for the new patient.
|
|
* @return A Patient struct with default healthy values.
|
|
*/
|
|
MEDICAL_LIB_API Patient initializePatient(int patientId);
|
|
|
|
/**
|
|
* @brief Initializes a new patient with a specific number of heart leads.
|
|
* @param patientId The ID for the new patient.
|
|
* @param numHeartLeads The number of EKG leads for the heart.
|
|
* @return A Patient struct with default healthy values.
|
|
*/
|
|
MEDICAL_LIB_API Patient initializePatient(int patientId, int numHeartLeads);
|
|
|
|
/**
|
|
* @brief Updates the patient's vital signs based on the time elapsed.
|
|
* @param patient The patient to update.
|
|
* @param deltaTime_s The time elapsed in seconds.
|
|
*/
|
|
MEDICAL_LIB_API void updatePatient(Patient& patient, double deltaTime_s);
|
|
|
|
/**
|
|
* @brief Gets a summary of a specific organ's vitals.
|
|
* @param patient The patient to get the organ summary from.
|
|
* @param organType The type of the organ to get the summary for.
|
|
* @return A string containing the organ's vital signs, or an empty string if not found.
|
|
*/
|
|
MEDICAL_LIB_API std::string getOrganSummary(const Patient& patient, const std::string& organType);
|
|
|
|
/**
|
|
* @brief Gets a consolidated summary of all the patient's organ vitals.
|
|
* @param patient The patient to get the summary from.
|
|
* @return A string containing the vital signs of all the patient's organs.
|
|
*/
|
|
MEDICAL_LIB_API std::string getPatientSummary(const Patient& patient);
|
|
|
|
/**
|
|
* @brief Gets a pointer to a specific organ by its type.
|
|
* @tparam T The type of the organ to get.
|
|
* @param patient The patient to get the organ from.
|
|
* @return A pointer to the organ if found, otherwise nullptr.
|
|
*/
|
|
template<typename T>
|
|
T* getOrgan(Patient& patient) {
|
|
for (auto& organ : patient.organs) {
|
|
if (T* specificOrgan = dynamic_cast<T*>(organ.get())) {
|
|
return specificOrgan;
|
|
}
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
/**
|
|
* @brief Gets a const pointer to a specific organ by its type.
|
|
* @tparam T The type of the organ to get.
|
|
* @param patient The patient to get the organ from.
|
|
* @return A const pointer to the organ if found, otherwise nullptr.
|
|
*/
|
|
template<typename T>
|
|
const T* getOrgan(const Patient& patient) {
|
|
for (const auto& organ : patient.organs) {
|
|
if (const T* specificOrgan = dynamic_cast<const T*>(organ.get())) {
|
|
return specificOrgan;
|
|
}
|
|
}
|
|
return nullptr;
|
|
}
|