diff --git a/Doxygen/doxyfig b/Doxygen/doxyfig index 5d82acb..4fdd863 100644 --- a/Doxygen/doxyfig +++ b/Doxygen/doxyfig @@ -1052,7 +1052,7 @@ INLINE_SOURCES = YES # Fortran comments will always remain visible. # The default value is: YES. -STRIP_CODE_COMMENTS = YES +STRIP_CODE_COMMENTS = NO # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # entity all documented functions referencing it will be listed. diff --git a/docs/DataType_8h.html b/docs/DataType_8h.html index fa400dc..583ea89 100644 --- a/docs/DataType_8h.html +++ b/docs/DataType_8h.html @@ -148,7 +148,7 @@ Functions diff --git a/docs/DataType_8h_source.html b/docs/DataType_8h_source.html index 64a84a3..d1ac3d5 100644 --- a/docs/DataType_8h_source.html +++ b/docs/DataType_8h_source.html @@ -82,7 +82,9 @@ $(function() {
2 #include <string>
3 
4 namespace Hazelnp
-
5 {
+
5 {
+
6  /** The different data types a paramater can be
+
7  */
8  enum class DATA_TYPE
9  {
10  VOID,
@@ -126,7 +128,7 @@ $(function() {
Hazelnp::DataTypeToString
static std::string DataTypeToString(DATA_TYPE type)
Definition: DataType.h:17
diff --git a/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index f480e25..370e8cf 100644 --- a/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html +++ b/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html @@ -77,7 +77,7 @@ $(function() { diff --git a/docs/FloatValue_8cpp.html b/docs/FloatValue_8cpp.html index aa58af6..2bf8dd3 100644 --- a/docs/FloatValue_8cpp.html +++ b/docs/FloatValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for FloatValue.cpp: diff --git a/docs/FloatValue_8cpp_source.html b/docs/FloatValue_8cpp_source.html index 485d3c3..115d6e5 100644 --- a/docs/FloatValue_8cpp_source.html +++ b/docs/FloatValue_8cpp_source.html @@ -173,7 +173,7 @@ $(function() {
Hazelnp::FloatValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:49
diff --git a/docs/FloatValue_8h.html b/docs/FloatValue_8h.html index d57d92e..07e62ef 100644 --- a/docs/FloatValue_8h.html +++ b/docs/FloatValue_8h.html @@ -123,7 +123,7 @@ Namespaces diff --git a/docs/FloatValue_8h_source.html b/docs/FloatValue_8h_source.html index 8cd122e..46adb17 100644 --- a/docs/FloatValue_8h_source.html +++ b/docs/FloatValue_8h_source.html @@ -83,31 +83,42 @@ $(function() {
3 #include <ostream>
4 
5 namespace Hazelnp
-
6 {
+
6 {
+
7  /** Specializations for floating point values (uses long double)
+
8  */
9  class FloatValue : public Value
10  {
11  public:
12  FloatValue(const long double& value);
13  ~FloatValue() override {};
-
14 
-
16  Value* Deepcopy() const override;
-
17 
-
19  std::string GetAsOsString() const override;
-
20 
-
22  const long double& GetValue() const;
+
14 
+
15  //! Will return a deeopopy of this object
+
16  Value* Deepcopy() const override;
+
17 
+
18  //! Will return a string suitable for an std::ostream;
+
19  std::string GetAsOsString() const override;
+
20 
+
21  //! Will return the raw value
+
22  const long double& GetValue() const;
23 
24  operator long double() const;
25  operator double() const;
-
26 
-
28  long long int GetInt64() const override;
-
30  int GetInt32() const override;
-
31 
-
33  long double GetFloat64() const override;
-
35  double GetFloat32() const override;
-
36 
-
38  std::string GetString() const override;
-
39 
-
41  const std::vector<Value*>& GetList() const override;
+
26 
+
27  //! Will return the data as a long long int
+
28  long long int GetInt64() const override;
+
29  //! Will return the data as an int
+
30  int GetInt32() const override;
+
31 
+
32  //! Will return the data as a long double
+
33  long double GetFloat64() const override;
+
34  //! Will return the data as a double
+
35  double GetFloat32() const override;
+
36 
+
37  //! Will return the data as a string
+
38  std::string GetString() const override;
+
39 
+
40  //! Throws HazelnuppValueNotConvertibleException
+
41  const std::vector<Value*>& GetList() const override;
42 
43  private:
44  long double value;
@@ -131,7 +142,7 @@ $(function() {
Hazelnp::FloatValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:49
diff --git a/docs/HazelnuppException_8h.html b/docs/HazelnuppException_8h.html index e351ef3..5608a2f 100644 --- a/docs/HazelnuppException_8h.html +++ b/docs/HazelnuppException_8h.html @@ -137,7 +137,7 @@ Namespaces diff --git a/docs/HazelnuppException_8h_source.html b/docs/HazelnuppException_8h_source.html index 3296064..9a61431 100644 --- a/docs/HazelnuppException_8h_source.html +++ b/docs/HazelnuppException_8h_source.html @@ -82,14 +82,17 @@ $(function() {
2 #include <stdexcept>
3 
4 namespace Hazelnp
-
5 {
+
5 {
+
6  /** Generic hazelnupp exception
+
7  */
8  class HazelnuppException : public std::exception
9  {
10  public:
11  HazelnuppException() {};
12  HazelnuppException(const std::string& msg) : message{ msg } {};
-
13 
-
15  const std::string& What() const
+
13 
+
14  //! Will return an error message
+
15  const std::string& What() const
16  {
17  return message;
18  }
@@ -97,35 +100,45 @@ $(function() {
20  protected:
21  std::string message;
22  };
-
23 
+
23 
+
24  /** Gets thrown when an non-existent key gets dereferenced
+
25  */
26  class HazelnuppInvalidKeyException : public HazelnuppException
27  {
28  public:
29  HazelnuppInvalidKeyException() : HazelnuppException() {};
30  HazelnuppInvalidKeyException(const std::string& msg) : HazelnuppException(msg) {};
31  };
-
32 
+
32 
+
33  /** Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible
+
34  */
35  class HazelnuppValueNotConvertibleException : public HazelnuppException
36  {
37  public:
38  HazelnuppValueNotConvertibleException() : HazelnuppException() {};
39  HazelnuppValueNotConvertibleException(const std::string& msg) : HazelnuppException(msg) {};
40  };
-
41 
+
41 
+
42  /** Gets thrown something bad happens because of parameter constraints
+
43  */
44  class HazelnuppConstraintException : public HazelnuppException
45  {
46  public:
47  HazelnuppConstraintException() : HazelnuppException() {};
48  HazelnuppConstraintException(const std::string& msg) : HazelnuppException(msg) {};
49  };
-
50 
+
50 
+
51  /** Gets thrown when a parameter is of a type that does not match the required type, and is not convertible to it
+
52  */
53  class HazelnuppConstraintTypeMissmatch : public HazelnuppConstraintException
54  {
55  public:
56  HazelnuppConstraintTypeMissmatch() : HazelnuppConstraintException() {};
57  HazelnuppConstraintTypeMissmatch(const std::string& msg) : HazelnuppConstraintException(msg) {};
58  };
-
59 
+
59 
+
60  /** Gets thrown when a parameter constrained to be required is not provided, and has no default value set
+
61  */
62  class HazelnuppConstraintMissingValue : public HazelnuppConstraintException
63  {
64  public:
@@ -157,7 +170,7 @@ $(function() {
Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException
HazelnuppInvalidKeyException()
Definition: HazelnuppException.h:29
diff --git a/docs/Hazelnupp_8cpp.html b/docs/Hazelnupp_8cpp.html index c88d829..07fcced 100644 --- a/docs/Hazelnupp_8cpp.html +++ b/docs/Hazelnupp_8cpp.html @@ -122,7 +122,7 @@ Include dependency graph for Hazelnupp.cpp: diff --git a/docs/Hazelnupp_8cpp_source.html b/docs/Hazelnupp_8cpp_source.html index 9ec85f2..f770d31 100644 --- a/docs/Hazelnupp_8cpp_source.html +++ b/docs/Hazelnupp_8cpp_source.html @@ -698,7 +698,7 @@ $(function() {
StringTools.h
diff --git a/docs/Hazelnupp_8h.html b/docs/Hazelnupp_8h.html index 2752402..6b81be2 100644 --- a/docs/Hazelnupp_8h.html +++ b/docs/Hazelnupp_8h.html @@ -128,7 +128,7 @@ Namespaces diff --git a/docs/Hazelnupp_8h_source.html b/docs/Hazelnupp_8h_source.html index 8aa5e04..79ea7a5 100644 --- a/docs/Hazelnupp_8h_source.html +++ b/docs/Hazelnupp_8h_source.html @@ -85,7 +85,9 @@ $(function() {
5 #include <vector>
6 
7 namespace Hazelnp
-
8 {
+
8 {
+
9  /** The main class to interface with
+
10  */
11  class Hazelnupp
12  {
13  public:
@@ -93,77 +95,113 @@ $(function() {
15  Hazelnupp(const int argc, const char* const* argv);
16 
17  ~Hazelnupp();
-
18 
-
20  void Parse(const int argc, const char* const* argv);
-
21 
-
23  const std::string& GetExecutableName() const;
-
24 
-
26  const Value& operator[](const std::string& key) const;
-
27 
-
29  bool HasParam(const std::string& key) const;
+
18 
+
19  //! Will parse command line arguments
+
20  void Parse(const int argc, const char* const* argv);
+
21 
+
22  //! Will return argv[0], the name of the executable.
+
23  const std::string& GetExecutableName() const;
+
24 
+
25  //! Will return the value given a key
+
26  const Value& operator[](const std::string& key) const;
+
27 
+
28  //! Will check wether a parameter exists given a key, or not
+
29  bool HasParam(const std::string& key) const;
30 
-
31  // Abbreviations
+
31  // Abbreviations
+
32  //! Will register an abbreviation (like -f for --force)
33  void RegisterAbbreviation(const std::string& abbrev, const std::string& target);
-
34 
-
36  const std::string& GetAbbreviation(const std::string& abbrev) const;
-
37 
-
39  bool HasAbbreviation(const std::string& abbrev) const;
-
40 
-
42  void ClearAbbreviations();
-
43 
-
45  void RegisterConstraints(const std::vector<ParamConstraint>& constraints);
-
46 
-
48  void ClearConstraints();
-
49 
-
52  void SetCrashOnFail(bool crashOnFail);
-
53 
-
55  bool GetCrashOnFail() const;
-
56 
-
58  void SetCatchHelp(bool catchHelp);
-
59 
-
61  bool GetCatchHelp() const;
-
62 
-
64  void SetBriefDescription(const std::string& description);
-
65 
-
67  const std::string& GetBriefDescription();
-
68 
-
71  void RegisterDescription(const std::string& parameter, const std::string& description);
-
72 
-
75  const std::string GetDescription(const std::string& parameter) const;
-
76 
-
78  void ClearDescription(const std::string& parameter);
-
79 
-
81  std::string GenerateDocumentation() const;
+
34 
+
35  //! Will return the long form of an abbreviation (like --force for -f)
+
36  const std::string& GetAbbreviation(const std::string& abbrev) const;
+
37 
+
38  //! Will check wether or not an abbreviation is registered
+
39  bool HasAbbreviation(const std::string& abbrev) const;
+
40 
+
41  //! Will delete all abbreviations
+
42  void ClearAbbreviations();
+
43 
+
44  //! Will register parameter constraints
+
45  void RegisterConstraints(const std::vector<ParamConstraint>& constraints);
+
46 
+
47  //! Will delete all constraints
+
48  void ClearConstraints();
+
49 
+
50  //! Sets whether to crash the application, and print to stderr, when an exception is
+
51  //! raised whilst parsing, or not.
+
52  void SetCrashOnFail(bool crashOnFail);
+
53 
+
54  //! Gets whether the application crashes on an exception whilst parsing, and prints to stderr.
+
55  bool GetCrashOnFail() const;
+
56 
+
57  //! Sets whether the Hazelnupp should automatically catch the --help parameter, print the parameter documentation to stdout, and exit or not.
+
58  void SetCatchHelp(bool catchHelp);
+
59 
+
60  //! Retruns whether the Hazelnupp should automatically catch the --help parameter, print the parameter documentation to stdout, and exit or not.
+
61  bool GetCatchHelp() const;
+
62 
+
63  //! Sets a brief description of the application to be automatically added to the documentation.
+
64  void SetBriefDescription(const std::string& description);
+
65 
+
66  //! Returns the brief description of the application to be automatically added to the documentation.
+
67  const std::string& GetBriefDescription();
+
68 
+
69  //! Willl register a short description for a parameter.
+
70  //! Will overwrite existing descriptions for that parameter.
+
71  void RegisterDescription(const std::string& parameter, const std::string& description);
+
72 
+
73  //! Will return a short description for a parameter, if it exists.
+
74  //! Empty string if it does not exist.
+
75  const std::string GetDescription(const std::string& parameter) const;
+
76 
+
77  //! Will delete the description of a parameter if it exists.
+
78  void ClearDescription(const std::string& parameter);
+
79 
+
80  //! Will generate a text-based documentation suited to show the user, for example on --help.
+
81  std::string GenerateDocumentation() const;
82 
-
83  private:
-
85  void PopulateRawArgs(const int argc, const char* const* argv);
-
86 
-
88  void ExpandAbbreviations();
-
89 
-
91  std::size_t ParseNextParameter(const std::size_t parIndex, Parameter*& out_Par);
-
92 
-
94  Value* ParseValue(const std::vector<std::string>& values, const ParamConstraint* constraint = nullptr);
-
95 
-
97  void ApplyConstraints();
-
98 
-
100  const ParamConstraint* GetConstraintForKey(const std::string& key) const;
+
83  private:
+
84  //! Will translate the c-like args to an std::vector
+
85  void PopulateRawArgs(const int argc, const char* const* argv);
+
86 
+
87  //! Will replace all args matching an abbreviation with their long form (like -f for --force)
+
88  void ExpandAbbreviations();
+
89 
+
90  //! Will parse the next parameter. Returns the index of the next parameter.
+
91  std::size_t ParseNextParameter(const std::size_t parIndex, Parameter*& out_Par);
+
92 
+
93  //! Will convert a vector of string-values to an actual Value
+
94  Value* ParseValue(const std::vector<std::string>& values, const ParamConstraint* constraint = nullptr);
+
95 
+
96  //! Will apply the loaded constraints on the loaded values, exluding types.
+
97  void ApplyConstraints();
+
98 
+
99  //! Will return a pointer to a paramConstraint given a key. If there is no, it returns nullptr
+
100  const ParamConstraint* GetConstraintForKey(const std::string& key) const;
101 
-
102  std::string executableName;
-
103  std::unordered_map<std::string, Parameter*> parameters;
-
104 
-
106  std::unordered_map<std::string, std::string> abbreviations;
-
107 
-
109  std::unordered_map<std::string, ParamConstraint> constraints;
-
110 
-
112  std::vector<std::string> rawArgs;
-
113 
-
115  std::unordered_map<std::string, std::string> parameterDescriptions;
-
116 
-
118  std::string briefDescription;
-
119 
-
121  bool catchHelp = true;
-
122 
-
124  bool crashOnFail = true;
+
102  std::string executableName; //! The path of the executable. Always argv[0]
+
103  std::unordered_map<std::string, Parameter*> parameters;
+
104 
+
105  //! These are abbreviations. Like, -f for --force.
+
106  std::unordered_map<std::string, std::string> abbreviations;
+
107 
+
108  //! Parameter constraints, mapped to keys
+
109  std::unordered_map<std::string, ParamConstraint> constraints;
+
110 
+
111  //! Raw argv
+
112  std::vector<std::string> rawArgs;
+
113 
+
114  //! Short descriptions for parameters
+
115  std::unordered_map<std::string, std::string> parameterDescriptions;
+
116 
+
117  //! A brief description of the application to be added to the generated documentation. Optional.
+
118  std::string briefDescription;
+
119 
+
120  //! If set to true, Hazelnupp will automatically catch the --help parameter, print the parameter documentation to stdout and exit.
+
121  bool catchHelp = true;
+
122 
+
123  //! If set to true, Hazelnupp will crash the application with output to stderr when an exception is thrown whilst parsing.
+
124  bool crashOnFail = true;
125  };
126 }
@@ -198,7 +236,7 @@ $(function() {
Hazelnp::Hazelnupp::GetDescription
const std::string GetDescription(const std::string &parameter) const
Will return a short description for a parameter, if it exists.
Definition: Hazelnupp.cpp:323
diff --git a/docs/IntValue_8cpp.html b/docs/IntValue_8cpp.html index ec445d5..252945a 100644 --- a/docs/IntValue_8cpp.html +++ b/docs/IntValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for IntValue.cpp: diff --git a/docs/IntValue_8cpp_source.html b/docs/IntValue_8cpp_source.html index e61f6cd..5f5b151 100644 --- a/docs/IntValue_8cpp_source.html +++ b/docs/IntValue_8cpp_source.html @@ -173,7 +173,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/IntValue_8h.html b/docs/IntValue_8h.html index 00ae7ce..186b40a 100644 --- a/docs/IntValue_8h.html +++ b/docs/IntValue_8h.html @@ -123,7 +123,7 @@ Namespaces diff --git a/docs/IntValue_8h_source.html b/docs/IntValue_8h_source.html index 9346632..1a5f8d8 100644 --- a/docs/IntValue_8h_source.html +++ b/docs/IntValue_8h_source.html @@ -82,32 +82,43 @@ $(function() {
2 #include "Value.h"
3 
4 namespace Hazelnp
-
5 {
+
5 {
+
6  /** Specializations for integer values (uses long long int)
+
7  */
8  class IntValue : public Value
9  {
10  public:
11  IntValue(const long long int& value);
12  ~IntValue() override {};
-
13 
-
15  Value* Deepcopy() const override;
-
16 
-
18  std::string GetAsOsString() const override;
-
19 
-
21  const long long int& GetValue() const;
+
13 
+
14  //! Will return a deeopopy of this object
+
15  Value* Deepcopy() const override;
+
16 
+
17  //! Will return a string suitable for an std::ostream;
+
18  std::string GetAsOsString() const override;
+
19 
+
20  //! Will return the raw value
+
21  const long long int& GetValue() const;
22 
23  operator long long int() const;
24  operator int() const;
25 
-
26 
-
28  long long int GetInt64() const override;
-
30  int GetInt32() const override;
-
31 
-
33  long double GetFloat64() const override;
-
35  double GetFloat32() const override;
-
36 
-
38  std::string GetString() const override;
-
39 
-
41  const std::vector<Value*>& GetList() const override;
+
26 
+
27  //! Will return the data as a long long int
+
28  long long int GetInt64() const override;
+
29  //! Will return the data as an int
+
30  int GetInt32() const override;
+
31 
+
32  //! Will return the data as a long double
+
33  long double GetFloat64() const override;
+
34  //! Will return the data as a double
+
35  double GetFloat32() const override;
+
36 
+
37  //! Will return the data as a string
+
38  std::string GetString() const override;
+
39 
+
40  //! Throws HazelnuppValueNotConvertibleException
+
41  const std::vector<Value*>& GetList() const override;
42 
43  private:
44  long long int value;
@@ -131,7 +142,7 @@ $(function() {
Value.h
diff --git a/docs/ListValue_8cpp.html b/docs/ListValue_8cpp.html index 566bb16..36b9af7 100644 --- a/docs/ListValue_8cpp.html +++ b/docs/ListValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for ListValue.cpp: diff --git a/docs/ListValue_8cpp_source.html b/docs/ListValue_8cpp_source.html index c2211a1..c867251 100644 --- a/docs/ListValue_8cpp_source.html +++ b/docs/ListValue_8cpp_source.html @@ -199,7 +199,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/ListValue_8h.html b/docs/ListValue_8h.html index f271c69..4c19085 100644 --- a/docs/ListValue_8h.html +++ b/docs/ListValue_8h.html @@ -123,7 +123,7 @@ Namespaces diff --git a/docs/ListValue_8h_source.html b/docs/ListValue_8h_source.html index 00fec21..e0bcd4a 100644 --- a/docs/ListValue_8h_source.html +++ b/docs/ListValue_8h_source.html @@ -83,32 +83,44 @@ $(function() {
3 #include <vector>
4 
5 namespace Hazelnp
-
6 {
+
6 {
+
7  /** Specializations for list values (uses std::vector<Value*>)
+
8  */
9  class ListValue : public Value
10  {
11  public:
12  ListValue();
13  ~ListValue() override;
-
14 
-
16  Value* Deepcopy() const override;
-
17 
-
19  std::string GetAsOsString() const override;
-
20 
-
22  void AddValue(const Value* value);
-
23 
-
25  const std::vector<Value*>& GetValue() const;
+
14 
+
15  //! Will return a deeopopy of this object
+
16  Value* Deepcopy() const override;
+
17 
+
18  //! Will return a string suitable for an std::ostream;
+
19  std::string GetAsOsString() const override;
+
20 
+
21  //! Will add this value to the list
+
22  void AddValue(const Value* value);
+
23 
+
24  //! Will return the raw value
+
25  const std::vector<Value*>& GetValue() const;
26 
27  operator std::vector<Value*>() const;
-
28 
-
30  long long int GetInt64() const override;
-
32  int GetInt32() const override;
-
33 
-
35  long double GetFloat64() const override;
-
37  double GetFloat32() const override;
-
38 
-
40  std::string GetString() const override;
-
41 
-
43  const std::vector<Value*>& GetList() const override;
+
28 
+
29  //! Throws HazelnuppValueNotConvertibleException
+
30  long long int GetInt64() const override;
+
31  //! Throws HazelnuppValueNotConvertibleException
+
32  int GetInt32() const override;
+
33 
+
34  //! Throws HazelnuppValueNotConvertibleException
+
35  long double GetFloat64() const override;
+
36  //! Throws HazelnuppValueNotConvertibleException
+
37  double GetFloat32() const override;
+
38 
+
39  //! Throws HazelnuppValueNotConvertibleException
+
40  std::string GetString() const override;
+
41 
+
42  //! Will return this values list
+
43  const std::vector<Value*>& GetList() const override;
44 
45  private:
46  std::vector<Value*> value;
@@ -133,7 +145,7 @@ $(function() {
Value.h
diff --git a/docs/ParamConstraint_8h.html b/docs/ParamConstraint_8h.html index 82a9908..f0864f1 100644 --- a/docs/ParamConstraint_8h.html +++ b/docs/ParamConstraint_8h.html @@ -122,7 +122,7 @@ Namespaces diff --git a/docs/ParamConstraint_8h_source.html b/docs/ParamConstraint_8h_source.html index 2c987e4..afb5059 100644 --- a/docs/ParamConstraint_8h_source.html +++ b/docs/ParamConstraint_8h_source.html @@ -87,10 +87,13 @@ $(function() {
7 {
8  struct ParamConstraint
9  {
-
10  public:
-
12  ParamConstraint() = default;
-
13 
-
16  static ParamConstraint Require(const std::string& key, const std::vector<std::string>& defaultValue = {}, bool required = true)
+
10  public:
+
11  //! Empty constructor
+
12  ParamConstraint() = default;
+
13 
+
14  //! Constructs a require constraint.
+
15  //! Think of the default value like of a list ofparameters. Like {"--width", "800"}
+
16  static ParamConstraint Require(const std::string& key, const std::vector<std::string>& defaultValue = {}, bool required = true)
17  {
18  ParamConstraint pc;
19  pc.key = key;
@@ -99,8 +102,9 @@ $(function() {
22 
23  return pc;
24  }
-
25 
-
27  static ParamConstraint TypeSafety(const std::string& key, DATA_TYPE wantedType, bool constrainType = true)
+
25 
+
26  //! Constructs a type-safety constraint
+
27  static ParamConstraint TypeSafety(const std::string& key, DATA_TYPE wantedType, bool constrainType = true)
28  {
29  ParamConstraint pc;
30  pc.key = key;
@@ -109,8 +113,9 @@ $(function() {
33 
34  return pc;
35  }
-
36 
-
38  ParamConstraint(const std::string& key, bool constrainType, DATA_TYPE wantedType, const std::vector<std::string>& defaultValue, bool required)
+
36 
+
37  //! Whole constructor
+
38  ParamConstraint(const std::string& key, bool constrainType, DATA_TYPE wantedType, const std::vector<std::string>& defaultValue, bool required)
39  :
40  key{ key },
41  constrainType{ constrainType },
@@ -120,16 +125,25 @@ $(function() {
45  {
46  return;
47  }
-
48 
-
50  std::string key;
-
51 
-
54  bool constrainType = false;
-
55 
-
57  DATA_TYPE wantedType = DATA_TYPE::VOID;
-
58 
-
62  std::vector<std::string> defaultValue;
-
63 
-
66  bool required = false;
+
48 
+
49  //! The key of the parameter to constrain
+
50  std::string key;
+
51 
+
52  //! Should this parameter be forced to be of a certain type?
+
53  //! Remember to set `constrainTo` to the wanted type
+
54  bool constrainType = false;
+
55 
+
56  //! Constrain the parameter to this value. Requires `constrainType` to be set to true.
+
57  DATA_TYPE wantedType = DATA_TYPE::VOID;
+
58 
+
59  //! The default value for this parameter.
+
60  //! Gets applied if this parameter was not given.
+
61  //! Think of this like a list of parameters. Like {"--width", "800"}
+
62  std::vector<std::string> defaultValue;
+
63 
+
64  //! If set to true, and no default value set,
+
65  //! an error will be produced if this parameter is not supplied by the user.
+
66  bool required = false;
67  };
68 }
@@ -149,7 +163,7 @@ $(function() {
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:62
diff --git a/docs/Parameter_8cpp.html b/docs/Parameter_8cpp.html index f402658..b22098f 100644 --- a/docs/Parameter_8cpp.html +++ b/docs/Parameter_8cpp.html @@ -98,7 +98,7 @@ Include dependency graph for Parameter.cpp: diff --git a/docs/Parameter_8cpp_source.html b/docs/Parameter_8cpp_source.html index 322c241..a483268 100644 --- a/docs/Parameter_8cpp_source.html +++ b/docs/Parameter_8cpp_source.html @@ -116,7 +116,7 @@ $(function() {
Parameter.h
diff --git a/docs/Parameter_8h.html b/docs/Parameter_8h.html index 54a21f6..ca7c366 100644 --- a/docs/Parameter_8h.html +++ b/docs/Parameter_8h.html @@ -125,7 +125,7 @@ Namespaces diff --git a/docs/Parameter_8h_source.html b/docs/Parameter_8h_source.html index 5a23a26..7b94be5 100644 --- a/docs/Parameter_8h_source.html +++ b/docs/Parameter_8h_source.html @@ -90,10 +90,12 @@ $(function() {
10  public:
11  explicit Parameter(const std::string& key, const Value* value);
12  ~Parameter();
-
13 
-
15  const std::string& Key() const;
-
16 
-
18  const Value* GetValue() const;
+
13 
+
14  //! Will return the key of this parameter
+
15  const std::string& Key() const;
+
16 
+
17  //! Will return the value of this parameter
+
18  const Value* GetValue() const;
19 
20  friend std::ostream& operator<< (std::ostream& os, const Parameter& p)
21  {
@@ -117,7 +119,7 @@ $(function() {
Value.h
diff --git a/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index 9d42c54..a695c07 100644 --- a/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html +++ b/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html @@ -77,7 +77,7 @@ $(function() { diff --git a/docs/StringTools_8cpp.html b/docs/StringTools_8cpp.html index 992c5cf..cfde7b6 100644 --- a/docs/StringTools_8cpp.html +++ b/docs/StringTools_8cpp.html @@ -97,7 +97,7 @@ Include dependency graph for StringTools.cpp: diff --git a/docs/StringTools_8cpp_source.html b/docs/StringTools_8cpp_source.html index 7305031..3ffaa15 100644 --- a/docs/StringTools_8cpp_source.html +++ b/docs/StringTools_8cpp_source.html @@ -275,7 +275,7 @@ $(function() {
Hazelnp::StringTools::ToLower
static std::string ToLower(const std::string &str)
Will make a string all lower-case.
Definition: StringTools.cpp:173
diff --git a/docs/StringTools_8h.html b/docs/StringTools_8h.html index ac99e72..6b5e5e4 100644 --- a/docs/StringTools_8h.html +++ b/docs/StringTools_8h.html @@ -124,7 +124,7 @@ Namespaces diff --git a/docs/StringTools_8h_source.html b/docs/StringTools_8h_source.html index 6bbcf5a..a781ef2 100644 --- a/docs/StringTools_8h_source.html +++ b/docs/StringTools_8h_source.html @@ -85,25 +85,37 @@ $(function() {
5 #include <cmath>
6 
7 namespace Hazelnp
-
8 {
+
8 {
+
9  /** Internal helper class. Feel free to use it tho.
+
10  */
11  class StringTools
12  {
-
13  public:
-
15  static bool Contains(const std::string& str, const char c);
-
16 
-
18  static std::string Replace(const std::string& str, const char find, const std::string& subst);
-
19 
-
21  static std::string Replace(const std::string& str, const std::string& find, const std::string& subst);
-
22 
-
24  static bool IsNumeric(const std::string& str, const bool allowDecimalPoint = false);
-
25 
-
29  static bool ParseNumber(const std::string& str, bool& out_isInt, long double& out_number);
-
30 
-
32  static std::vector<std::string> SplitString(const std::string& str, const char delimiter);
-
33 
-
35  static std::vector<std::string> SplitString(const std::string& str, const std::string& delimiter);
-
36 
-
38  static std::string ToLower(const std::string& str);
+
13  public:
+
14  //! Will return wether or not a given char is in a string
+
15  static bool Contains(const std::string& str, const char c);
+
16 
+
17  //! Will replace a part of a string with another string
+
18  static std::string Replace(const std::string& str, const char find, const std::string& subst);
+
19 
+
20  //! Will replace a part of a string with another string
+
21  static std::string Replace(const std::string& str, const std::string& find, const std::string& subst);
+
22 
+
23  //! Will return true if the given string consists only of digits (including signage)
+
24  static bool IsNumeric(const std::string& str, const bool allowDecimalPoint = false);
+
25 
+
26  //! Will convert the number in str to a number.
+
27  //! Returns wether or not the operation was successful.
+
28  //! Also returns wether the number is an integer, or floating point. If int, cast out_number to int.
+
29  static bool ParseNumber(const std::string& str, bool& out_isInt, long double& out_number);
+
30 
+
31  //! Will split a string by a delimiter char. The delimiter will be excluded!
+
32  static std::vector<std::string> SplitString(const std::string& str, const char delimiter);
+
33 
+
34  //! Will split a string by a delimiter string. The delimiter will be excluded!
+
35  static std::vector<std::string> SplitString(const std::string& str, const std::string& delimiter);
+
36 
+
37  //! Will make a string all lower-case
+
38  static std::string ToLower(const std::string& str);
39  };
40 }
@@ -117,7 +129,7 @@ $(function() {
Hazelnp::StringTools::ToLower
static std::string ToLower(const std::string &str)
Will make a string all lower-case.
Definition: StringTools.cpp:173
diff --git a/docs/StringValue_8cpp.html b/docs/StringValue_8cpp.html index e36479a..81e2501 100644 --- a/docs/StringValue_8cpp.html +++ b/docs/StringValue_8cpp.html @@ -103,7 +103,7 @@ Include dependency graph for StringValue.cpp: diff --git a/docs/StringValue_8cpp_source.html b/docs/StringValue_8cpp_source.html index 855ee93..cd3a7fd 100644 --- a/docs/StringValue_8cpp_source.html +++ b/docs/StringValue_8cpp_source.html @@ -165,7 +165,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/StringValue_8h.html b/docs/StringValue_8h.html index fbc3dba..0dc8cda 100644 --- a/docs/StringValue_8h.html +++ b/docs/StringValue_8h.html @@ -123,7 +123,7 @@ Namespaces diff --git a/docs/StringValue_8h_source.html b/docs/StringValue_8h_source.html index 330def3..ac51190 100644 --- a/docs/StringValue_8h_source.html +++ b/docs/StringValue_8h_source.html @@ -83,30 +83,41 @@ $(function() {
3 #include <string>
4 
5 namespace Hazelnp
-
6 {
+
6 {
+
7  /** Specializations for string values (uses std::string)
+
8  */
9  class StringValue : public Value
10  {
11  public:
12  StringValue(const std::string& value);
13  ~StringValue() override {};
-
14 
-
16  Value* Deepcopy() const override;
-
17 
-
19  std::string GetAsOsString() const override;
-
20 
-
22  const std::string& GetValue() const;
+
14 
+
15  //! Will return a deeopopy of this object
+
16  Value* Deepcopy() const override;
+
17 
+
18  //! Will return a string suitable for an std::ostream;
+
19  std::string GetAsOsString() const override;
+
20 
+
21  //! Will return the raw value
+
22  const std::string& GetValue() const;
23 
24  operator std::string() const;
-
25 
-
27  long long int GetInt64() const override;
-
29  int GetInt32() const override;
-
30 
-
32  long double GetFloat64() const override;
-
34  double GetFloat32() const override;
-
35 
-
37  std::string GetString() const override;
-
38 
-
40  const std::vector<Value*>& GetList() const override;
+
25 
+
26  //! Throws HazelnuppValueNotConvertibleException
+
27  long long int GetInt64() const override;
+
28  //! Throws HazelnuppValueNotConvertibleException
+
29  int GetInt32() const override;
+
30 
+
31  //! Throws HazelnuppValueNotConvertibleException
+
32  long double GetFloat64() const override;
+
33  //! Throws HazelnuppValueNotConvertibleException
+
34  double GetFloat32() const override;
+
35 
+
36  //! Will return this value as a string
+
37  std::string GetString() const override;
+
38 
+
39  //! Throws HazelnuppValueNotConvertibleException
+
40  const std::vector<Value*>& GetList() const override;
41 
42  private:
43  std::string value;
@@ -130,7 +141,7 @@ $(function() {
Value.h
diff --git a/docs/Value_8cpp.html b/docs/Value_8cpp.html index 17a7bf6..8c4d017 100644 --- a/docs/Value_8cpp.html +++ b/docs/Value_8cpp.html @@ -97,7 +97,7 @@ Include dependency graph for Value.cpp: diff --git a/docs/Value_8cpp_source.html b/docs/Value_8cpp_source.html index 1f5c39a..86548ca 100644 --- a/docs/Value_8cpp_source.html +++ b/docs/Value_8cpp_source.html @@ -102,7 +102,7 @@ $(function() {
Value.h
diff --git a/docs/Value_8h.html b/docs/Value_8h.html index 777f152..1794da4 100644 --- a/docs/Value_8h.html +++ b/docs/Value_8h.html @@ -137,7 +137,7 @@ Namespaces diff --git a/docs/Value_8h_source.html b/docs/Value_8h_source.html index 3e42cf1..453d3bc 100644 --- a/docs/Value_8h_source.html +++ b/docs/Value_8h_source.html @@ -84,32 +84,43 @@ $(function() {
4 #include <vector>
5 
6 namespace Hazelnp
-
7 {
+
7 {
+
8  /** Abstract class for values
+
9  */
10  class Value
11  {
12  public:
13  virtual ~Value() {};
-
14 
-
16  virtual Value* Deepcopy() const = 0;
-
17 
-
19  virtual std::string GetAsOsString() const = 0;
-
20 
-
22  DATA_TYPE GetDataType() const;
+
14 
+
15  //! Will return a deeopopy of this object
+
16  virtual Value* Deepcopy() const = 0;
+
17 
+
18  //! Will return a string suitable for an std::ostream
+
19  virtual std::string GetAsOsString() const = 0;
+
20 
+
21  //! Will return the data type of this value
+
22  DATA_TYPE GetDataType() const;
23 
24  friend std::ostream& operator<< (std::ostream& os, const Value& v)
25  {
26  return os << v.GetAsOsString();
27  }
-
28 
-
30  virtual long long int GetInt64() const = 0;
-
32  virtual int GetInt32() const = 0;
-
33 
-
35  virtual long double GetFloat64() const = 0;
-
37  virtual double GetFloat32() const = 0;
-
38 
-
40  virtual std::string GetString() const = 0;
-
41 
-
43  virtual const std::vector<Value*>& GetList() const = 0;
+
28 
+
29  //! Will attempt to return the integer data (long long)
+
30  virtual long long int GetInt64() const = 0;
+
31  //! Will attempt to return the integer data (int)
+
32  virtual int GetInt32() const = 0;
+
33 
+
34  //! Will attempt to return the floating-point data (long double)
+
35  virtual long double GetFloat64() const = 0;
+
36  //! Will attempt to return the floating-point data (double)
+
37  virtual double GetFloat32() const = 0;
+
38 
+
39  //! Will attempt to return the string-data
+
40  virtual std::string GetString() const = 0;
+
41 
+
42  //! Will attempt to return the list-data
+
43  virtual const std::vector<Value*>& GetList() const = 0;
44 
45  protected:
46  Value(DATA_TYPE type);
@@ -137,7 +148,7 @@ $(function() {
Hazelnp::Value::GetFloat64
virtual long double GetFloat64() const =0
Will attempt to return the floating-point data (long double)
diff --git a/docs/VoidValue_8cpp.html b/docs/VoidValue_8cpp.html index 1878b56..534a83f 100644 --- a/docs/VoidValue_8cpp.html +++ b/docs/VoidValue_8cpp.html @@ -101,7 +101,7 @@ Include dependency graph for VoidValue.cpp: diff --git a/docs/VoidValue_8cpp_source.html b/docs/VoidValue_8cpp_source.html index 9d6e0b7..e0216f4 100644 --- a/docs/VoidValue_8cpp_source.html +++ b/docs/VoidValue_8cpp_source.html @@ -150,7 +150,7 @@ $(function() {
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/VoidValue_8h.html b/docs/VoidValue_8h.html index 42eb515..d6d2926 100644 --- a/docs/VoidValue_8h.html +++ b/docs/VoidValue_8h.html @@ -122,7 +122,7 @@ Namespaces diff --git a/docs/VoidValue_8h_source.html b/docs/VoidValue_8h_source.html index dde7f92..2c378da 100644 --- a/docs/VoidValue_8h_source.html +++ b/docs/VoidValue_8h_source.html @@ -82,26 +82,36 @@ $(function() {
2 #include "Value.h"
3 
4 namespace Hazelnp
-
5 {
+
5 {
+
6  /** Specializations for void values. These house no value whatsoever, but only communicate information by merely existing.
+
7  */
8  class VoidValue : public Value
9  {
10  public:
11  VoidValue();
12  ~VoidValue() override {};
-
13 
-
15  Value* Deepcopy() const override;
-
16 
-
18  std::string GetAsOsString() const override;
-
19 
-
21  long long int GetInt64() const override;
-
23  int GetInt32() const override;
-
24 
-
26  long double GetFloat64() const override;
-
28  double GetFloat32() const override;
-
29 
-
31  std::string GetString() const override;
-
32 
-
34  const std::vector<Value*>& GetList() const;
+
13 
+
14  //! Will return a deeopopy of this object
+
15  Value* Deepcopy() const override;
+
16 
+
17  //! Will return a string suitable for an std::ostream;
+
18  std::string GetAsOsString() const override;
+
19 
+
20  //! Throws HazelnuppValueNotConvertibleException
+
21  long long int GetInt64() const override;
+
22  //! Throws HazelnuppValueNotConvertibleException
+
23  int GetInt32() const override;
+
24 
+
25  //! Throws HazelnuppValueNotConvertibleException
+
26  long double GetFloat64() const override;
+
27  //! Throws HazelnuppValueNotConvertibleException
+
28  double GetFloat32() const override;
+
29 
+
30  //! Throws HazelnuppValueNotConvertibleException
+
31  std::string GetString() const override;
+
32 
+
33  //! Throws HazelnuppValueNotConvertibleException
+
34  const std::vector<Value*>& GetList() const;
35  };
36 }
@@ -121,7 +131,7 @@ $(function() {
Value.h
diff --git a/docs/annotated.html b/docs/annotated.html index 8d0289e..797e7e5 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -98,7 +98,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1FloatValue-members.html b/docs/classHazelnp_1_1FloatValue-members.html index b5a1c92..9187381 100644 --- a/docs/classHazelnp_1_1FloatValue-members.html +++ b/docs/classHazelnp_1_1FloatValue-members.html @@ -101,7 +101,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1FloatValue.html b/docs/classHazelnp_1_1FloatValue.html index b6c688f..9aac1f0 100644 --- a/docs/classHazelnp_1_1FloatValue.html +++ b/docs/classHazelnp_1_1FloatValue.html @@ -574,7 +574,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/classHazelnp_1_1Hazelnupp-members.html b/docs/classHazelnp_1_1Hazelnupp-members.html index fe50e9c..0780eff 100644 --- a/docs/classHazelnp_1_1Hazelnupp-members.html +++ b/docs/classHazelnp_1_1Hazelnupp-members.html @@ -107,7 +107,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1Hazelnupp.html b/docs/classHazelnp_1_1Hazelnupp.html index 1449635..7e8e3c4 100644 --- a/docs/classHazelnp_1_1Hazelnupp.html +++ b/docs/classHazelnp_1_1Hazelnupp.html @@ -990,7 +990,7 @@ Public Member Functions
Hazelnp::DataTypeToString
static std::string DataTypeToString(DATA_TYPE type)
Definition: DataType.h:17
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException-members.html b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html index 872cd82..033e629 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintException-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html @@ -90,7 +90,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException.html b/docs/classHazelnp_1_1HazelnuppConstraintException.html index 1edd38c..68ef7df 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintException.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintException.html @@ -201,7 +201,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:11
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html index 212ea0e..6a5a5b5 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html @@ -92,7 +92,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html index 51c0aa5..184b1e8 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html @@ -206,7 +206,7 @@ Additional Inherited Members
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException()
Definition: HazelnuppException.h:47
diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html index e12d440..8607d78 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html @@ -92,7 +92,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html index fb51700..3c3d067 100644 --- a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html @@ -206,7 +206,7 @@ Additional Inherited Members
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException()
Definition: HazelnuppException.h:47
diff --git a/docs/classHazelnp_1_1HazelnuppException-members.html b/docs/classHazelnp_1_1HazelnuppException-members.html index ebe0fd4..81a8bd4 100644 --- a/docs/classHazelnp_1_1HazelnuppException-members.html +++ b/docs/classHazelnp_1_1HazelnuppException-members.html @@ -88,7 +88,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppException.html b/docs/classHazelnp_1_1HazelnuppException.html index 5de723e..3d437c1 100644 --- a/docs/classHazelnp_1_1HazelnuppException.html +++ b/docs/classHazelnp_1_1HazelnuppException.html @@ -255,7 +255,7 @@ Protected Attributes
Hazelnp::HazelnuppException::message
std::string message
Definition: HazelnuppException.h:21
diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html index 51965b5..07a5b7f 100644 --- a/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html @@ -90,7 +90,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html index d55ac82..a941859 100644 --- a/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html @@ -199,7 +199,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:11
diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html index e614358..7fd042d 100644 --- a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html @@ -90,7 +90,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html index f968b5e..735e6f1 100644 --- a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html @@ -199,7 +199,7 @@ Additional Inherited Members
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:11
diff --git a/docs/classHazelnp_1_1IntValue-members.html b/docs/classHazelnp_1_1IntValue-members.html index d01f1e8..f27eab5 100644 --- a/docs/classHazelnp_1_1IntValue-members.html +++ b/docs/classHazelnp_1_1IntValue-members.html @@ -101,7 +101,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1IntValue.html b/docs/classHazelnp_1_1IntValue.html index b5b12fc..6c5e89b 100644 --- a/docs/classHazelnp_1_1IntValue.html +++ b/docs/classHazelnp_1_1IntValue.html @@ -574,7 +574,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/classHazelnp_1_1ListValue-members.html b/docs/classHazelnp_1_1ListValue-members.html index 07fafd4..1752fd7 100644 --- a/docs/classHazelnp_1_1ListValue-members.html +++ b/docs/classHazelnp_1_1ListValue-members.html @@ -101,7 +101,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1ListValue.html b/docs/classHazelnp_1_1ListValue.html index 465cb35..4430f59 100644 --- a/docs/classHazelnp_1_1ListValue.html +++ b/docs/classHazelnp_1_1ListValue.html @@ -601,7 +601,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/classHazelnp_1_1Parameter-members.html b/docs/classHazelnp_1_1Parameter-members.html index 97e4b8b..0372028 100644 --- a/docs/classHazelnp_1_1Parameter-members.html +++ b/docs/classHazelnp_1_1Parameter-members.html @@ -89,7 +89,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1Parameter.html b/docs/classHazelnp_1_1Parameter.html index 85655a7..f176953 100644 --- a/docs/classHazelnp_1_1Parameter.html +++ b/docs/classHazelnp_1_1Parameter.html @@ -275,7 +275,7 @@ Friends
Hazelnp::Value::Deepcopy
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
diff --git a/docs/classHazelnp_1_1StringTools-members.html b/docs/classHazelnp_1_1StringTools-members.html index 31faaf0..8cc90ef 100644 --- a/docs/classHazelnp_1_1StringTools-members.html +++ b/docs/classHazelnp_1_1StringTools-members.html @@ -92,7 +92,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1StringTools.html b/docs/classHazelnp_1_1StringTools.html index ed342fe..0934445 100644 --- a/docs/classHazelnp_1_1StringTools.html +++ b/docs/classHazelnp_1_1StringTools.html @@ -626,7 +626,7 @@ Static Public Member Functions
Hazelnp::StringTools::SplitString
static std::vector< std::string > SplitString(const std::string &str, const char delimiter)
Will split a string by a delimiter char. The delimiter will be excluded!
Definition: StringTools.cpp:125
diff --git a/docs/classHazelnp_1_1StringValue-members.html b/docs/classHazelnp_1_1StringValue-members.html index 46f18d5..031a698 100644 --- a/docs/classHazelnp_1_1StringValue-members.html +++ b/docs/classHazelnp_1_1StringValue-members.html @@ -100,7 +100,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1StringValue.html b/docs/classHazelnp_1_1StringValue.html index 2e8ba78..bbf1034 100644 --- a/docs/classHazelnp_1_1StringValue.html +++ b/docs/classHazelnp_1_1StringValue.html @@ -547,7 +547,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/classHazelnp_1_1Value-members.html b/docs/classHazelnp_1_1Value-members.html index 3e005db..f014e7c 100644 --- a/docs/classHazelnp_1_1Value-members.html +++ b/docs/classHazelnp_1_1Value-members.html @@ -97,7 +97,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1Value.html b/docs/classHazelnp_1_1Value.html index 4370300..eb2bf0d 100644 --- a/docs/classHazelnp_1_1Value.html +++ b/docs/classHazelnp_1_1Value.html @@ -548,7 +548,7 @@ Friends
Hazelnp::Value::type
DATA_TYPE type
Definition: Value.h:48
diff --git a/docs/classHazelnp_1_1VoidValue-members.html b/docs/classHazelnp_1_1VoidValue-members.html index 73f927d..b252117 100644 --- a/docs/classHazelnp_1_1VoidValue-members.html +++ b/docs/classHazelnp_1_1VoidValue-members.html @@ -98,7 +98,7 @@ $(function() { diff --git a/docs/classHazelnp_1_1VoidValue.html b/docs/classHazelnp_1_1VoidValue.html index 95ec803..9b7ea1d 100644 --- a/docs/classHazelnp_1_1VoidValue.html +++ b/docs/classHazelnp_1_1VoidValue.html @@ -493,7 +493,7 @@ Additional Inherited Members
Hazelnp::HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:35
diff --git a/docs/classes.html b/docs/classes.html index 82af744..3bec190 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -119,7 +119,7 @@ $(function() { diff --git a/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html b/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html index da88420..68e4295 100644 --- a/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html +++ b/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html @@ -136,7 +136,7 @@ Files diff --git a/docs/dir_0cc5f59b28c403d42cc56800132eb975.html b/docs/dir_0cc5f59b28c403d42cc56800132eb975.html index 1ef30d4..4a90466 100644 --- a/docs/dir_0cc5f59b28c403d42cc56800132eb975.html +++ b/docs/dir_0cc5f59b28c403d42cc56800132eb975.html @@ -81,7 +81,7 @@ $(function() { diff --git a/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html b/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html index de107b8..793dca7 100644 --- a/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html +++ b/docs/dir_1148ebc2b25b55095aebf6f4cbb6efca.html @@ -81,7 +81,7 @@ $(function() { diff --git a/docs/dir_a8cffda729361e9d9637effa362fcea9.html b/docs/dir_a8cffda729361e9d9637effa362fcea9.html index 34d467d..7474e27 100644 --- a/docs/dir_a8cffda729361e9d9637effa362fcea9.html +++ b/docs/dir_a8cffda729361e9d9637effa362fcea9.html @@ -81,7 +81,7 @@ $(function() { diff --git a/docs/files.html b/docs/files.html index e3bafa1..962c49a 100644 --- a/docs/files.html +++ b/docs/files.html @@ -107,7 +107,7 @@ $(function() { diff --git a/docs/functions.html b/docs/functions.html index 882c81f..4d20a49 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -424,7 +424,7 @@ $(function() { diff --git a/docs/functions_func.html b/docs/functions_func.html index ac11c01..c09c115 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -395,7 +395,7 @@ $(function() { diff --git a/docs/functions_rela.html b/docs/functions_rela.html index 36f31e0..4c46c95 100644 --- a/docs/functions_rela.html +++ b/docs/functions_rela.html @@ -79,7 +79,7 @@ $(function() { diff --git a/docs/functions_vars.html b/docs/functions_vars.html index e82c1f2..951370e 100644 --- a/docs/functions_vars.html +++ b/docs/functions_vars.html @@ -96,7 +96,7 @@ $(function() { diff --git a/docs/globals.html b/docs/globals.html index 6419344..d9f8d93 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/globals_func.html b/docs/globals_func.html index 21404b0..d10784d 100644 --- a/docs/globals_func.html +++ b/docs/globals_func.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/graph_legend.html b/docs/graph_legend.html index eafae6f..1cf759b 100644 --- a/docs/graph_legend.html +++ b/docs/graph_legend.html @@ -137,7 +137,7 @@ A yellow dashed arrow denotes a relation between a template instance and the tem diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 9b35102..753ff31 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -100,7 +100,7 @@ This inheritance list is sorted roughly, but not completely, alphabetically: diff --git a/docs/index.html b/docs/index.html index 8ed33b6..8670f54 100644 --- a/docs/index.html +++ b/docs/index.html @@ -341,7 +341,7 @@ LICENSE
Hazelnp::ParamConstraint::TypeSafety
static ParamConstraint TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)
Constructs a type-safety constraint.
Definition: ParamConstraint.h:27
diff --git a/docs/index_8md.html b/docs/index_8md.html index aab34f8..b533e1a 100644 --- a/docs/index_8md.html +++ b/docs/index_8md.html @@ -77,7 +77,7 @@ $(function() { diff --git a/docs/inherits.html b/docs/inherits.html index 7736793..3281085 100644 --- a/docs/inherits.html +++ b/docs/inherits.html @@ -122,7 +122,7 @@ $(function() { diff --git a/docs/main_8cpp.html b/docs/main_8cpp.html index ff3f8da..9b6c1d8 100644 --- a/docs/main_8cpp.html +++ b/docs/main_8cpp.html @@ -176,7 +176,7 @@ Functions
Hazelnp::Hazelnupp::RegisterDescription
void RegisterDescription(const std::string &parameter, const std::string &description)
Willl register a short description for a parameter.
Definition: Hazelnupp.cpp:317
diff --git a/docs/main_8cpp_source.html b/docs/main_8cpp_source.html index 43775fa..fb56280 100644 --- a/docs/main_8cpp_source.html +++ b/docs/main_8cpp_source.html @@ -128,7 +128,7 @@ $(function() {
Hazelnp::Hazelnupp::RegisterDescription
void RegisterDescription(const std::string &parameter, const std::string &description)
Willl register a short description for a parameter.
Definition: Hazelnupp.cpp:317
diff --git a/docs/namespaceHazelnp.html b/docs/namespaceHazelnp.html index 95c2b0a..55c9352 100644 --- a/docs/namespaceHazelnp.html +++ b/docs/namespaceHazelnp.html @@ -246,7 +246,7 @@ Functions
Hazelnp::DATA_TYPE::STRING
@ STRING
diff --git a/docs/namespacemembers.html b/docs/namespacemembers.html index 2a3852d..5e20222 100644 --- a/docs/namespacemembers.html +++ b/docs/namespacemembers.html @@ -81,7 +81,7 @@ $(function() { diff --git a/docs/namespacemembers_enum.html b/docs/namespacemembers_enum.html index 8d9d9dd..6f1e4eb 100644 --- a/docs/namespacemembers_enum.html +++ b/docs/namespacemembers_enum.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/namespacemembers_func.html b/docs/namespacemembers_func.html index f88fdc2..9344bc8 100644 --- a/docs/namespacemembers_func.html +++ b/docs/namespacemembers_func.html @@ -78,7 +78,7 @@ $(function() { diff --git a/docs/namespaces.html b/docs/namespaces.html index 67842e7..22e9ba8 100644 --- a/docs/namespaces.html +++ b/docs/namespaces.html @@ -82,7 +82,7 @@ $(function() { diff --git a/docs/structHazelnp_1_1ParamConstraint-members.html b/docs/structHazelnp_1_1ParamConstraint-members.html index c24c89b..8a84f82 100644 --- a/docs/structHazelnp_1_1ParamConstraint-members.html +++ b/docs/structHazelnp_1_1ParamConstraint-members.html @@ -93,7 +93,7 @@ $(function() { diff --git a/docs/structHazelnp_1_1ParamConstraint.html b/docs/structHazelnp_1_1ParamConstraint.html index f5ab98f..5c98758 100644 --- a/docs/structHazelnp_1_1ParamConstraint.html +++ b/docs/structHazelnp_1_1ParamConstraint.html @@ -451,7 +451,7 @@ Public Attributes
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:62