guts
gutilities.h
Go to the documentation of this file.
1 #ifndef GUTILITIES_H
2 #define GUTILITIES_H 1
3 
4 // conventions
5 #include "gutsConventions.h"
6 
7 // c++
8 #include <vector>
9 #include <string>
10 #include <map>
11 
12 namespace gutilities {
13 
14  using std::string;
15  using std::vector;
16  using std::map;
17 
27  std::string removeLeadingAndTrailingSpacesFromString(const std::string &input);
28 
37  std::string removeAllSpacesFromString(const std::string &str);
38 
47  std::string getFileFromPath(const std::string &path);
48 
57  std::string getDirFromPath(const std::string &path);
58 
68  std::vector <std::string> getStringVectorFromString(const std::string &input);
69 
81  std::string replaceCharInStringWithChars(const std::string &input, const std::string &toReplace, const std::string &replacement);
82 
94  std::string replaceCharInStringWithChars(const std::string &input, const std::string &toReplace, const std::string &replacement);
95 
96 
108  string replaceAllStringsWithString(const string &source, const string &from, const string &to);
109 
121  string fillDigits(const string &word, const string &c, int ndigits);
122 
133  double getG4Number(const string& v, bool warnIfNotUnit = false);
134 
144  double getG4Number(double input, const string& unit);
145 
155  vector<double> getG4NumbersFromStringVector(const vector<string>& vstring, bool warnIfNotUnit = false);
156 
166  vector<double> getG4NumbersFromString(const string& vstring, bool warnIfNotUnit = false);
167 
178  string parseFileAndRemoveComments(const string& filename, const string& commentChars = "#", int verbosity = 0);
179 
180 
191  string retrieveStringBetweenChars(const string& input, const string& firstDelimiter, const string& secondDelimiter);
192 
202  vector<string> getStringVectorFromStringWithDelimiter(const string& input, const string& x);
203 
212  bool directoryExists(const std::string &path);
213 
214 
224  string searchForDirInLocations(const string& dirName, const vector<string>& possibleLocations);
225 
226 
236  bool hasExtension(const string& filename, const vector<string>& extensions);
237 
247  vector<string> getListOfFilesInDirectory(const string& dirName, const vector<string>& extensions);
248 
257  string convertToLowercase(const string &str);
258 
269  template<class KEY, class VALUE>
270  vector <KEY> getKeys(const map <KEY, VALUE> &map);
271 
275  enum randomModel {
279  sphere
280  };
281 
292  randomModel stringToRandomModel(const std::string& str);
293 
294 
295 };
296 
297 
298 #endif
string replaceAllStringsWithString(const string &source, const string &from, const string &to)
Replaces all occurrences of a substring with another string.
Definition: gutilities.cc:80
double getG4Number(const string &v, bool warnIfNotUnit)
Converts a string representation of a number with optional units to a double.
Definition: gutilities.cc:117
bool hasExtension(const std::string &filename, const std::vector< std::string > &extensions)
Checks if a filename has one of the specified extensions.
Definition: gutilities.cc:328
vector< double > getG4NumbersFromString(const string &vstring, bool warnIfNotUnit)
Converts a comma-separated string of numbers with units to a vector of doubles.
Definition: gutilities.cc:207
string removeAllSpacesFromString(const std::string &str)
Removes all spaces from a string.
Definition: gutilities.cc:33
vector< string > getStringVectorFromStringWithDelimiter(const string &input, const string &x)
Splits a string into a vector of substrings using a specified delimiter.
Definition: gutilities.cc:250
randomModel stringToRandomModel(const std::string &str)
Converts a string to a corresponding randomModel enum value.
Definition: gutilities.cc:379
vector< string > getListOfFilesInDirectory(const string &dirName, const vector< string > &extensions)
Retrieves a list of files with specific extensions from a directory.
Definition: gutilities.cc:338
vector< double > getG4NumbersFromStringVector(const vector< string > &vstring, bool warnIfNotUnit)
Converts a vector of strings representing numbers with units to a vector of doubles.
Definition: gutilities.cc:196
string retrieveStringBetweenChars(const string &input, const string &firstDelimiter, const string &secondDelimiter)
Retrieves a substring between two specified delimiters in a string.
Definition: gutilities.cc:240
string replaceCharInStringWithChars(const std::string &input, const std::string &toReplace, const std::string &replacement)
Replaces all occurrences of specified characters in a string with another string.
Definition: gutilities.cc:68
string fillDigits(const string &word, const string &c, int ndigits)
Pads a string with a specified character until it reaches a desired length.
Definition: gutilities.cc:102
randomModel
Enumeration of random models.
Definition: gutilities.h:275
@ gaussian
Gaussian distribution.
Definition: gutilities.h:277
@ uniform
Uniform distribution.
Definition: gutilities.h:276
@ sphere
Sphere distribution.
Definition: gutilities.h:279
@ cosine
Cosine distribution.
Definition: gutilities.h:278
string getDirFromPath(const std::string &path)
Extracts the directory path from a given file path.
Definition: gutilities.cc:48
string convertToLowercase(const string &str)
Converts a string to lowercase.
Definition: gutilities.cc:360
bool directoryExists(const std::string &path)
Checks if a directory exists at the given path.
Definition: gutilities.cc:309
vector< KEY > getKeys(const map< KEY, VALUE > &map)
Retrieves all keys from a map.
Definition: gutilities.cc:368
string removeLeadingAndTrailingSpacesFromString(const std::string &input)
Removes leading and trailing spaces and tabs from a string.
Definition: gutilities.cc:20
string searchForDirInLocations(const string &dirName, const vector< string > &possibleLocations)
Searches for a directory within a list of possible locations.
Definition: gutilities.cc:317
string parseFileAndRemoveComments(const string &filename, const string &commentChars, int verbosity)
Parses a file and removes all lines containing specified comment characters.
Definition: gutilities.cc:212
string getFileFromPath(const std::string &path)
Extracts the filename from a given file path.
Definition: gutilities.cc:39
vector< std::string > getStringVectorFromString(const std::string &input)
Splits a string into a vector of strings using spaces as delimiters.
Definition: gutilities.cc:54