changed defines to enum class

Author: AndrewBMadison

Simulator/Core/GPUModel.cpp

@@ -13,7 +13,6 @@
 #include "AllVertices.h"
 #include "Connections.h"
 #include "Global.h"
-#include "NvtxHelper.h"
 
 #ifdef PERFORMANCE_METRICS
 float g_time;
@@ -187,11 +186,9 @@ void GPUModel::calcSummationPoint()
    int blocksPerGrid
       = (Simulator::getInstance().getTotalVertices() + threadsPerBlock - 1) / threadsPerBlock;
 
-   nvtxPushColor("calcSummation", GREEN);
    calcSummationPointDevice<<<blocksPerGrid, threadsPerBlock>>>(
       Simulator::getInstance().getTotalVertices(), allVerticesDevice_, synapseIndexMapDevice_,
       allEdgesDevice_);
-   nvtxPop();
 }
 
 /// Update the connection of all the Neurons and Synapses of the simulation.

Simulator/Utils/NvtxHelper.cpp

@@ -1,14 +1,24 @@
+/**
+ * @file NvtxHelper.cpp
+ * 
+ * @ingroup Simulator/Utils
+ * 
+ * @brief Helper functions to enable nvtx profiling
+ * When ENABLE_NVTX is false the functions are replaced with blank inline functions which are removed by the compiler
+ * This file is only included in the utils library when ENABLE_CUDA=YES
+ */
+
 #include "NvtxHelper.h"
 #include <cuda_runtime.h>
 #include <nvToolsExt.h>
 
-void nvtxPushColor(const std::string &name, uint32_t color)
+void nvtxPushColor(const std::string &name, Color pColor)
 {
    nvtxEventAttributes_t eventAttrib = {};
    eventAttrib.version = NVTX_VERSION;
    eventAttrib.size = NVTX_EVENT_ATTRIB_STRUCT_SIZE;
    eventAttrib.colorType = NVTX_COLOR_ARGB;
-   eventAttrib.color = color;
+   eventAttrib.color = static_cast<uint32_t>(pColor);
    eventAttrib.messageType = NVTX_MESSAGE_TYPE_ASCII;
    eventAttrib.message.ascii = name.c_str();
 

Simulator/Utils/NvtxHelper.h

@@ -1,27 +1,38 @@
+/**
+ * @file NvtxHelper.h
+ * 
+ * @ingroup Simulator/Utils
+ * 
+ * @brief Helper functions to enable nvtx profiling
+ * When ENABLE_NVTX is false the functions are replaced with blank inline functions which are removed by the compiler
+ */
+
 #ifndef NVTX_HELPER_H
 #define NVTX_HELPER_H
 
 #include <cstdint>
 #include <string>
 
 // Define NVTX colors (ARGB format)
-#define RED 0xFFFF0000      // Red
-#define GREEN 0xFF00FF00    // Green
-#define BLUE 0xFF0000FF     // Blue
-#define YELLOW 0xFFFFFF00   // Yellow
-#define ORANGE 0xFFFFA500   // Orange
-#define PURPLE 0xFF800080   // Purple
+enum class Color : std::uint32_t {
+   RED = 0xFFFF0000,
+   GREEN = 0xFF00FF00,
+   BLUE = 0xFF0000FF,
+   YELLOW = 0xFFFFFF00,
+   ORANGE = 0xFFFFA500,
+   PURPLE = 0xFF800080
+};
 
 #ifdef ENABLE_NVTX
 
 // Function to push an NVTX range with a given name and color
-void nvtxPushColor(const std::string &name, uint32_t color);
+void nvtxPushColor(const std::string &name, Color pColor);
 
 // Function to pop the most recent NVTX range
 void nvtxPop();
 
 #else
-inline void nvtxPushColor(const std::string &, uint32_t)
+inline void nvtxPushColor(const std::string &, Color)
 {
 }
 inline void nvtxPop()