comments and code trimming

Author: decheine

CMakeLists.txt

@@ -110,15 +110,15 @@ message("-- Boost include dir " ${Boost_INCLUDE_DIR})
 # add_library(ServiceXHandler ServiceXHandler.cpp ServiceXHandler.h)
 add_library(Math SHARED src/MathLibrary.cpp include/MathLibrary.h)
 
-add_library(XDataFrameLib SHARED
-        src/Hasher.cpp
-        src/MCache.cpp
-        src/MathLibrary.cpp
-        src/RDataFrameHandler.cpp
-        src/Request.cpp
-        src/ServiceXHandler.cpp
-        src/User.cpp
-)
+# add_library(XDataFrameLib SHARED
+#         src/Hasher.cpp
+#         src/MCache.cpp
+#         src/MathLibrary.cpp
+#         src/RDataFrameHandler.cpp
+#         src/Request.cpp
+#         src/ServiceXHandler.cpp
+#         src/User.cpp
+# )
 
 
 file(GLOB SOURCES src/*.cpp)
@@ -192,6 +192,11 @@ SET(CMAKE_CXX_FLAGS  "${CMAKE_CXX_FLAGS} ${GCC_COVERAGE_COMPILE_FLAGS}")
 #     include(CTest)
 # endif()
 
+# install(TARGETS XDataFrameLib
+#         LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+#         PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+# )
+
 install(TARGETS XDataFrame
         CONFIGURATIONS Debug
         RUNTIME DESTINATION ${CMAKE_BINARY_DIR}/../install/+bin)

exe/XDataFrame.cxx

@@ -42,13 +42,6 @@
 #include "Hasher.h"
 #include "MCache.h"
 
-
-// size_t writeFunction(void* ptr, size_t size, size_t nmemb, std::string* data) {
-//     data->append((char*)ptr, size * nmemb);
-//     return size * nmemb;
-// }
-
-
 // Helper Functions
 
 /**
@@ -73,8 +66,6 @@ std::string ReadJsonFromFile(std::string filename){
 }
 
 
-
-
 int main(int argc, char* argv[]){
     if(argc > 1){
         if (strcmp(argv[1], "--version") == 0) {
@@ -89,11 +80,8 @@ int main(int argc, char* argv[]){
 
     ServiceXHandler xHandler;
     std::vector<std::string> userYaml;
-    // User theUser();
     std::map<std::string, std::string> values = xHandler.parseYaml("/servicex.yaml");
 
-    // std::string jsonstringresponse = xHandler.FetchData("345974d4-d2ec-49bb-bef2-6683b7e461d5");
-
     Request testRequest;
 
     MCache cache;
@@ -124,7 +112,8 @@ int main(int argc, char* argv[]){
     RDataFrameHandler rdfHandler;
     rdfHandler.AddFiles(filenameList);
     ROOT::RDataFrame myDataFrame = rdfHandler.CreateRDataFrame();
-
+    auto d1 = myDataFrame.Display();
+    d1->Print();
     // rdfHandler.DisplayRDF();
 
     std::cout << "Finished\n";

include/MCache.h

@@ -12,7 +12,6 @@ class MCache {
 
     public:
         void LoadCache();
-        bool SaveRequestId(std::string hash, std::string request_id);
         bool CreateCacheEntry(std::string hash);
         bool WriteRequestID(std::string hash, std::string requestId);
         std::string ReadRequestId(std::string hash);

src/Hasher.cpp

@@ -44,26 +44,9 @@ std::string Hasher::GetHashOf(std::string filenameString){
 
         tmp << myFile.rdbuf();
         std::string s = tmp.str();
-        // std::cout << s << std::endl;
-
 
         hash.process_bytes(s.data(), s.size());
         hash.get_digest(digest);
 
-        // std::cout << "md5(" << s << ") = " << toString(digest) << '\n';
-
-        // std::cout << "returning " << toString(digest) << std::endl;
-
         return toString(digest);
-}
-
-
-//   while(std::getline(my_file, s)) {
-//             md5 hash;
-//             md5::digest_type digest;
-
-//             hash.process_bytes(s.data(), s.size());
-//             hash.get_digest(digest);
-
-//             std::cout << "md5(" << s << ") = " << toString(digest) << '\n';
-//         }
+}

src/MCache.cpp

@@ -50,24 +50,11 @@ bool MCache::EntryExists(std::string hash){
     }
 }
 
-
 /**
- * @brief Save request_id to the hash folder.
+ * @brief Sets the cache directory to the absolute file directory "directory"
  * 
- * @param hash 
- * @param request_id 
- * @return true 
- * @return false 
+ * @param directory 
  */
-bool MCache::SaveRequestId(std::string hash, std::string request_id){
-    const char* homeDir = getenv("HOME");
-
-    // Check if hash exists.
-    // If it doesn't, create it
-
-    return 0;
-}
-
 void MCache::SetCacheDir(std::string directory){
     cacheDir = directory;
 }
@@ -76,6 +63,12 @@ std::string MCache::GetCacheDir(){
     return cacheDir;
 }
 
+/**
+ * @brief Gets the request_id of a given hash entry
+ * 
+ * @param hash 
+ * @return std::string 
+ */
 std::string MCache::ReadRequestId(std::string hash){
     fs::path hashFolderPath = fs::path(cacheDir + "/" + hash);
     if( fs::is_directory(hashFolderPath)) {
@@ -103,6 +96,15 @@ std::string MCache::ReadRequestId(std::string hash){
     return "";
 }
 
+/**
+ * @brief Writes a given request_id into the cache entry corresponding to a given hash. 
+ * Stores this in a file in the hash folder called "request_id.txt"
+ * 
+ * @param hash 
+ * @param requestId 
+ * @return true 
+ * @return false 
+ */
 bool MCache::WriteRequestID(std::string hash, std::string requestId){
     fs::path cachePath = fs::path(cacheDir);
     if(fs::is_directory(cachePath)){
@@ -133,6 +135,13 @@ bool MCache::WriteRequestID(std::string hash, std::string requestId){
     return 0;
 }
 
+/**
+ * @brief Creates an entry in the cache from a given hash
+ * 
+ * @param hash 
+ * @return true 
+ * @return false 
+ */
 bool MCache::CreateCacheEntry(std::string hash){
     // std::string tmpDir = fs::temp_directory_path();
     fs::path home = fs::path(std::getenv("HOME"));

src/RDataFrameHandler.cpp

@@ -13,30 +13,15 @@ Much of this (for now) takes from theh RDataFrame tutorial
 
 #include "RDataFrameHandler.h"
 
-void RDataFrameHandler::fill_tree(const char *treeName, const char *fileName){
-    ROOT::RDataFrame d(10);
-    int i(0);
-    d.Define("b1", [&i]() { return (double)i; })
-        .Define("b2",
-                [&i]() {
-                    auto j = i * i;
-                    ++i;
-                    return j;
-                })
-        .Snapshot(treeName, fileName);
-    return;
-}
-
 /**
  * @brief Creates the RDataFrame objecct with the file list in the RDataFrameHandler
  * Returns 0 if successful
  * Returns 1 if not successful
  * @return ROOT::RDataFrame
  */
 ROOT::RDataFrame RDataFrameHandler::CreateRDataFrame(){
-    // auto fileName = "df001_introduction.root";
+    // TODO: read the files fetched and get the tree name they have
     auto treeName = "treeme";
-    // fill_tree(treeName, fileName);
 
     // We read the tree from the file and create a RDataFrame, a class that
     // allows us to interact with the data contained in the tree.
@@ -48,6 +33,8 @@ ROOT::RDataFrame RDataFrameHandler::CreateRDataFrame(){
 
     RDataFrameObject = &df;
 
+    // Testing for printing out the RDF.
+
     std::cout << "Displaying\n";
 
     auto d1 = df.Display();
@@ -90,9 +77,7 @@ int RDataFrameHandler::AddFiles(std::vector<std::string> filenames){
     return 0;
 }
 
-RDataFrameHandler::RDataFrameHandler(){
-    
-}
+RDataFrameHandler::RDataFrameHandler(){}
 
 
 void RDataFrameHandler::DisplayRDF(){

src/Request.cpp

@@ -20,6 +20,12 @@
 
 #include "MCache.h"
 
+/**
+ * @brief Gets the status of a servicex endpoint. Only for one hardcoded endpoint, can be extended/refactored
+ * to fetch the status from an endpoint specified by an argument. Not needed at the moment.
+ * 
+ * @return std::string 
+ */
 std::string Request::GetStatus(){
     // Check if the endpoint exists
 

src/ServiceXHandler.cpp

@@ -90,12 +90,6 @@ std::map<std::string, std::string> ServiceXHandler::parseYaml(std::string target
     std::ifstream myfile (fullDir);
     if (myfile.is_open())
     {
-        // std::string fields;
-        // while ( getline (myfile,line) ){
-        //     std::cout << line << '\n';
-        //     fields << line << std::endl;
-        // }
-
         std::string content;
         content.assign( (std::istreambuf_iterator<char>(myfile) ),
                 (std::istreambuf_iterator<char>()    ) );   
@@ -127,31 +121,13 @@ std::map<std::string, std::string> ServiceXHandler::parseYaml(std::string target
 
         // TODO: Needs to search and verify that the nodes are there before they are referenced.
 
-        // show_val(tree["sub"].child(0)[0]);  // "foo: 1"
-        // show_val(subFirst[0]);
-        // show_keyval(api_endpointNode[0]);
-        // std::cout << "Number of children of endpoint: " << api_endpointNode.num_children() << std::endl;
-
-        // show_val(typeNode[0]);
-        // show_val(tokenNode[0]);
-
         show_keyval(endpointNode);
-        // show_keyval(tokenNode);
-        // show_keyval(typeNode);
 
         std::string endpoint;
         std::string token;
         std::string mytype;
 
         c4::from_chars(endpointNode.val(), &endpoint);
-        // c4::from_chars(tokenNode.val(), &token);
-        // c4::from_chars(typeNode.val(), &mytype);
-
-        // std::cout << "Endpoint: " << endpoint << std::endl;
-        // std::cout << "Token: " << token << std::endl;
-        // std::cout << "Type: " << mytype << std::endl;
-
-
 
         myfile.close();
 
@@ -170,6 +146,12 @@ std::map<std::string, std::string> ServiceXHandler::parseYaml(std::string target
     return properties;
 }
 
+/**
+ * @brief Deprecated. Fetched data from a hardcoded servicex endpoint.
+ * 
+ * @param request_id 
+ * @return std::string 
+ */
 std::string ServiceXHandler::FetchData(std::string request_id){
     // CURL *curl = curl_easy_init();
     // std::string request_id = "345974d4-d2ec-49bb-bef2-6683b7e461d5";
@@ -288,8 +270,8 @@ Json::Value ServiceXHandler::JsonFromStr(std::string jsonStr){
 
 
 /**
- * @brief Gets MinIO bucket data and prints it. For now, uses a hard-coded bucket name and 
- * request_id
+ * @brief Gets MinIO bucket data and prints it. Takes in a bucket name (request_id) and a pathkey
+ * that specifies where the program will write the downloaded files to disk.
  * 
  * @return A list of downloaded file names
  */
@@ -382,25 +364,8 @@ std::vector<std::string> ServiceXHandler::GetMinIOData(std::string bucketName, s
     return filenames;
 }
 
-
-
-// bool ServiceXHandler::GetMd5(std::string &str_md5, const char  * const buffer, size_t buffer_size){
-//     if (buffer == nullptr){
-//         return false;
-//     }
-//     boost::uuids::detail::md5 boost_md5;
-//     boost_md5.process_bytes(buffer, buffer_size);
-//     boost::uuids::detail::md5::digest_type digest;
-//     boost_md5.get_digest(digest);
-//     const auto char_digest = reinterpret_cast<const char*>(&digest);
-//     str_md5.clear();
-//     boost::algorithm::hex(char_digest,char_digest+sizeof(boost::uuids::detail::md5::digest_type), std::back_inserter(str_md5));
-//     return true;
-// }
-
-
 /**
- * @brief 
+ * @brief Stub
  * 
  */
 void HashSubmitJson(){}

src/User.cpp

@@ -26,6 +26,8 @@
 
 #include <User.h>
 
+// DEPRECATED ?
+
 /**
  * @brief Creates a folder for a new user if it doesn't exist already
  *