diff --git a/docs/DataType_8h.html b/docs/DataType_8h.html index 74bc12c..047d0a6 100644 --- a/docs/DataType_8h.html +++ b/docs/DataType_8h.html @@ -75,6 +75,7 @@ $(function() {
+Namespaces | Enumerations
DataType.h File Reference
@@ -109,70 +110,29 @@ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

+ + + +

+Namespaces

 Hazelnp
 
- - - + +

Enumerations

enum  DATA_TYPE {
-  DATA_TYPE::VOID, -DATA_TYPE::INT, -DATA_TYPE::FLOAT, -DATA_TYPE::STRING, +
enum  Hazelnp::DATA_TYPE {
+  Hazelnp::DATA_TYPE::VOID, +Hazelnp::DATA_TYPE::INT, +Hazelnp::DATA_TYPE::FLOAT, +Hazelnp::DATA_TYPE::STRING,
-  DATA_TYPE::LIST +  Hazelnp::DATA_TYPE::LIST
}
 The different data types a paramater can be. More...
 
 The different data types a paramater can be. More...
 
-

Enumeration Type Documentation

- -

◆ DATA_TYPE

- -
-
- - - - - -
- - - - -
enum DATA_TYPE
-
-strong
-
- -

The different data types a paramater can be.

- - - - - - -
Enumerator
VOID 
INT 
FLOAT 
STRING 
LIST 
- -

Definition at line 5 of file DataType.h.

-
6 {
-
7  VOID,
-
8  INT,
-
9  FLOAT,
-
10  STRING,
-
11  LIST
-
12 };
-
-
-
-
DATA_TYPE::VOID
@ VOID
-
DATA_TYPE::LIST
@ LIST
-
DATA_TYPE::FLOAT
@ FLOAT
-
DATA_TYPE::INT
@ INT
-
DATA_TYPE::STRING
@ STRING
diff --git a/docs/DataType_8h_source.html b/docs/DataType_8h_source.html index 52b5f98..34a0d0f 100644 --- a/docs/DataType_8h_source.html +++ b/docs/DataType_8h_source.html @@ -80,24 +80,28 @@ $(function() {
Go to the documentation of this file.
1 #pragma once
2 
-
5 enum class DATA_TYPE
-
6 {
-
7  VOID,
-
8  INT,
-
9  FLOAT,
-
10  STRING,
-
11  LIST
-
12 };
+
3 namespace Hazelnp
+
4 {
+
7  enum class DATA_TYPE
+
8  {
+
9  VOID,
+
10  INT,
+
11  FLOAT,
+
12  STRING,
+
13  LIST
+
14  };
+
15 }
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
DATA_TYPE::VOID
@ VOID
-
DATA_TYPE::LIST
@ LIST
-
DATA_TYPE::FLOAT
@ FLOAT
-
DATA_TYPE::INT
@ INT
-
DATA_TYPE::STRING
@ STRING
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::DATA_TYPE::VOID
@ VOID
+
Hazelnp::DATA_TYPE::LIST
@ LIST
+
Hazelnp::DATA_TYPE::FLOAT
@ FLOAT
+
Hazelnp::DATA_TYPE::INT
@ INT
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
Hazelnp::DATA_TYPE::STRING
@ STRING
diff --git a/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index 2f85f9c..f0e492a 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 a67d042..180dff5 100644 --- a/docs/FloatValue_8cpp.html +++ b/docs/FloatValue_8cpp.html @@ -102,7 +102,7 @@ Include dependency graph for FloatValue.cpp: diff --git a/docs/FloatValue_8cpp_source.html b/docs/FloatValue_8cpp_source.html index 78f719f..49100b7 100644 --- a/docs/FloatValue_8cpp_source.html +++ b/docs/FloatValue_8cpp_source.html @@ -82,95 +82,98 @@ $(function() {
2 #include "HazelnuppException.h"
3 #include <sstream>
4 
-
5 FloatValue::FloatValue(const long double& value)
-
6  :
-
7  Value(DATA_TYPE::FLOAT),
-
8  value { value }
-
9 {
-
10  return;
-
11 }
-
12 
-
13 Value* FloatValue::Deepcopy() const
-
14 {
-
15  return new FloatValue(value);
-
16 }
-
17 
-
18 std::string FloatValue::GetAsOsString() const
-
19 {
-
20  std::stringstream ss;
-
21  ss << "FloatValue: " << value;
-
22  return ss.str();
-
23 }
-
24 
-
25 const long double& FloatValue::GetValue() const
-
26 {
-
27  return value;
-
28 }
-
29 
-
30 FloatValue::operator long double() const
-
31 {
-
32  return value;
-
33 }
-
34 
-
35 FloatValue::operator double() const
-
36 {
-
37  return (double)value;
-
38 }
-
39 
-
40 
+
5 using namespace Hazelnp;
+
6 
+
7 FloatValue::FloatValue(const long double& value)
+
8  :
+
9  Value(DATA_TYPE::FLOAT),
+
10  value { value }
+
11 {
+
12  return;
+
13 }
+
14 
+
15 Value* FloatValue::Deepcopy() const
+
16 {
+
17  return new FloatValue(value);
+
18 }
+
19 
+
20 std::string FloatValue::GetAsOsString() const
+
21 {
+
22  std::stringstream ss;
+
23  ss << "FloatValue: " << value;
+
24  return ss.str();
+
25 }
+
26 
+
27 const long double& FloatValue::GetValue() const
+
28 {
+
29  return value;
+
30 }
+
31 
+
32 FloatValue::operator long double() const
+
33 {
+
34  return value;
+
35 }
+
36 
+
37 FloatValue::operator double() const
+
38 {
+
39  return (double)value;
+
40 }
41 
-
42 long long int FloatValue::GetInt64() const
-
43 {
-
44  return (long long int)value;
-
45 }
-
46 
-
47 int FloatValue::GetInt32() const
-
48 {
-
49  return (int)value;
-
50 }
-
51 
-
52 long double FloatValue::GetFloat64() const
-
53 {
-
54  return value;
-
55 }
-
56 
-
57 double FloatValue::GetFloat32() const
-
58 {
-
59  return (double)value;
-
60 }
-
61 
-
62 std::string FloatValue::GetString() const
-
63 {
-
64  std::stringstream ss;
-
65  ss << value;
-
66 
-
67  return ss.str();
-
68 }
-
69 
-
70 const std::vector<Value*>& FloatValue::GetList() const
-
71 {
-
72  throw HazelnuppValueNotConvertibleException();
-
73 }
+
42 
+
43 
+
44 long long int FloatValue::GetInt64() const
+
45 {
+
46  return (long long int)value;
+
47 }
+
48 
+
49 int FloatValue::GetInt32() const
+
50 {
+
51  return (int)value;
+
52 }
+
53 
+
54 long double FloatValue::GetFloat64() const
+
55 {
+
56  return value;
+
57 }
+
58 
+
59 double FloatValue::GetFloat32() const
+
60 {
+
61  return (double)value;
+
62 }
+
63 
+
64 std::string FloatValue::GetString() const
+
65 {
+
66  std::stringstream ss;
+
67  ss << value;
+
68 
+
69  return ss.str();
+
70 }
+
71 
+
72 const std::vector<Value*>& FloatValue::GetList() const
+
73 {
+
74  throw HazelnuppValueNotConvertibleException();
+
75 }
+
Hazelnp::FloatValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: FloatValue.cpp:54
HazelnuppException.h
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
FloatValue::GetValue
const long double & GetValue() const
Will return the raw value.
Definition: FloatValue.cpp:25
-
DATA_TYPE::FLOAT
@ FLOAT
-
Value
Abstract class for values.
Definition: Value.h:8
-
FloatValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: FloatValue.cpp:62
-
FloatValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: FloatValue.cpp:13
-
HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:33
-
FloatValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: FloatValue.cpp:18
-
FloatValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: FloatValue.cpp:52
-
FloatValue::FloatValue
FloatValue(const long double &value)
Definition: FloatValue.cpp:5
-
FloatValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:47
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::FloatValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: FloatValue.cpp:64
+
Hazelnp::FloatValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: FloatValue.cpp:72
+
Hazelnp::FloatValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: FloatValue.cpp:44
+
Hazelnp::FloatValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: FloatValue.cpp:20
+
Hazelnp::FloatValue::GetValue
const long double & GetValue() const
Will return the raw value.
Definition: FloatValue.cpp:27
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::FloatValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: FloatValue.cpp:15
+
Hazelnp::FloatValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: FloatValue.cpp:59
+
Hazelnp::DATA_TYPE::FLOAT
@ FLOAT
FloatValue.h
-
FloatValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: FloatValue.cpp:42
-
FloatValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: FloatValue.cpp:70
-
FloatValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: FloatValue.cpp:57
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
Hazelnp::FloatValue::FloatValue
FloatValue(const long double &value)
Definition: FloatValue.cpp:7
+
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
+
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 1b53071..77f504c 100644 --- a/docs/FloatValue_8h.html +++ b/docs/FloatValue_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
FloatValue.h File Reference
@@ -109,14 +110,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  FloatValue
 Specializations for floating point values (uses long double) More...
class  Hazelnp::FloatValue
 Specializations for floating point values (uses long double) More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/FloatValue_8h_source.html b/docs/FloatValue_8h_source.html index 5ee6b30..64bff1a 100644 --- a/docs/FloatValue_8h_source.html +++ b/docs/FloatValue_8h_source.html @@ -82,52 +82,56 @@ $(function() {
2 #include "Value.h"
3 #include <ostream>
4 
-
7 class FloatValue : public Value
-
8 {
-
9 public:
-
10  FloatValue(const long double& value);
-
11  ~FloatValue() override {};
-
12 
-
14  Value* Deepcopy() const override;
-
15 
-
17  std::string GetAsOsString() const override;
-
18 
-
20  const long double& GetValue() const;
-
21 
-
22  operator long double () const;
-
23  operator double() const;
-
24 
-
26  long long int GetInt64() const override;
-
28  int GetInt32() const override;
-
29 
-
31  long double GetFloat64() const override;
-
33  double GetFloat32() const override;
-
34 
-
36  std::string GetString() const override;
-
37 
-
39  const std::vector<Value*>& GetList() const override;
-
40 
-
41 private:
-
42  long double value;
-
43 };
+
5 namespace Hazelnp
+
6 {
+
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;
+
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;
+
42 
+
43  private:
+
44  long double value;
+
45  };
+
46 }
-
FloatValue::GetValue
const long double & GetValue() const
Will return the raw value.
Definition: FloatValue.cpp:25
-
Value
Abstract class for values.
Definition: Value.h:8
-
FloatValue::~FloatValue
~FloatValue() override
Definition: FloatValue.h:11
-
FloatValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: FloatValue.cpp:62
-
FloatValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: FloatValue.cpp:13
-
FloatValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: FloatValue.cpp:18
-
FloatValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: FloatValue.cpp:52
-
FloatValue
Specializations for floating point values (uses long double)
Definition: FloatValue.h:7
-
FloatValue::FloatValue
FloatValue(const long double &value)
Definition: FloatValue.cpp:5
-
FloatValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: FloatValue.cpp:47
-
FloatValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: FloatValue.cpp:42
-
FloatValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: FloatValue.cpp:70
-
FloatValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: FloatValue.cpp:57
+
Hazelnp::FloatValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: FloatValue.cpp:54
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::FloatValue::~FloatValue
~FloatValue() override
Definition: FloatValue.h:13
+
Hazelnp::FloatValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: FloatValue.cpp:64
+
Hazelnp::FloatValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: FloatValue.cpp:72
+
Hazelnp::FloatValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: FloatValue.cpp:44
+
Hazelnp::FloatValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: FloatValue.cpp:20
+
Hazelnp::FloatValue::GetValue
const long double & GetValue() const
Will return the raw value.
Definition: FloatValue.cpp:27
+
Hazelnp::FloatValue
Specializations for floating point values (uses long double)
Definition: FloatValue.h:9
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::FloatValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: FloatValue.cpp:15
+
Hazelnp::FloatValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: FloatValue.cpp:59
+
Hazelnp::FloatValue::FloatValue
FloatValue(const long double &value)
Definition: FloatValue.cpp:7
Value.h
+
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 52b0dd4..23af0c1 100644 --- a/docs/HazelnuppException_8h.html +++ b/docs/HazelnuppException_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
HazelnuppException.h File Reference
@@ -109,29 +110,34 @@ This graph shows which files directly or indirectly include this file: - - + + - - + + - - + + - - + + - - + + - - + + + +

Classes

class  HazelnuppException
 Generic hazelnupp exception. More...
class  Hazelnp::HazelnuppException
 Generic hazelnupp exception. More...
 
class  HazelnuppInvalidKeyException
 Gets thrown when an non-existent key gets dereferenced. More...
class  Hazelnp::HazelnuppInvalidKeyException
 Gets thrown when an non-existent key gets dereferenced. More...
 
class  HazelnuppValueNotConvertibleException
 Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible. More...
class  Hazelnp::HazelnuppValueNotConvertibleException
 Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible. More...
 
class  HazelnuppConstraintException
 Gets thrown something bad happens because of parameter constraints. More...
class  Hazelnp::HazelnuppConstraintException
 Gets thrown something bad happens because of parameter constraints. More...
 
class  HazelnuppConstraintTypeMissmatch
 Gets thrown when a parameter is of a type that does not match the required type, and is not convertible to it. More...
class  Hazelnp::HazelnuppConstraintTypeMissmatch
 Gets thrown when a parameter is of a type that does not match the required type, and is not convertible to it. More...
 
class  HazelnuppConstraintMissingValue
 Gets thrown when a parameter constrained to be required is not provided, and has no default value set. More...
class  Hazelnp::HazelnuppConstraintMissingValue
 Gets thrown when a parameter constrained to be required is not provided, and has no default value set. More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/HazelnuppException_8h_source.html b/docs/HazelnuppException_8h_source.html index 0d3dbb3..fa42ced 100644 --- a/docs/HazelnuppException_8h_source.html +++ b/docs/HazelnuppException_8h_source.html @@ -81,79 +81,83 @@ $(function() { Go to the documentation of this file.
1 #pragma once
2 #include <stdexcept>
3 
-
6 class HazelnuppException : public std::exception
-
7 {
-
8 public:
-
9  HazelnuppException() {};
-
10  HazelnuppException(const std::string& msg) : message{ msg } {};
-
11 
-
13  const std::string& What() const
-
14  {
-
15  return message;
-
16  }
-
17 
-
18 protected:
-
19  std::string message;
-
20 };
-
21 
-
24 class HazelnuppInvalidKeyException : public HazelnuppException
-
25 {
-
26 public:
-
27  HazelnuppInvalidKeyException() : HazelnuppException() {};
-
28  HazelnuppInvalidKeyException(const std::string& msg) : HazelnuppException(msg) {};
-
29 };
-
30 
-
33 class HazelnuppValueNotConvertibleException : public HazelnuppException
-
34 {
-
35 public:
-
36  HazelnuppValueNotConvertibleException() : HazelnuppException() {};
-
37  HazelnuppValueNotConvertibleException(const std::string& msg) : HazelnuppException(msg) {};
-
38 };
-
39 
-
42 class HazelnuppConstraintException : public HazelnuppException
-
43 {
-
44 public:
-
45  HazelnuppConstraintException() : HazelnuppException() {};
-
46  HazelnuppConstraintException(const std::string& msg) : HazelnuppException(msg) {};
-
47 };
-
48 
-
51 class HazelnuppConstraintTypeMissmatch : public HazelnuppConstraintException
-
52 {
-
53 public:
-
54  HazelnuppConstraintTypeMissmatch() : HazelnuppConstraintException() {};
-
55  HazelnuppConstraintTypeMissmatch(const std::string& msg) : HazelnuppConstraintException(msg) {};
-
56 };
-
57 
-
60 class HazelnuppConstraintMissingValue : public HazelnuppConstraintException
-
61 {
-
62 public:
-
63  HazelnuppConstraintMissingValue() : HazelnuppConstraintException() {};
-
64  HazelnuppConstraintMissingValue(const std::string& msg) : HazelnuppConstraintException(msg) {};
-
65 };
+
4 namespace Hazelnp
+
5 {
+
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
+
16  {
+
17  return message;
+
18  }
+
19 
+
20  protected:
+
21  std::string message;
+
22  };
+
23 
+
26  class HazelnuppInvalidKeyException : public HazelnuppException
+
27  {
+
28  public:
+
29  HazelnuppInvalidKeyException() : HazelnuppException() {};
+
30  HazelnuppInvalidKeyException(const std::string& msg) : HazelnuppException(msg) {};
+
31  };
+
32 
+
35  class HazelnuppValueNotConvertibleException : public HazelnuppException
+
36  {
+
37  public:
+
38  HazelnuppValueNotConvertibleException() : HazelnuppException() {};
+
39  HazelnuppValueNotConvertibleException(const std::string& msg) : HazelnuppException(msg) {};
+
40  };
+
41 
+
44  class HazelnuppConstraintException : public HazelnuppException
+
45  {
+
46  public:
+
47  HazelnuppConstraintException() : HazelnuppException() {};
+
48  HazelnuppConstraintException(const std::string& msg) : HazelnuppException(msg) {};
+
49  };
+
50 
+
53  class HazelnuppConstraintTypeMissmatch : public HazelnuppConstraintException
+
54  {
+
55  public:
+
56  HazelnuppConstraintTypeMissmatch() : HazelnuppConstraintException() {};
+
57  HazelnuppConstraintTypeMissmatch(const std::string& msg) : HazelnuppConstraintException(msg) {};
+
58  };
+
59 
+
62  class HazelnuppConstraintMissingValue : public HazelnuppConstraintException
+
63  {
+
64  public:
+
65  HazelnuppConstraintMissingValue() : HazelnuppConstraintException() {};
+
66  HazelnuppConstraintMissingValue(const std::string& msg) : HazelnuppConstraintException(msg) {};
+
67  };
+
68 }
-
HazelnuppException::What
const std::string & What() const
Will return an error message.
Definition: HazelnuppException.h:13
-
HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue
HazelnuppConstraintMissingValue(const std::string &msg)
Definition: HazelnuppException.h:64
-
HazelnuppConstraintException
Gets thrown something bad happens because of parameter constraints.
Definition: HazelnuppException.h:42
-
HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch
HazelnuppConstraintTypeMissmatch(const std::string &msg)
Definition: HazelnuppException.h:55
-
HazelnuppInvalidKeyException::HazelnuppInvalidKeyException
HazelnuppInvalidKeyException(const std::string &msg)
Definition: HazelnuppException.h:28
-
HazelnuppException
Generic hazelnupp exception.
Definition: HazelnuppException.h:6
-
HazelnuppInvalidKeyException::HazelnuppInvalidKeyException
HazelnuppInvalidKeyException()
Definition: HazelnuppException.h:27
-
HazelnuppConstraintTypeMissmatch
Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...
Definition: HazelnuppException.h:51
-
HazelnuppException::HazelnuppException
HazelnuppException(const std::string &msg)
Definition: HazelnuppException.h:10
-
HazelnuppConstraintMissingValue
Gets thrown when a parameter constrained to be required is not provided, and has no default value set...
Definition: HazelnuppException.h:60
-
HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:33
-
HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException
HazelnuppValueNotConvertibleException()
Definition: HazelnuppException.h:36
-
HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue
HazelnuppConstraintMissingValue()
Definition: HazelnuppException.h:63
-
HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException()
Definition: HazelnuppException.h:45
-
HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch
HazelnuppConstraintTypeMissmatch()
Definition: HazelnuppException.h:54
-
HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:24
-
HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException(const std::string &msg)
Definition: HazelnuppException.h:46
-
HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException
HazelnuppValueNotConvertibleException(const std::string &msg)
Definition: HazelnuppException.h:37
-
HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:9
-
HazelnuppException::message
std::string message
Definition: HazelnuppException.h:19
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException
HazelnuppInvalidKeyException(const std::string &msg)
Definition: HazelnuppException.h:30
+
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException()
Definition: HazelnuppException.h:47
+
Hazelnp::HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:26
+
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException(const std::string &msg)
Definition: HazelnuppException.h:48
+
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException(const std::string &msg)
Definition: HazelnuppException.h:12
+
Hazelnp::HazelnuppException::What
const std::string & What() const
Will return an error message.
Definition: HazelnuppException.h:15
+
Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue
HazelnuppConstraintMissingValue()
Definition: HazelnuppException.h:65
+
Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch
HazelnuppConstraintTypeMissmatch()
Definition: HazelnuppException.h:56
+
Hazelnp::HazelnuppConstraintException
Gets thrown something bad happens because of parameter constraints.
Definition: HazelnuppException.h:44
+
Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue
HazelnuppConstraintMissingValue(const std::string &msg)
Definition: HazelnuppException.h:66
+
Hazelnp::HazelnuppException
Generic hazelnupp exception.
Definition: HazelnuppException.h:8
+
Hazelnp::HazelnuppConstraintMissingValue
Gets thrown when a parameter constrained to be required is not provided, and has no default value set...
Definition: HazelnuppException.h:62
+
Hazelnp::HazelnuppConstraintTypeMissmatch
Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...
Definition: HazelnuppException.h:53
+
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:11
+
Hazelnp::HazelnuppException::message
std::string message
Definition: HazelnuppException.h:21
+
Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException
HazelnuppValueNotConvertibleException(const std::string &msg)
Definition: HazelnuppException.h:39
+
Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch
HazelnuppConstraintTypeMissmatch(const std::string &msg)
Definition: HazelnuppException.h:57
+
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
+
Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException
HazelnuppValueNotConvertibleException()
Definition: HazelnuppException.h:38
+
Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException
HazelnuppInvalidKeyException()
Definition: HazelnuppException.h:29
diff --git a/docs/Hazelnupp_8cpp.html b/docs/Hazelnupp_8cpp.html index 35bc024..2e7053d 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 ee6668c..a46636a 100644 --- a/docs/Hazelnupp_8cpp_source.html +++ b/docs/Hazelnupp_8cpp_source.html @@ -89,437 +89,440 @@ $(function() {
9 #include <iostream>
10 #include <cstdlib>
11 
-
12 Hazelnupp::Hazelnupp()
-
13 {
-
14  return;
-
15 }
-
16 
-
17 Hazelnupp::Hazelnupp(const int argc, const char* const* argv)
-
18 {
-
19  Parse(argc, argv);
-
20  return;
-
21 }
-
22 
-
23 Hazelnupp::~Hazelnupp()
-
24 {
-
25  for (auto& it : parameters)
-
26  delete it.second;
-
27 
-
28  parameters.clear();
+
12 using namespace Hazelnp;
+
13 
+
14 Hazelnupp::Hazelnupp()
+
15 {
+
16  return;
+
17 }
+
18 
+
19 Hazelnupp::Hazelnupp(const int argc, const char* const* argv)
+
20 {
+
21  Parse(argc, argv);
+
22  return;
+
23 }
+
24 
+
25 Hazelnupp::~Hazelnupp()
+
26 {
+
27  for (auto& it : parameters)
+
28  delete it.second;
29 
-
30  return;
-
31 }
-
32 
-
33 void Hazelnupp::Parse(const int argc, const char* const* argv)
-
34 {
-
35  try
-
36  {
-
37  // Populate raw arguments
-
38  PopulateRawArgs(argc, argv);
-
39 
-
40  // Expand abbreviations
-
41  ExpandAbbreviations();
-
42 
-
43  executableName = std::string(rawArgs[0]);
+
30  parameters.clear();
+
31 
+
32  return;
+
33 }
+
34 
+
35 void Hazelnupp::Parse(const int argc, const char* const* argv)
+
36 {
+
37  try
+
38  {
+
39  // Populate raw arguments
+
40  PopulateRawArgs(argc, argv);
+
41 
+
42  // Expand abbreviations
+
43  ExpandAbbreviations();
44 
-
45  std::size_t i = 1;
-
46  while (i < rawArgs.size())
-
47  {
-
48  if ((rawArgs[i].length() > 2) && (rawArgs[i].substr(0, 2) == "--"))
-
49  {
-
50  Parameter* param = nullptr;
-
51  i = ParseNextParameter(i, param);
-
52 
-
53  parameters.insert(std::pair<std::string, Parameter*>(param->Key(), param));
-
54  }
-
55  else
-
56  i++;
-
57  }
-
58 
-
59  // Apply constraints such as default values, and required parameters.
-
60  // Types have already been enforced.
-
61  ApplyConstraints();
-
62  }
-
63  catch (const HazelnuppConstraintTypeMissmatch& hctm)
-
64  {
-
65  if (crashOnFail)
-
66  {
-
67  std::cerr << "Fatal error: Command-line parameter value-type mismatch at \"" << hctm.What() << "\"!";
-
68  quick_exit(-1009);
-
69  }
-
70  else
-
71  throw hctm; // yeet
-
72  }
-
73  catch (const HazelnuppConstraintMissingValue& hctm)
-
74  {
-
75  if (crashOnFail)
-
76  {
-
77  std::cerr << "Fatal error: Missing required command-line parameter \"" << hctm.What() << "\"!";
-
78  quick_exit(-1010);
-
79  }
-
80  else
-
81  throw hctm; // yeet
-
82  }
-
83 
-
84  return;
-
85 }
-
86 
-
87 std::size_t Hazelnupp::ParseNextParameter(const std::size_t parIndex, Parameter*& out_Par)
-
88 {
-
89  std::size_t i = parIndex;
-
90  const std::string key = rawArgs[parIndex];
-
91  std::vector<std::string> values;
-
92 
-
93  // Get values
-
94  for (i++; i < rawArgs.size(); i++)
-
95  // If not another parameter
-
96  if ((rawArgs[i].length() < 2) || (rawArgs[i].substr(0, 2) != "--"))
-
97  values.emplace_back(rawArgs[i]);
-
98  else
-
99  {
-
100  break;
-
101  }
-
102 
-
103  // Fetch constraint info
-
104  const ParamConstraint* pcn = GetConstraintForKey(key);
-
105 
-
106  Value* parsedVal = ParseValue(values, pcn);
-
107  if (parsedVal != nullptr)
-
108  {
-
109  out_Par = new Parameter(key, parsedVal);
-
110 
-
111  delete parsedVal;
-
112  parsedVal = nullptr;
-
113  }
-
114  else
-
115  throw std::runtime_error("Unable to parse parameter!");
-
116 
-
117  return i;
-
118 }
-
119 
-
120 void Hazelnupp::PopulateRawArgs(const int argc, const char* const* argv)
-
121 {
-
122  rawArgs.clear();
-
123  rawArgs.reserve(argc);
-
124 
-
125  for (int i = 0; i < argc; i++)
-
126  rawArgs.emplace_back(std::string(argv[i]));
-
127 
-
128  return;
-
129 }
-
130 
-
131 void Hazelnupp::ExpandAbbreviations()
-
132 {
-
133  // Abort if no abbreviations
-
134  if (abbreviations.size() == 0)
-
135  return;
-
136 
-
137  for (std::string& arg : rawArgs)
-
138  {
-
139  // Is arg registered as an abbreviation?
-
140  auto abbr = abbreviations.find(arg);
-
141  if (abbr != abbreviations.end())
-
142  {
-
143  // Yes: replace arg with the long form
-
144  arg = abbr->second;
-
145  }
-
146  }
-
147 
-
148  return;
-
149 }
-
150 
-
151 bool Hazelnupp::HasParam(const std::string& key) const
-
152 {
-
153  return parameters.find(key) != parameters.end();
-
154 }
-
155 
-
156 Value* Hazelnupp::ParseValue(const std::vector<std::string>& values, const ParamConstraint* constraint)
-
157 {
-
158  // Constraint values
-
159  const bool constrainType = (constraint != nullptr) && (constraint->constrainType);
-
160 
-
161  // Void-type
-
162  if (values.size() == 0)
-
163  {
-
164  // Is a list forced via a constraint? If yes, return an empty list
-
165  if ((constrainType) &&
-
166  (constraint->wantedType == DATA_TYPE::LIST))
-
167  return new ListValue();
-
168 
-
169  return new VoidValue;
-
170  }
-
171 
-
172  // Force void type by constraint
-
173  if ((constrainType) &&
-
174  (constraint->wantedType == DATA_TYPE::VOID))
-
175  {
-
176  return new VoidValue;
-
177  }
-
178 
-
179  // List-type
-
180  else if (values.size() > 1)
-
181  {
-
182  // Should the type be something other than list?
-
183  if ((constrainType) &&
-
184  (constraint->wantedType != DATA_TYPE::LIST))
-
185  {
-
186  throw HazelnuppConstraintTypeMissmatch(values[0] + " " + values[1]);
-
187  }
-
188 
-
189  ListValue* newList = new ListValue();
-
190  for (const std::string& val : values)
-
191  {
-
192  Value* tmp = ParseValue({ val });
-
193  newList->AddValue(tmp);
-
194  delete tmp;
-
195  }
-
196  return newList;
-
197  }
-
198 
-
199  // Now we're only dealing with a single value
-
200  const std::string& val = values[0];
-
201 
-
202  // String
-
203  if (!StringTools::IsNumeric(val, true))
-
204  {
-
205  // Is the type not supposed to be a string?
-
206  // void and list are already sorted out
-
207  if ((constrainType) &&
-
208  (constraint->wantedType != DATA_TYPE::STRING))
-
209  {
-
210  // We can only force a list-value from here
-
211  if (constraint->wantedType == DATA_TYPE::LIST)
-
212  {
-
213  ListValue* list = new ListValue();
-
214  Value* tmp = ParseValue({ val });
-
215  list->AddValue(tmp);
-
216  delete tmp;
-
217  tmp = nullptr;
-
218  return list;
-
219  }
-
220  // Else it not possible to convert to a numeric
-
221  else
-
222  throw HazelnuppConstraintTypeMissmatch(val);
-
223  }
-
224 
-
225  return new StringValue(val);
-
226  }
-
227 
-
228  // In this case we have a numeric value.
-
229  // We should still produce a string if requested
-
230  if ((constrainType) &&
-
231  (constraint->wantedType == DATA_TYPE::STRING))
-
232  return new StringValue(val);
-
233 
-
234  // Numeric
-
235  bool isInt;
-
236  long double num;
-
237 
-
238  if (StringTools::ParseNumber(val, isInt, num))
-
239  {
-
240  // Is the type constrained?
-
241  // (only int and float left)
-
242  if (constrainType)
-
243  {
-
244  // Must it be an integer?
-
245  if (constraint->wantedType == DATA_TYPE::INT)
-
246  return new IntValue((long long int)num);
-
247  // Must it be a floating point?
-
248  else if (constraint->wantedType == DATA_TYPE::FLOAT)
-
249  return new FloatValue(num);
-
250  // Else it must be a List
-
251  else
-
252  {
-
253  ListValue* list = new ListValue();
-
254  Value* tmp = ParseValue({ val });
-
255  list->AddValue(tmp);
-
256  delete tmp;
-
257  tmp = nullptr;
-
258  return list;
-
259  }
-
260  }
-
261  // Type is not constrained
-
262  else
-
263  {
-
264  // Integer
-
265  if (isInt)
-
266  return new IntValue((long long int)num);
-
267 
-
268  // Double
-
269  return new FloatValue(num);
-
270  }
-
271  }
-
272 
-
273  // Failed
-
274  return nullptr;
-
275 }
-
276 
-
277 bool Hazelnupp::GetCrashOnFail() const
-
278 {
-
279  return crashOnFail;
-
280 }
-
281 
-
282 void Hazelnupp::ApplyConstraints()
-
283 {
-
284  // Enforce required parameters / default values
-
285  for (const auto& pc : constraints)
-
286  // Parameter in question is not supplied
-
287  if (!HasParam(pc.second.key))
-
288  {
-
289  // Do we have a default value?
-
290  if (pc.second.defaultValue.size() > 0)
-
291  {
-
292  // Then create it now, by its default value
-
293 
-
294  Value* tmp = ParseValue(pc.second.defaultValue, &pc.second);
-
295  parameters.insert(std::pair<std::string, Parameter*>(
-
296  pc.second.key,
-
297  new Parameter(pc.second.key, tmp)
-
298  ));
-
299 
-
300  delete tmp;
-
301  tmp = nullptr;
-
302  }
-
303  // So we do not have a default value...
-
304  else
-
305  {
-
306  // Is it important to have the missing parameter?
-
307  if (pc.second.required)
-
308  // Throw an error message then
-
309  throw HazelnuppConstraintMissingValue(pc.second.key);
-
310  }
-
311  }
-
312 
-
313  return;
-
314 }
-
315 
-
316 const std::string& Hazelnupp::GetExecutableName() const
-
317 {
-
318  return executableName;
-
319 }
-
320 
-
321 const Value& Hazelnupp::operator[](const std::string& key) const
-
322 {
-
323  // Throw exception if param is unknown
-
324  if (!HasParam(key))
-
325  throw HazelnuppInvalidKeyException();
-
326 
-
327  return *parameters.find(key)->second->GetValue();
-
328 }
-
329 
-
330 void Hazelnupp::RegisterAbbreviation(const std::string& abbrev, const std::string& target)
-
331 {
-
332  abbreviations.insert(std::pair<std::string, std::string>(abbrev, target));
-
333  return;
-
334 }
-
335 
-
336 const std::string& Hazelnupp::GetAbbreviation(const std::string& abbrev) const
-
337 {
-
338  return abbreviations.find(abbrev)->second;
-
339 }
-
340 
-
341 bool Hazelnupp::HasAbbreviation(const std::string& abbrev) const
-
342 {
-
343  return abbreviations.find(abbrev) != abbreviations.end();
-
344 }
-
345 
-
346 void Hazelnupp::ClearAbbreviations()
-
347 {
-
348  abbreviations.clear();
-
349  return;
-
350 }
-
351 
-
352 void Hazelnupp::RegisterConstraints(const std::vector<ParamConstraint>& constraints)
-
353 {
-
354  for (const ParamConstraint& pc : constraints)
-
355  {
-
356  // Does this constraint already exist?
-
357  const auto constraint = this->constraints.find(pc.key);
-
358  // If yes, replace it.
-
359  if (constraint != this->constraints.end())
-
360  constraint->second = pc;
-
361 
-
362  // Else, create a new pair
-
363  else
-
364  this->constraints.insert(std::pair<std::string, ParamConstraint>(
-
365  pc.key,
-
366  pc
-
367  ));
-
368  }
-
369 
-
370  return;
-
371 }
-
372 
-
373 void Hazelnupp::ClearConstraints()
-
374 {
-
375  constraints.clear();
-
376  return;
-
377 }
-
378 
-
379 void Hazelnupp::SetCrashOnFail(bool crashOnFail)
-
380 {
-
381  this->crashOnFail = crashOnFail;
-
382  return;
-
383 }
-
384 
-
385 const ParamConstraint* Hazelnupp::GetConstraintForKey(const std::string& key) const
-
386 {
-
387  const auto constraint = constraints.find(key);
-
388 
-
389  if (constraint == constraints.end())
-
390  return nullptr;
-
391 
-
392  return &constraint->second;
-
393 }
+
45  executableName = std::string(rawArgs[0]);
+
46 
+
47  std::size_t i = 1;
+
48  while (i < rawArgs.size())
+
49  {
+
50  if ((rawArgs[i].length() > 2) && (rawArgs[i].substr(0, 2) == "--"))
+
51  {
+
52  Parameter* param = nullptr;
+
53  i = ParseNextParameter(i, param);
+
54 
+
55  parameters.insert(std::pair<std::string, Parameter*>(param->Key(), param));
+
56  }
+
57  else
+
58  i++;
+
59  }
+
60 
+
61  // Apply constraints such as default values, and required parameters.
+
62  // Types have already been enforced.
+
63  ApplyConstraints();
+
64  }
+
65  catch (const HazelnuppConstraintTypeMissmatch& hctm)
+
66  {
+
67  if (crashOnFail)
+
68  {
+
69  std::cerr << "Fatal error: Command-line parameter value-type mismatch at \"" << hctm.What() << "\"!";
+
70  quick_exit(-1009);
+
71  }
+
72  else
+
73  throw hctm; // yeet
+
74  }
+
75  catch (const HazelnuppConstraintMissingValue& hctm)
+
76  {
+
77  if (crashOnFail)
+
78  {
+
79  std::cerr << "Fatal error: Missing required command-line parameter \"" << hctm.What() << "\"!";
+
80  quick_exit(-1010);
+
81  }
+
82  else
+
83  throw hctm; // yeet
+
84  }
+
85 
+
86  return;
+
87 }
+
88 
+
89 std::size_t Hazelnupp::ParseNextParameter(const std::size_t parIndex, Parameter*& out_Par)
+
90 {
+
91  std::size_t i = parIndex;
+
92  const std::string key = rawArgs[parIndex];
+
93  std::vector<std::string> values;
+
94 
+
95  // Get values
+
96  for (i++; i < rawArgs.size(); i++)
+
97  // If not another parameter
+
98  if ((rawArgs[i].length() < 2) || (rawArgs[i].substr(0, 2) != "--"))
+
99  values.emplace_back(rawArgs[i]);
+
100  else
+
101  {
+
102  break;
+
103  }
+
104 
+
105  // Fetch constraint info
+
106  const ParamConstraint* pcn = GetConstraintForKey(key);
+
107 
+
108  Value* parsedVal = ParseValue(values, pcn);
+
109  if (parsedVal != nullptr)
+
110  {
+
111  out_Par = new Parameter(key, parsedVal);
+
112 
+
113  delete parsedVal;
+
114  parsedVal = nullptr;
+
115  }
+
116  else
+
117  throw std::runtime_error("Unable to parse parameter!");
+
118 
+
119  return i;
+
120 }
+
121 
+
122 void Hazelnupp::PopulateRawArgs(const int argc, const char* const* argv)
+
123 {
+
124  rawArgs.clear();
+
125  rawArgs.reserve(argc);
+
126 
+
127  for (int i = 0; i < argc; i++)
+
128  rawArgs.emplace_back(std::string(argv[i]));
+
129 
+
130  return;
+
131 }
+
132 
+
133 void Hazelnupp::ExpandAbbreviations()
+
134 {
+
135  // Abort if no abbreviations
+
136  if (abbreviations.size() == 0)
+
137  return;
+
138 
+
139  for (std::string& arg : rawArgs)
+
140  {
+
141  // Is arg registered as an abbreviation?
+
142  auto abbr = abbreviations.find(arg);
+
143  if (abbr != abbreviations.end())
+
144  {
+
145  // Yes: replace arg with the long form
+
146  arg = abbr->second;
+
147  }
+
148  }
+
149 
+
150  return;
+
151 }
+
152 
+
153 bool Hazelnupp::HasParam(const std::string& key) const
+
154 {
+
155  return parameters.find(key) != parameters.end();
+
156 }
+
157 
+
158 Value* Hazelnupp::ParseValue(const std::vector<std::string>& values, const ParamConstraint* constraint)
+
159 {
+
160  // Constraint values
+
161  const bool constrainType = (constraint != nullptr) && (constraint->constrainType);
+
162 
+
163  // Void-type
+
164  if (values.size() == 0)
+
165  {
+
166  // Is a list forced via a constraint? If yes, return an empty list
+
167  if ((constrainType) &&
+
168  (constraint->wantedType == DATA_TYPE::LIST))
+
169  return new ListValue();
+
170 
+
171  return new VoidValue;
+
172  }
+
173 
+
174  // Force void type by constraint
+
175  if ((constrainType) &&
+
176  (constraint->wantedType == DATA_TYPE::VOID))
+
177  {
+
178  return new VoidValue;
+
179  }
+
180 
+
181  // List-type
+
182  else if (values.size() > 1)
+
183  {
+
184  // Should the type be something other than list?
+
185  if ((constrainType) &&
+
186  (constraint->wantedType != DATA_TYPE::LIST))
+
187  {
+
188  throw HazelnuppConstraintTypeMissmatch(values[0] + " " + values[1]);
+
189  }
+
190 
+
191  ListValue* newList = new ListValue();
+
192  for (const std::string& val : values)
+
193  {
+
194  Value* tmp = ParseValue({ val });
+
195  newList->AddValue(tmp);
+
196  delete tmp;
+
197  }
+
198  return newList;
+
199  }
+
200 
+
201  // Now we're only dealing with a single value
+
202  const std::string& val = values[0];
+
203 
+
204  // String
+
205  if (!StringTools::IsNumeric(val, true))
+
206  {
+
207  // Is the type not supposed to be a string?
+
208  // void and list are already sorted out
+
209  if ((constrainType) &&
+
210  (constraint->wantedType != DATA_TYPE::STRING))
+
211  {
+
212  // We can only force a list-value from here
+
213  if (constraint->wantedType == DATA_TYPE::LIST)
+
214  {
+
215  ListValue* list = new ListValue();
+
216  Value* tmp = ParseValue({ val });
+
217  list->AddValue(tmp);
+
218  delete tmp;
+
219  tmp = nullptr;
+
220  return list;
+
221  }
+
222  // Else it not possible to convert to a numeric
+
223  else
+
224  throw HazelnuppConstraintTypeMissmatch(val);
+
225  }
+
226 
+
227  return new StringValue(val);
+
228  }
+
229 
+
230  // In this case we have a numeric value.
+
231  // We should still produce a string if requested
+
232  if ((constrainType) &&
+
233  (constraint->wantedType == DATA_TYPE::STRING))
+
234  return new StringValue(val);
+
235 
+
236  // Numeric
+
237  bool isInt;
+
238  long double num;
+
239 
+
240  if (StringTools::ParseNumber(val, isInt, num))
+
241  {
+
242  // Is the type constrained?
+
243  // (only int and float left)
+
244  if (constrainType)
+
245  {
+
246  // Must it be an integer?
+
247  if (constraint->wantedType == DATA_TYPE::INT)
+
248  return new IntValue((long long int)num);
+
249  // Must it be a floating point?
+
250  else if (constraint->wantedType == DATA_TYPE::FLOAT)
+
251  return new FloatValue(num);
+
252  // Else it must be a List
+
253  else
+
254  {
+
255  ListValue* list = new ListValue();
+
256  Value* tmp = ParseValue({ val });
+
257  list->AddValue(tmp);
+
258  delete tmp;
+
259  tmp = nullptr;
+
260  return list;
+
261  }
+
262  }
+
263  // Type is not constrained
+
264  else
+
265  {
+
266  // Integer
+
267  if (isInt)
+
268  return new IntValue((long long int)num);
+
269 
+
270  // Double
+
271  return new FloatValue(num);
+
272  }
+
273  }
+
274 
+
275  // Failed
+
276  return nullptr;
+
277 }
+
278 
+
279 bool Hazelnupp::GetCrashOnFail() const
+
280 {
+
281  return crashOnFail;
+
282 }
+
283 
+
284 void Hazelnupp::ApplyConstraints()
+
285 {
+
286  // Enforce required parameters / default values
+
287  for (const auto& pc : constraints)
+
288  // Parameter in question is not supplied
+
289  if (!HasParam(pc.second.key))
+
290  {
+
291  // Do we have a default value?
+
292  if (pc.second.defaultValue.size() > 0)
+
293  {
+
294  // Then create it now, by its default value
+
295 
+
296  Value* tmp = ParseValue(pc.second.defaultValue, &pc.second);
+
297  parameters.insert(std::pair<std::string, Parameter*>(
+
298  pc.second.key,
+
299  new Parameter(pc.second.key, tmp)
+
300  ));
+
301 
+
302  delete tmp;
+
303  tmp = nullptr;
+
304  }
+
305  // So we do not have a default value...
+
306  else
+
307  {
+
308  // Is it important to have the missing parameter?
+
309  if (pc.second.required)
+
310  // Throw an error message then
+
311  throw HazelnuppConstraintMissingValue(pc.second.key);
+
312  }
+
313  }
+
314 
+
315  return;
+
316 }
+
317 
+
318 const std::string& Hazelnupp::GetExecutableName() const
+
319 {
+
320  return executableName;
+
321 }
+
322 
+
323 const Value& Hazelnupp::operator[](const std::string& key) const
+
324 {
+
325  // Throw exception if param is unknown
+
326  if (!HasParam(key))
+
327  throw HazelnuppInvalidKeyException();
+
328 
+
329  return *parameters.find(key)->second->GetValue();
+
330 }
+
331 
+
332 void Hazelnupp::RegisterAbbreviation(const std::string& abbrev, const std::string& target)
+
333 {
+
334  abbreviations.insert(std::pair<std::string, std::string>(abbrev, target));
+
335  return;
+
336 }
+
337 
+
338 const std::string& Hazelnupp::GetAbbreviation(const std::string& abbrev) const
+
339 {
+
340  return abbreviations.find(abbrev)->second;
+
341 }
+
342 
+
343 bool Hazelnupp::HasAbbreviation(const std::string& abbrev) const
+
344 {
+
345  return abbreviations.find(abbrev) != abbreviations.end();
+
346 }
+
347 
+
348 void Hazelnupp::ClearAbbreviations()
+
349 {
+
350  abbreviations.clear();
+
351  return;
+
352 }
+
353 
+
354 void Hazelnupp::RegisterConstraints(const std::vector<ParamConstraint>& constraints)
+
355 {
+
356  for (const ParamConstraint& pc : constraints)
+
357  {
+
358  // Does this constraint already exist?
+
359  const auto constraint = this->constraints.find(pc.key);
+
360  // If yes, replace it.
+
361  if (constraint != this->constraints.end())
+
362  constraint->second = pc;
+
363 
+
364  // Else, create a new pair
+
365  else
+
366  this->constraints.insert(std::pair<std::string, ParamConstraint>(
+
367  pc.key,
+
368  pc
+
369  ));
+
370  }
+
371 
+
372  return;
+
373 }
+
374 
+
375 void Hazelnupp::ClearConstraints()
+
376 {
+
377  constraints.clear();
+
378  return;
+
379 }
+
380 
+
381 void Hazelnupp::SetCrashOnFail(bool crashOnFail)
+
382 {
+
383  this->crashOnFail = crashOnFail;
+
384  return;
+
385 }
+
386 
+
387 const ParamConstraint* Hazelnupp::GetConstraintForKey(const std::string& key) const
+
388 {
+
389  const auto constraint = constraints.find(key);
+
390 
+
391  if (constraint == constraints.end())
+
392  return nullptr;
+
393 
+
394  return &constraint->second;
+
395 }
-
HazelnuppException::What
const std::string & What() const
Will return an error message.
Definition: HazelnuppException.h:13
-
Hazelnupp::Hazelnupp
Hazelnupp()
Definition: Hazelnupp.cpp:12
HazelnuppException.h
-
ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:31
-
DATA_TYPE::VOID
@ VOID
-
Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:330
-
StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:54
-
Hazelnupp::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: Hazelnupp.cpp:373
-
IntValue
Specializations for integer values (uses long long int)
Definition: IntValue.h:6
-
ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:7
-
Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:352
-
DATA_TYPE::LIST
@ LIST
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::IntValue
Specializations for integer values (uses long long int)
Definition: IntValue.h:8
+
Hazelnp::StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:56
+
Hazelnp::StringTools::ParseNumber
static bool ParseNumber(const std::string &str, bool &out_isInt, long double &out_number)
Will convert the number in str to a number.
Definition: StringTools.cpp:82
+
Hazelnp::Hazelnupp::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: Hazelnupp.cpp:375
+
Hazelnp::HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:26
+
Hazelnp::Hazelnupp::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: Hazelnupp.cpp:318
+
Hazelnp::Hazelnupp::~Hazelnupp
~Hazelnupp()
Definition: Hazelnupp.cpp:25
+
Hazelnp::Hazelnupp::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: Hazelnupp.cpp:323
StringValue.h
+
Hazelnp::HazelnuppException::What
const std::string & What() const
Will return an error message.
Definition: HazelnuppException.h:15
IntValue.h
-
HazelnuppConstraintTypeMissmatch
Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...
Definition: HazelnuppException.h:51
-
DATA_TYPE::FLOAT
@ FLOAT
-
Value
Abstract class for values.
Definition: Value.h:8
-
HazelnuppConstraintMissingValue
Gets thrown when a parameter constrained to be required is not provided, and has no default value set...
Definition: HazelnuppException.h:60
-
Parameter
Definition: Parameter.h:6
-
Hazelnupp::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f)
Definition: Hazelnupp.cpp:336
-
Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:19
-
VoidValue
Specializations for void values.
Definition: VoidValue.h:6
-
Hazelnupp::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: Hazelnupp.cpp:341
-
DATA_TYPE::INT
@ INT
+
Hazelnp::Hazelnupp::Hazelnupp
Hazelnupp()
Definition: Hazelnupp.cpp:14
+
Hazelnp::Hazelnupp::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: Hazelnupp.cpp:348
+
Hazelnp::DATA_TYPE::VOID
@ VOID
+
Hazelnp::FloatValue
Specializations for floating point values (uses long double)
Definition: FloatValue.h:9
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::Hazelnupp::GetCrashOnFail
bool GetCrashOnFail() const
Gets whether the application crashes on an exception whilst parsing, and prints to stderr.
Definition: Hazelnupp.cpp:279
+
Hazelnp::DATA_TYPE::LIST
@ LIST
+
Hazelnp::Parameter
Definition: Parameter.h:8
+
Hazelnp::ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:57
+
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
+
Hazelnp::Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:153
+
Hazelnp::Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:35
ListValue.h
-
Hazelnupp::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: Hazelnupp.cpp:316
-
FloatValue
Specializations for floating point values (uses long double)
Definition: FloatValue.h:7
-
StringValue
Specializations for string values (uses std::string)
Definition: StringValue.h:7
-
Hazelnupp::~Hazelnupp
~Hazelnupp()
Definition: Hazelnupp.cpp:23
+
Hazelnp::ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:54
+
Hazelnp::Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:21
+
Hazelnp::HazelnuppConstraintMissingValue
Gets thrown when a parameter constrained to be required is not provided, and has no default value set...
Definition: HazelnuppException.h:62
+
Hazelnp::Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:332
+
Hazelnp::HazelnuppConstraintTypeMissmatch
Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...
Definition: HazelnuppException.h:53
VoidValue.h
-
StringTools::ParseNumber
static bool ParseNumber(const std::string &str, bool &out_isInt, long double &out_number)
Will convert the number in str to a number.
Definition: StringTools.cpp:80
+
Hazelnp::Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:354
+
Hazelnp::Hazelnupp::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f)
Definition: Hazelnupp.cpp:338
Hazelnupp.h
-
HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:24
-
Hazelnupp::GetCrashOnFail
bool GetCrashOnFail() const
Gets whether the application crashes on an exception whilst parsing, and prints to stderr.
Definition: Hazelnupp.cpp:277
+
Hazelnp::ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:33
+
Hazelnp::VoidValue
Specializations for void values.
Definition: VoidValue.h:8
+
Hazelnp::DATA_TYPE::FLOAT
@ FLOAT
+
Hazelnp::DATA_TYPE::INT
@ INT
FloatValue.h
-
Hazelnupp::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: Hazelnupp.cpp:379
-
Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:151
-
ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:52
-
DATA_TYPE::STRING
@ STRING
-
ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:55
-
ParamConstraint
Definition: ParamConstraint.h:6
-
Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:33
+
Hazelnp::Hazelnupp::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: Hazelnupp.cpp:343
+
Hazelnp::DATA_TYPE::STRING
@ STRING
+
Hazelnp::Hazelnupp::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: Hazelnupp.cpp:381
+
Hazelnp::ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:9
+
Hazelnp::StringValue
Specializations for string values (uses std::string)
Definition: StringValue.h:9
StringTools.h
-
Hazelnupp::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: Hazelnupp.cpp:321
-
Hazelnupp::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: Hazelnupp.cpp:346
diff --git a/docs/Hazelnupp_8h.html b/docs/Hazelnupp_8h.html index fa16191..d8a12df 100644 --- a/docs/Hazelnupp_8h.html +++ b/docs/Hazelnupp_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
Hazelnupp.h File Reference
@@ -115,14 +116,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  Hazelnupp
 The main class to interface with. More...
class  Hazelnp::Hazelnupp
 The main class to interface with. More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/Hazelnupp_8h_source.html b/docs/Hazelnupp_8h_source.html index 501b119..90dd0a9 100644 --- a/docs/Hazelnupp_8h_source.html +++ b/docs/Hazelnupp_8h_source.html @@ -84,89 +84,93 @@ $(function() {
4 #include <unordered_map>
5 #include <vector>
6 
-
9 class Hazelnupp
-
10 {
-
11 public:
-
12  Hazelnupp();
-
13  Hazelnupp(const int argc, const char* const* argv);
-
14 
-
15  ~Hazelnupp();
+
7 namespace Hazelnp
+
8 {
+
11  class Hazelnupp
+
12  {
+
13  public:
+
14  Hazelnupp();
+
15  Hazelnupp(const int argc, const char* const* argv);
16 
-
18  void Parse(const int argc, const char* const* argv);
-
19 
-
21  const std::string& GetExecutableName() const;
-
22 
-
24  const Value& operator[](const std::string& key) const;
-
25 
-
27  bool HasParam(const std::string& key) const;
-
28 
-
29  // Abbreviations
-
31  void RegisterAbbreviation(const std::string& abbrev, const std::string& target);
-
32 
-
34  const std::string& GetAbbreviation(const std::string& abbrev) const;
-
35 
-
37  bool HasAbbreviation(const std::string& abbrev) const;
-
38 
-
40  void ClearAbbreviations();
-
41 
-
43  void RegisterConstraints(const std::vector<ParamConstraint>& constraints);
-
44 
-
46  void ClearConstraints();
-
47 
-
50  void SetCrashOnFail(bool crashOnFail);
-
51 
-
53  bool GetCrashOnFail() const;
-
54 
-
55 private:
-
57  void PopulateRawArgs(const int argc, const char* const* argv);
-
58 
-
60  void ExpandAbbreviations();
-
61 
-
63  std::size_t ParseNextParameter(const std::size_t parIndex, Parameter*& out_Par);
-
64 
-
66  Value* ParseValue(const std::vector<std::string>& values, const ParamConstraint* constraint = nullptr);
-
67 
-
69  void ApplyConstraints();
-
70 
-
72  const ParamConstraint* GetConstraintForKey(const std::string& key) const;
-
73 
-
74  std::string executableName;
-
75  std::unordered_map<std::string, Parameter*> parameters;
-
76 
-
77  // These are abbreviations. Like, -f for --force.
-
78  std::unordered_map<std::string, std::string> abbreviations;
-
79 
-
80  // Parameter constraints, mapped to keys
-
81  std::unordered_map<std::string, ParamConstraint> constraints;
-
82 
-
83  std::vector<std::string> rawArgs;
+
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;
+
30 
+
31  // Abbreviations
+
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 
+
57  private:
+
59  void PopulateRawArgs(const int argc, const char* const* argv);
+
60 
+
62  void ExpandAbbreviations();
+
63 
+
65  std::size_t ParseNextParameter(const std::size_t parIndex, Parameter*& out_Par);
+
66 
+
68  Value* ParseValue(const std::vector<std::string>& values, const ParamConstraint* constraint = nullptr);
+
69 
+
71  void ApplyConstraints();
+
72 
+
74  const ParamConstraint* GetConstraintForKey(const std::string& key) const;
+
75 
+
76  std::string executableName;
+
77  std::unordered_map<std::string, Parameter*> parameters;
+
78 
+
79  // These are abbreviations. Like, -f for --force.
+
80  std::unordered_map<std::string, std::string> abbreviations;
+
81 
+
82  // Parameter constraints, mapped to keys
+
83  std::unordered_map<std::string, ParamConstraint> constraints;
84 
-
86  bool crashOnFail = true;
-
87 };
+
85  std::vector<std::string> rawArgs;
+
86 
+
88  bool crashOnFail = true;
+
89  };
+
90 }
-
Hazelnupp::Hazelnupp
Hazelnupp()
Definition: Hazelnupp.cpp:12
-
Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:330
-
Hazelnupp::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: Hazelnupp.cpp:373
-
Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:352
-
Value
Abstract class for values.
Definition: Value.h:8
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::Hazelnupp::ClearConstraints
void ClearConstraints()
Will delete all constraints.
Definition: Hazelnupp.cpp:375
+
Hazelnp::Hazelnupp::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: Hazelnupp.cpp:318
+
Hazelnp::Hazelnupp::~Hazelnupp
~Hazelnupp()
Definition: Hazelnupp.cpp:25
+
Hazelnp::Hazelnupp::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: Hazelnupp.cpp:323
+
Hazelnp::Hazelnupp
The main class to interface with.
Definition: Hazelnupp.h:11
+
Hazelnp::Hazelnupp::Hazelnupp
Hazelnupp()
Definition: Hazelnupp.cpp:14
+
Hazelnp::Hazelnupp::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: Hazelnupp.cpp:348
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
ParamConstraint.h
-
Parameter
Definition: Parameter.h:6
-
Hazelnupp::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f)
Definition: Hazelnupp.cpp:336
-
Hazelnupp::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: Hazelnupp.cpp:341
-
Hazelnupp::GetExecutableName
const std::string & GetExecutableName() const
Will return argv[0], the name of the executable.
Definition: Hazelnupp.cpp:316
-
Hazelnupp::~Hazelnupp
~Hazelnupp()
Definition: Hazelnupp.cpp:23
+
Hazelnp::Hazelnupp::GetCrashOnFail
bool GetCrashOnFail() const
Gets whether the application crashes on an exception whilst parsing, and prints to stderr.
Definition: Hazelnupp.cpp:279
+
Hazelnp::Parameter
Definition: Parameter.h:8
+
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
+
Hazelnp::Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:153
+
Hazelnp::Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:35
+
Hazelnp::Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:332
+
Hazelnp::Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:354
+
Hazelnp::Hazelnupp::GetAbbreviation
const std::string & GetAbbreviation(const std::string &abbrev) const
Will return the long form of an abbreviation (like –force for -f)
Definition: Hazelnupp.cpp:338
Parameter.h
-
Hazelnupp::GetCrashOnFail
bool GetCrashOnFail() const
Gets whether the application crashes on an exception whilst parsing, and prints to stderr.
Definition: Hazelnupp.cpp:277
-
Hazelnupp::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: Hazelnupp.cpp:379
-
Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:151
-
Hazelnupp
The main class to interface with.
Definition: Hazelnupp.h:9
-
ParamConstraint
Definition: ParamConstraint.h:6
-
Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:33
-
Hazelnupp::operator[]
const Value & operator[](const std::string &key) const
Will return the value given a key.
Definition: Hazelnupp.cpp:321
-
Hazelnupp::ClearAbbreviations
void ClearAbbreviations()
Will delete all abbreviations.
Definition: Hazelnupp.cpp:346
+
Hazelnp::Hazelnupp::HasAbbreviation
bool HasAbbreviation(const std::string &abbrev) const
Will check wether or not an abbreviation is registered.
Definition: Hazelnupp.cpp:343
+
Hazelnp::Hazelnupp::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: Hazelnupp.cpp:381
diff --git a/docs/IntValue_8cpp.html b/docs/IntValue_8cpp.html index 85296a3..acfeb0e 100644 --- a/docs/IntValue_8cpp.html +++ b/docs/IntValue_8cpp.html @@ -102,7 +102,7 @@ Include dependency graph for IntValue.cpp: diff --git a/docs/IntValue_8cpp_source.html b/docs/IntValue_8cpp_source.html index 8710ead..b1da84a 100644 --- a/docs/IntValue_8cpp_source.html +++ b/docs/IntValue_8cpp_source.html @@ -82,95 +82,98 @@ $(function() {
2 #include "HazelnuppException.h"
3 #include <sstream>
4 
-
5 IntValue::IntValue(const long long int& value)
-
6  :
-
7  Value(DATA_TYPE::INT),
-
8  value { value }
-
9 {
-
10  return;
-
11 }
-
12 
-
13 Value* IntValue::Deepcopy() const
-
14 {
-
15  return new IntValue(value);
-
16 }
-
17 
-
18 std::string IntValue::GetAsOsString() const
-
19 {
-
20  std::stringstream ss;
-
21  ss << "IntValue: " << value;
-
22  return ss.str();
-
23 }
-
24 
-
25 const long long int& IntValue::GetValue() const
-
26 {
-
27  return value;
-
28 }
-
29 
-
30 IntValue::operator long long int() const
-
31 {
-
32  return value;
-
33 }
-
34 
-
35 IntValue::operator int() const
-
36 {
-
37  return (int)value;
-
38 }
-
39 
-
40 
+
5 using namespace Hazelnp;
+
6 
+
7 IntValue::IntValue(const long long int& value)
+
8  :
+
9  Value(DATA_TYPE::INT),
+
10  value { value }
+
11 {
+
12  return;
+
13 }
+
14 
+
15 Value* IntValue::Deepcopy() const
+
16 {
+
17  return new IntValue(value);
+
18 }
+
19 
+
20 std::string IntValue::GetAsOsString() const
+
21 {
+
22  std::stringstream ss;
+
23  ss << "IntValue: " << value;
+
24  return ss.str();
+
25 }
+
26 
+
27 const long long int& IntValue::GetValue() const
+
28 {
+
29  return value;
+
30 }
+
31 
+
32 IntValue::operator long long int() const
+
33 {
+
34  return value;
+
35 }
+
36 
+
37 IntValue::operator int() const
+
38 {
+
39  return (int)value;
+
40 }
41 
-
42 long long int IntValue::GetInt64() const
-
43 {
-
44  return value;
-
45 }
-
46 
-
47 int IntValue::GetInt32() const
-
48 {
-
49  return (int)value;
-
50 }
-
51 
-
52 long double IntValue::GetFloat64() const
-
53 {
-
54  return (long double)value;
-
55 }
-
56 
-
57 double IntValue::GetFloat32() const
-
58 {
-
59  return (double)value;
-
60 }
-
61 
-
62 std::string IntValue::GetString() const
-
63 {
-
64  std::stringstream ss;
-
65  ss << value;
-
66 
-
67  return ss.str();
-
68 }
-
69 
-
70 const std::vector<Value*>& IntValue::GetList() const
-
71 {
-
72  throw HazelnuppValueNotConvertibleException();
-
73 }
+
42 
+
43 
+
44 long long int IntValue::GetInt64() const
+
45 {
+
46  return value;
+
47 }
+
48 
+
49 int IntValue::GetInt32() const
+
50 {
+
51  return (int)value;
+
52 }
+
53 
+
54 long double IntValue::GetFloat64() const
+
55 {
+
56  return (long double)value;
+
57 }
+
58 
+
59 double IntValue::GetFloat32() const
+
60 {
+
61  return (double)value;
+
62 }
+
63 
+
64 std::string IntValue::GetString() const
+
65 {
+
66  std::stringstream ss;
+
67  ss << value;
+
68 
+
69  return ss.str();
+
70 }
+
71 
+
72 const std::vector<Value*>& IntValue::GetList() const
+
73 {
+
74  throw HazelnuppValueNotConvertibleException();
+
75 }
HazelnuppException.h
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
IntValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: IntValue.cpp:18
-
IntValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: IntValue.cpp:57
+
Hazelnp::IntValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: IntValue.cpp:20
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::IntValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: IntValue.cpp:59
IntValue.h
-
Value
Abstract class for values.
Definition: Value.h:8
-
HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:33
-
DATA_TYPE::INT
@ INT
-
IntValue::GetValue
const long long int & GetValue() const
Will return the raw value.
Definition: IntValue.cpp:25
-
IntValue::IntValue
IntValue(const long long int &value)
Definition: IntValue.cpp:5
-
IntValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: IntValue.cpp:47
-
IntValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: IntValue.cpp:52
-
IntValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: IntValue.cpp:62
-
IntValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: IntValue.cpp:13
-
IntValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: IntValue.cpp:70
-
IntValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: IntValue.cpp:42
+
Hazelnp::IntValue::IntValue
IntValue(const long long int &value)
Definition: IntValue.cpp:7
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::IntValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: IntValue.cpp:49
+
Hazelnp::IntValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: IntValue.cpp:72
+
Hazelnp::IntValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: IntValue.cpp:54
+
Hazelnp::IntValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: IntValue.cpp:64
+
Hazelnp::IntValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: IntValue.cpp:44
+
Hazelnp::IntValue::GetValue
const long long int & GetValue() const
Will return the raw value.
Definition: IntValue.cpp:27
+
Hazelnp::IntValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: IntValue.cpp:15
+
Hazelnp::DATA_TYPE::INT
@ INT
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
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 084ee89..4947e93 100644 --- a/docs/IntValue_8h.html +++ b/docs/IntValue_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
IntValue.h File Reference
@@ -109,14 +110,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  IntValue
 Specializations for integer values (uses long long int) More...
class  Hazelnp::IntValue
 Specializations for integer values (uses long long int) More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/IntValue_8h_source.html b/docs/IntValue_8h_source.html index 99b2202..b67110e 100644 --- a/docs/IntValue_8h_source.html +++ b/docs/IntValue_8h_source.html @@ -81,53 +81,57 @@ $(function() { Go to the documentation of this file.
1 #pragma once
2 #include "Value.h"
3 
-
6 class IntValue : public Value
-
7 {
-
8 public:
-
9  IntValue(const long long int& value);
-
10  ~IntValue() override {};
-
11 
-
13  Value* Deepcopy() const override;
-
14 
-
16  std::string GetAsOsString() const override;
-
17 
-
19  const long long int& GetValue() const;
-
20 
-
21  operator long long int() const;
-
22  operator int() const;
-
23 
-
24 
-
26  long long int GetInt64() const override;
-
28  int GetInt32() const override;
-
29 
-
31  long double GetFloat64() const override;
-
33  double GetFloat32() const override;
-
34 
-
36  std::string GetString() const override;
-
37 
-
39  const std::vector<Value*>& GetList() const override;
-
40 
-
41 private:
-
42  long long int value;
-
43 };
+
4 namespace Hazelnp
+
5 {
+
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;
+
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;
+
42 
+
43  private:
+
44  long long int value;
+
45  };
+
46 }
-
IntValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: IntValue.cpp:18
-
IntValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: IntValue.cpp:57
-
IntValue
Specializations for integer values (uses long long int)
Definition: IntValue.h:6
-
Value
Abstract class for values.
Definition: Value.h:8
-
IntValue::GetValue
const long long int & GetValue() const
Will return the raw value.
Definition: IntValue.cpp:25
-
IntValue::IntValue
IntValue(const long long int &value)
Definition: IntValue.cpp:5
-
IntValue::~IntValue
~IntValue() override
Definition: IntValue.h:10
-
IntValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: IntValue.cpp:47
-
IntValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: IntValue.cpp:52
-
IntValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: IntValue.cpp:62
-
IntValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: IntValue.cpp:13
-
IntValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: IntValue.cpp:70
-
IntValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: IntValue.cpp:42
+
Hazelnp::IntValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: IntValue.cpp:20
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::IntValue
Specializations for integer values (uses long long int)
Definition: IntValue.h:8
+
Hazelnp::IntValue::GetFloat32
double GetFloat32() const override
Will return the data as a double.
Definition: IntValue.cpp:59
+
Hazelnp::IntValue::~IntValue
~IntValue() override
Definition: IntValue.h:12
+
Hazelnp::IntValue::IntValue
IntValue(const long long int &value)
Definition: IntValue.cpp:7
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::IntValue::GetInt32
int GetInt32() const override
Will return the data as an int.
Definition: IntValue.cpp:49
+
Hazelnp::IntValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: IntValue.cpp:72
+
Hazelnp::IntValue::GetFloat64
long double GetFloat64() const override
Will return the data as a long double.
Definition: IntValue.cpp:54
+
Hazelnp::IntValue::GetString
std::string GetString() const override
Will return the data as a string.
Definition: IntValue.cpp:64
+
Hazelnp::IntValue::GetInt64
long long int GetInt64() const override
Will return the data as a long long int.
Definition: IntValue.cpp:44
+
Hazelnp::IntValue::GetValue
const long long int & GetValue() const
Will return the raw value.
Definition: IntValue.cpp:27
+
Hazelnp::IntValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: IntValue.cpp:15
Value.h
diff --git a/docs/ListValue_8cpp.html b/docs/ListValue_8cpp.html index 6d592d0..049011f 100644 --- a/docs/ListValue_8cpp.html +++ b/docs/ListValue_8cpp.html @@ -102,7 +102,7 @@ Include dependency graph for ListValue.cpp: diff --git a/docs/ListValue_8cpp_source.html b/docs/ListValue_8cpp_source.html index 77677e1..c686f82 100644 --- a/docs/ListValue_8cpp_source.html +++ b/docs/ListValue_8cpp_source.html @@ -82,121 +82,124 @@ $(function() {
2 #include "HazelnuppException.h"
3 #include <sstream>
4 
-
5 ListValue::ListValue() :
-
6  Value(DATA_TYPE::LIST)
-
7 {
-
8  return;
-
9 }
-
10 
-
11 ListValue::~ListValue()
-
12 {
-
13  for (Value* val : value)
-
14  delete val;
-
15 
-
16  value.clear();
-
17 
-
18  return;
-
19 }
-
20 
-
21 Value* ListValue::Deepcopy() const
-
22 {
-
23  ListValue* newList = new ListValue();
-
24 
-
25  for (const Value* val : value)
-
26  newList->AddValue(val);
-
27 
-
28  return newList;
-
29 }
-
30 
-
31 void ListValue::AddValue(const Value* value)
-
32 {
-
33  this->value.emplace_back(value->Deepcopy());
-
34  return;
-
35 }
-
36 
-
37 const std::vector<Value*>& ListValue::GetValue() const
-
38 {
-
39  return value;
-
40 }
-
41 
-
42 std::string ListValue::GetAsOsString() const
-
43 {
-
44  std::stringstream ss;
-
45 
-
46  ss << "ListValue: [";
+
5 using namespace Hazelnp;
+
6 
+
7 ListValue::ListValue() :
+
8  Value(DATA_TYPE::LIST)
+
9 {
+
10  return;
+
11 }
+
12 
+
13 ListValue::~ListValue()
+
14 {
+
15  for (Value* val : value)
+
16  delete val;
+
17 
+
18  value.clear();
+
19 
+
20  return;
+
21 }
+
22 
+
23 Value* ListValue::Deepcopy() const
+
24 {
+
25  ListValue* newList = new ListValue();
+
26 
+
27  for (const Value* val : value)
+
28  newList->AddValue(val);
+
29 
+
30  return newList;
+
31 }
+
32 
+
33 void ListValue::AddValue(const Value* value)
+
34 {
+
35  this->value.emplace_back(value->Deepcopy());
+
36  return;
+
37 }
+
38 
+
39 const std::vector<Value*>& ListValue::GetValue() const
+
40 {
+
41  return value;
+
42 }
+
43 
+
44 std::string ListValue::GetAsOsString() const
+
45 {
+
46  std::stringstream ss;
47 
-
48  for (const Value* val : value)
-
49  {
-
50  ss << *val;
-
51  if (val != value.back())
-
52  ss << ", ";
-
53  }
-
54 
-
55  ss << "]";
+
48  ss << "ListValue: [";
+
49 
+
50  for (const Value* val : value)
+
51  {
+
52  ss << *val;
+
53  if (val != value.back())
+
54  ss << ", ";
+
55  }
56 
-
57  return ss.str();
-
58 }
-
59 
-
60 ListValue::operator std::vector<Value*>() const
-
61 {
-
62  return value;
-
63 }
-
64 
-
65 
+
57  ss << "]";
+
58 
+
59  return ss.str();
+
60 }
+
61 
+
62 ListValue::operator std::vector<Value*>() const
+
63 {
+
64  return value;
+
65 }
66 
-
67 long long int ListValue::GetInt64() const
-
68 {
-
69  throw HazelnuppValueNotConvertibleException();
-
70 }
-
71 
-
72 int ListValue::GetInt32() const
-
73 {
-
74  throw HazelnuppValueNotConvertibleException();
-
75 }
-
76 
-
77 long double ListValue::GetFloat64() const
-
78 {
-
79  throw HazelnuppValueNotConvertibleException();
-
80 }
-
81 
-
82 double ListValue::GetFloat32() const
-
83 {
-
84  throw HazelnuppValueNotConvertibleException();
-
85 }
-
86 
-
87 std::string ListValue::GetString() const
-
88 {
-
89  throw HazelnuppValueNotConvertibleException();
-
90 }
-
91 
-
92 const std::vector<Value*>& ListValue::GetList() const
-
93 {
-
94  return value;
-
95 }
+
67 
+
68 
+
69 long long int ListValue::GetInt64() const
+
70 {
+
71  throw HazelnuppValueNotConvertibleException();
+
72 }
+
73 
+
74 int ListValue::GetInt32() const
+
75 {
+
76  throw HazelnuppValueNotConvertibleException();
+
77 }
+
78 
+
79 long double ListValue::GetFloat64() const
+
80 {
+
81  throw HazelnuppValueNotConvertibleException();
+
82 }
+
83 
+
84 double ListValue::GetFloat32() const
+
85 {
+
86  throw HazelnuppValueNotConvertibleException();
+
87 }
+
88 
+
89 std::string ListValue::GetString() const
+
90 {
+
91  throw HazelnuppValueNotConvertibleException();
+
92 }
+
93 
+
94 const std::vector<Value*>& ListValue::GetList() const
+
95 {
+
96  return value;
+
97 }
+
Hazelnp::ListValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: ListValue.cpp:44
HazelnuppException.h
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:31
-
ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:7
-
ListValue::~ListValue
~ListValue() override
Definition: ListValue.cpp:11
-
ListValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:82
-
DATA_TYPE::LIST
@ LIST
-
ListValue::ListValue
ListValue()
Definition: ListValue.cpp:5
-
ListValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: ListValue.cpp:21
-
Value
Abstract class for values.
Definition: Value.h:8
-
Value::Deepcopy
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
-
ListValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:77
-
HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:33
-
ListValue::GetList
const std::vector< Value * > & GetList() const override
Will return this values list.
Definition: ListValue.cpp:92
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::ListValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:84
+
Hazelnp::ListValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:89
+
Hazelnp::ListValue::GetList
const std::vector< Value * > & GetList() const override
Will return this values list.
Definition: ListValue.cpp:94
+
Hazelnp::ListValue::GetValue
const std::vector< Value * > & GetValue() const
Will return the raw value.
Definition: ListValue.cpp:39
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::DATA_TYPE::LIST
@ LIST
+
Hazelnp::ListValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:69
+
Hazelnp::ListValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:74
ListValue.h
-
ListValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: ListValue.cpp:42
-
ListValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:67
-
ListValue::GetValue
const std::vector< Value * > & GetValue() const
Will return the raw value.
Definition: ListValue.cpp:37
-
ListValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:72
-
ListValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:87
+
Hazelnp::ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:33
+
Hazelnp::ListValue::~ListValue
~ListValue() override
Definition: ListValue.cpp:13
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
Hazelnp::ListValue::ListValue
ListValue()
Definition: ListValue.cpp:7
+
Hazelnp::ListValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: ListValue.cpp:23
+
Hazelnp::Value::Deepcopy
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
+
Hazelnp::ListValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:79
+
Hazelnp::ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:9
+
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 1ec16cf..9e269dc 100644 --- a/docs/ListValue_8h.html +++ b/docs/ListValue_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
ListValue.h File Reference
@@ -109,14 +110,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  ListValue
 Specializations for list values (uses std::vector<Value*>) More...
class  Hazelnp::ListValue
 Specializations for list values (uses std::vector<Value*>) More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/ListValue_8h_source.html b/docs/ListValue_8h_source.html index 03518a4..1c55e30 100644 --- a/docs/ListValue_8h_source.html +++ b/docs/ListValue_8h_source.html @@ -82,54 +82,58 @@ $(function() {
2 #include "Value.h"
3 #include <vector>
4 
-
7 class ListValue : public Value
-
8 {
-
9 public:
-
10  ListValue();
-
11  ~ListValue() override;
-
12 
-
14  Value* Deepcopy() const override;
-
15 
-
17  std::string GetAsOsString() const override;
-
18 
-
20  void AddValue(const Value* value);
-
21 
-
23  const std::vector<Value*>& GetValue() const;
-
24 
-
25  operator std::vector<Value*>() const;
+
5 namespace Hazelnp
+
6 {
+
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;
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;
-
42 
-
43 private:
-
44  std::vector<Value*> value;
-
45 };
+
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;
+
44 
+
45  private:
+
46  std::vector<Value*> value;
+
47  };
+
48 }
-
ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:31
-
ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:7
-
ListValue::~ListValue
~ListValue() override
Definition: ListValue.cpp:11
-
ListValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:82
-
ListValue::ListValue
ListValue()
Definition: ListValue.cpp:5
-
ListValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: ListValue.cpp:21
-
Value
Abstract class for values.
Definition: Value.h:8
-
ListValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:77
-
ListValue::GetList
const std::vector< Value * > & GetList() const override
Will return this values list.
Definition: ListValue.cpp:92
-
ListValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: ListValue.cpp:42
-
ListValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:67
-
ListValue::GetValue
const std::vector< Value * > & GetValue() const
Will return the raw value.
Definition: ListValue.cpp:37
-
ListValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:72
-
ListValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:87
+
Hazelnp::ListValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: ListValue.cpp:44
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::ListValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:84
+
Hazelnp::ListValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:89
+
Hazelnp::ListValue::GetList
const std::vector< Value * > & GetList() const override
Will return this values list.
Definition: ListValue.cpp:94
+
Hazelnp::ListValue::GetValue
const std::vector< Value * > & GetValue() const
Will return the raw value.
Definition: ListValue.cpp:39
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::ListValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:69
+
Hazelnp::ListValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:74
+
Hazelnp::ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:33
+
Hazelnp::ListValue::~ListValue
~ListValue() override
Definition: ListValue.cpp:13
+
Hazelnp::ListValue::ListValue
ListValue()
Definition: ListValue.cpp:7
+
Hazelnp::ListValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: ListValue.cpp:23
+
Hazelnp::ListValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: ListValue.cpp:79
+
Hazelnp::ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:9
Value.h
diff --git a/docs/ParamConstraint_8h.html b/docs/ParamConstraint_8h.html index 617965d..b0173e2 100644 --- a/docs/ParamConstraint_8h.html +++ b/docs/ParamConstraint_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
ParamConstraint.h File Reference
@@ -110,13 +111,18 @@ This graph shows which files directly or indirectly include this file: - + + +

Classes

struct  ParamConstraint
struct  Hazelnp::ParamConstraint
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/ParamConstraint_8h_source.html b/docs/ParamConstraint_8h_source.html index 1aa71ee..770bd5a 100644 --- a/docs/ParamConstraint_8h_source.html +++ b/docs/ParamConstraint_8h_source.html @@ -83,69 +83,73 @@ $(function() {
3 #include <string>
4 #include <vector>
5 
-
6 struct ParamConstraint
+
6 namespace Hazelnp
7 {
-
8 public:
-
10  ParamConstraint() = default;
-
11 
-
14  static ParamConstraint Require(const std::string& key, const std::vector<std::string>& defaultValue = {}, bool required = true)
-
15  {
-
16  ParamConstraint pc;
-
17  pc.key = key;
-
18  pc.defaultValue = defaultValue;
-
19  pc.required = required;
-
20 
-
21  return pc;
-
22  }
-
23 
-
25  static ParamConstraint TypeSafety(const std::string& key, DATA_TYPE wantedType, bool constrainType = true)
-
26  {
-
27  ParamConstraint pc;
-
28  pc.key = key;
-
29  pc.constrainType = constrainType;
-
30  pc.wantedType = wantedType;
-
31 
-
32  return pc;
-
33  }
-
34 
-
36  ParamConstraint(const std::string& key, bool constrainType, DATA_TYPE wantedType, const std::vector<std::string>& defaultValue, bool required)
-
37  :
-
38  key { key },
-
39  constrainType { constrainType },
-
40  wantedType { wantedType },
-
41  defaultValue { defaultValue },
-
42  required{ required }
-
43  {
-
44  return;
-
45  }
-
46 
-
48  std::string key;
-
49 
-
52  bool constrainType = false;
-
53 
-
55  DATA_TYPE wantedType = DATA_TYPE::VOID;
-
56 
-
60  std::vector<std::string> defaultValue;
-
61 
-
64  bool required = false;
-
65 };
+
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)
+
17  {
+
18  ParamConstraint pc;
+
19  pc.key = key;
+
20  pc.defaultValue = defaultValue;
+
21  pc.required = required;
+
22 
+
23  return pc;
+
24  }
+
25 
+
27  static ParamConstraint TypeSafety(const std::string& key, DATA_TYPE wantedType, bool constrainType = true)
+
28  {
+
29  ParamConstraint pc;
+
30  pc.key = key;
+
31  pc.constrainType = constrainType;
+
32  pc.wantedType = wantedType;
+
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)
+
39  :
+
40  key{ key },
+
41  constrainType{ constrainType },
+
42  wantedType{ wantedType },
+
43  defaultValue{ defaultValue },
+
44  required{ required }
+
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;
+
67  };
+
68 }
+
Hazelnp
Definition: DataType.h:3
DataType.h
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
DATA_TYPE::VOID
@ VOID
-
ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:64
-
ParamConstraint::ParamConstraint
ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)
Whole constructor.
Definition: ParamConstraint.h:36
-
ParamConstraint::TypeSafety
static ParamConstraint TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)
Constructs a type-safety constraint.
Definition: ParamConstraint.h:25
-
ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:60
-
ParamConstraint::Require
static ParamConstraint Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)
Constructs a require constraint.
Definition: ParamConstraint.h:14
-
ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:48
-
ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:52
-
ParamConstraint::ParamConstraint
ParamConstraint()=default
Empty constructor.
-
ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:55
-
ParamConstraint
Definition: ParamConstraint.h:6
+
Hazelnp::DATA_TYPE::VOID
@ VOID
+
Hazelnp::ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:57
+
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
+
Hazelnp::ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:54
+
Hazelnp::ParamConstraint::ParamConstraint
ParamConstraint()=default
Empty constructor.
+
Hazelnp::ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:50
+
Hazelnp::ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:66
+
Hazelnp::ParamConstraint::Require
static ParamConstraint Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)
Constructs a require constraint.
Definition: ParamConstraint.h:16
+
Hazelnp::ParamConstraint::ParamConstraint
ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)
Whole constructor.
Definition: ParamConstraint.h:38
+
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
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
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 078e35d..f222b76 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 57ec943..4a74171 100644 --- a/docs/Parameter_8cpp_source.html +++ b/docs/Parameter_8cpp_source.html @@ -80,40 +80,43 @@ $(function() {
Go to the documentation of this file.
1 #include "Parameter.h"
2 
-
3 Parameter::Parameter(const std::string& key, const ::Value* value)
-
4  :
-
5  key{ key }
-
6 {
-
7  this->value = value->Deepcopy();
-
8  return;
-
9 }
-
10 
- -
12 {
-
13  delete value;
-
14  value = nullptr;
-
15 
-
16  return;
-
17 }
-
18 
-
19 const std::string& Parameter::Key() const
-
20 {
-
21  return key;
-
22 }
-
23 
-
24 const ::Value* Parameter::GetValue() const
-
25 {
-
26  return value;
-
27 }
+
3 using namespace Hazelnp;
+
4 
+
5 Parameter::Parameter(const std::string& key, const ::Value* value)
+
6  :
+
7  key{ key }
+
8 {
+
9  this->value = value->Deepcopy();
+
10  return;
+
11 }
+
12 
+ +
14 {
+
15  delete value;
+
16  value = nullptr;
+
17 
+
18  return;
+
19 }
+
20 
+
21 const std::string& Parameter::Key() const
+
22 {
+
23  return key;
+
24 }
+
25 
+
26 const ::Value* Parameter::GetValue() const
+
27 {
+
28  return value;
+
29 }
-
Parameter::~Parameter
~Parameter()
Definition: Parameter.cpp:11
-
Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:19
-
Parameter::GetValue
const Value * GetValue() const
Will return the value of this parameter.
Definition: Parameter.cpp:24
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::Parameter::~Parameter
~Parameter()
Definition: Parameter.cpp:13
+
Hazelnp::Parameter::GetValue
const Value * GetValue() const
Will return the value of this parameter.
Definition: Parameter.cpp:26
+
Hazelnp::Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:21
+
Hazelnp::Parameter::Parameter
Parameter(const std::string &key, const Value *value)
Definition: Parameter.cpp:5
Parameter.h
-
Parameter::Parameter
Parameter(const std::string &key, const Value *value)
Definition: Parameter.cpp:3
diff --git a/docs/Parameter_8h.html b/docs/Parameter_8h.html index 78c55df..7057ffe 100644 --- a/docs/Parameter_8h.html +++ b/docs/Parameter_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
Parameter.h File Reference
@@ -113,13 +114,18 @@ This graph shows which files directly or indirectly include this file: - + + +

Classes

class  Parameter
class  Hazelnp::Parameter
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/Parameter_8h_source.html b/docs/Parameter_8h_source.html index 3e2b320..e39a68e 100644 --- a/docs/Parameter_8h_source.html +++ b/docs/Parameter_8h_source.html @@ -83,37 +83,41 @@ $(function() {
3 #include <string>
4 #include <ostream>
5 
-
6 class Parameter
+
6 namespace Hazelnp
7 {
-
8 public:
-
9  explicit Parameter(const std::string& key, const Value* value);
-
10  ~Parameter();
-
11 
-
13  const std::string& Key() const;
-
14 
-
16  const Value* GetValue() const;
-
17 
-
18  friend std::ostream& operator<< (std::ostream& os, const Parameter& p)
-
19  {
-
20  return os << "{ Key: \"" << p.key << "\" -> " << *p.value << " }";
-
21  }
-
22 
-
23 private:
-
24  std::string key;
-
25  ::Value* value;
-
26 };
+
8  class Parameter
+
9  {
+
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;
+
19 
+
20  friend std::ostream& operator<< (std::ostream& os, const Parameter& p)
+
21  {
+
22  return os << "{ Key: \"" << p.key << "\" -> " << *p.value << " }";
+
23  }
+
24 
+
25  private:
+
26  std::string key;
+
27  Hazelnp::Value* value;
+
28  };
+
29 }
-
Parameter::operator<<
friend std::ostream & operator<<(std::ostream &os, const Parameter &p)
Definition: Parameter.h:18
-
Value
Abstract class for values.
Definition: Value.h:8
-
Parameter::~Parameter
~Parameter()
Definition: Parameter.cpp:11
-
Parameter
Definition: Parameter.h:6
-
Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:19
-
Parameter::GetValue
const Value * GetValue() const
Will return the value of this parameter.
Definition: Parameter.cpp:24
-
Parameter::Parameter
Parameter(const std::string &key, const Value *value)
Definition: Parameter.cpp:3
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::Parameter::~Parameter
~Parameter()
Definition: Parameter.cpp:13
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::Parameter
Definition: Parameter.h:8
+
Hazelnp::Parameter::GetValue
const Value * GetValue() const
Will return the value of this parameter.
Definition: Parameter.cpp:26
+
Hazelnp::Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:21
+
Hazelnp::Parameter::Parameter
Parameter(const std::string &key, const Value *value)
Definition: Parameter.cpp:5
+
Hazelnp::Parameter::operator<<
friend std::ostream & operator<<(std::ostream &os, const Parameter &p)
Definition: Parameter.h:20
Value.h
diff --git a/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html b/docs/Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html index 3cc2a2f..9b35c4d 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 6e04e69..2e0db2e 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 04ee1b2..08f0dea 100644 --- a/docs/StringTools_8cpp_source.html +++ b/docs/StringTools_8cpp_source.html @@ -80,199 +80,202 @@ $(function() {
Go to the documentation of this file.
1 #include "StringTools.h"
2 
-
3 bool StringTools::Contains(const std::string& str, const char c)
-
4 {
-
5  for (const char& i : str)
-
6  if (i == c)
-
7  return true;
-
8 
-
9  return false;
-
10 }
-
11 
-
12 std::string StringTools::Replace(const std::string& str, const char find, const std::string& subst)
-
13 {
-
14  std::stringstream ss;
-
15 
-
16  for (std::size_t i = 0; i < str.length(); i++)
-
17  {
-
18  if (str[i] != find) ss << str[i];
-
19  else ss << subst;
-
20  }
-
21 
-
22  return ss.str();
-
23 }
-
24 
-
25 std::string StringTools::Replace(const std::string& str, const std::string& find, const std::string& subst)
-
26 {
-
27  if (find.length() == 0) return str;
-
28 
-
29  std::stringstream ss;
+
3 using namespace Hazelnp;
+
4 
+
5 bool StringTools::Contains(const std::string& str, const char c)
+
6 {
+
7  for (const char& i : str)
+
8  if (i == c)
+
9  return true;
+
10 
+
11  return false;
+
12 }
+
13 
+
14 std::string StringTools::Replace(const std::string& str, const char find, const std::string& subst)
+
15 {
+
16  std::stringstream ss;
+
17 
+
18  for (std::size_t i = 0; i < str.length(); i++)
+
19  {
+
20  if (str[i] != find) ss << str[i];
+
21  else ss << subst;
+
22  }
+
23 
+
24  return ss.str();
+
25 }
+
26 
+
27 std::string StringTools::Replace(const std::string& str, const std::string& find, const std::string& subst)
+
28 {
+
29  if (find.length() == 0) return str;
30 
-
31  std::size_t posFound = 0;
-
32  std::size_t lastFound = 0;
-
33 
-
34  while (posFound != std::string::npos)
-
35  {
-
36  lastFound = posFound;
-
37  posFound = str.find(find, posFound);
-
38 
-
39  if (posFound != std::string::npos)
-
40  {
-
41  ss << str.substr(lastFound, posFound - lastFound) << subst;
-
42  posFound += find.length();
-
43  }
-
44  else
-
45  {
-
46  ss << str.substr(lastFound, (str.length()) - lastFound);
-
47  }
-
48  }
-
49 
-
50  return ss.str();
-
51 }
-
52 
-
53 
-
54 bool StringTools::IsNumeric(const std::string& str, const bool allowDecimalPoint)
-
55 {
-
56  if (str.length() == 0) return false;
-
57 
-
58  bool alreadyParsedDecimalPoint = false;
-
59  std::size_t digitCount = 0;
-
60 
-
61  for (std::size_t i = 0; i < str.length(); i++)
-
62  {
-
63  if (!(
-
64  ((str[i] >= '0') && (str[i] <= '9')) ||
-
65  ((str[i] == '-') && (i == 0)) ||
-
66  ((str[i] == '.') && (allowDecimalPoint) && (!alreadyParsedDecimalPoint) && (digitCount > 0))
-
67  )) return false;
-
68 
-
69 
-
70  // Here we just have to check for the character. Not for any other conditions.
-
71  // Why? Because if these conditions failed, the function would have already returned false.
-
72  if (((str[i] >= '0') && (str[i] <= '9'))) digitCount++;
-
73  if (str[i] == '.') alreadyParsedDecimalPoint = true;
-
74  }
-
75 
-
76  // Even if we did not find any invalid chars, we should still return false, if we found no digits at all.
-
77  return digitCount > 0;
-
78 }
-
79 
-
80 bool StringTools::ParseNumber(const std::string& str, bool& out_isInt, long double& out_number)
-
81 {
-
82  bool isDecimal = false;
-
83 
-
84  if (str.length() == 0) return false;
-
85  if (Contains(str, '.')) isDecimal = true;
-
86 
-
87  if (isDecimal)
-
88  {
-
89  try
-
90  {
-
91  out_number = std::stold(str);
-
92  out_isInt = false;
-
93  }
-
94  catch (std::invalid_argument&)
-
95  {
-
96  return false;
-
97  }
-
98  catch (std::out_of_range&)
-
99  {
-
100  return false;
-
101  }
-
102  }
-
103  else
-
104  {
-
105  try
-
106  {
-
107  out_number = (long double)std::stoll(str);
-
108  out_isInt = true;
-
109  }
-
110  catch (std::invalid_argument&)
-
111  {
-
112  return false;
-
113  }
-
114  catch (std::out_of_range&)
-
115  {
-
116  return false;
-
117  }
-
118  }
-
119 
-
120  return true;
-
121 }
-
122 
-
123 std::vector<std::string> StringTools::SplitString(const std::string& str, const char delimiter)
-
124 {
-
125  if (str.length() == 0) return std::vector<std::string>();
-
126 
-
127  return SplitString(str, delimiter);
-
128 }
-
129 
-
130 std::vector<std::string> StringTools::SplitString(const std::string& str, const std::string& delimiter)
-
131 {
-
132  if (str.length() == 0) return std::vector<std::string>();
-
133 
-
134  std::vector<std::string> parts;
+
31  std::stringstream ss;
+
32 
+
33  std::size_t posFound = 0;
+
34  std::size_t lastFound = 0;
+
35 
+
36  while (posFound != std::string::npos)
+
37  {
+
38  lastFound = posFound;
+
39  posFound = str.find(find, posFound);
+
40 
+
41  if (posFound != std::string::npos)
+
42  {
+
43  ss << str.substr(lastFound, posFound - lastFound) << subst;
+
44  posFound += find.length();
+
45  }
+
46  else
+
47  {
+
48  ss << str.substr(lastFound, (str.length()) - lastFound);
+
49  }
+
50  }
+
51 
+
52  return ss.str();
+
53 }
+
54 
+
55 
+
56 bool StringTools::IsNumeric(const std::string& str, const bool allowDecimalPoint)
+
57 {
+
58  if (str.length() == 0) return false;
+
59 
+
60  bool alreadyParsedDecimalPoint = false;
+
61  std::size_t digitCount = 0;
+
62 
+
63  for (std::size_t i = 0; i < str.length(); i++)
+
64  {
+
65  if (!(
+
66  ((str[i] >= '0') && (str[i] <= '9')) ||
+
67  ((str[i] == '-') && (i == 0)) ||
+
68  ((str[i] == '.') && (allowDecimalPoint) && (!alreadyParsedDecimalPoint) && (digitCount > 0))
+
69  )) return false;
+
70 
+
71 
+
72  // Here we just have to check for the character. Not for any other conditions.
+
73  // Why? Because if these conditions failed, the function would have already returned false.
+
74  if (((str[i] >= '0') && (str[i] <= '9'))) digitCount++;
+
75  if (str[i] == '.') alreadyParsedDecimalPoint = true;
+
76  }
+
77 
+
78  // Even if we did not find any invalid chars, we should still return false, if we found no digits at all.
+
79  return digitCount > 0;
+
80 }
+
81 
+
82 bool StringTools::ParseNumber(const std::string& str, bool& out_isInt, long double& out_number)
+
83 {
+
84  bool isDecimal = false;
+
85 
+
86  if (str.length() == 0) return false;
+
87  if (Contains(str, '.')) isDecimal = true;
+
88 
+
89  if (isDecimal)
+
90  {
+
91  try
+
92  {
+
93  out_number = std::stold(str);
+
94  out_isInt = false;
+
95  }
+
96  catch (std::invalid_argument&)
+
97  {
+
98  return false;
+
99  }
+
100  catch (std::out_of_range&)
+
101  {
+
102  return false;
+
103  }
+
104  }
+
105  else
+
106  {
+
107  try
+
108  {
+
109  out_number = (long double)std::stoll(str);
+
110  out_isInt = true;
+
111  }
+
112  catch (std::invalid_argument&)
+
113  {
+
114  return false;
+
115  }
+
116  catch (std::out_of_range&)
+
117  {
+
118  return false;
+
119  }
+
120  }
+
121 
+
122  return true;
+
123 }
+
124 
+
125 std::vector<std::string> StringTools::SplitString(const std::string& str, const char delimiter)
+
126 {
+
127  if (str.length() == 0) return std::vector<std::string>();
+
128 
+
129  return SplitString(str, delimiter);
+
130 }
+
131 
+
132 std::vector<std::string> StringTools::SplitString(const std::string& str, const std::string& delimiter)
+
133 {
+
134  if (str.length() == 0) return std::vector<std::string>();
135 
-
136  if (delimiter.length() == 0) // If the delimiter is "" (empty), just split between every single char. Not useful, but logical
-
137  {
-
138  for (std::size_t i = 0; i < str.length(); i++)
-
139  {
-
140  parts.push_back(std::string({ str[i] }));
-
141  }
-
142  return parts;
-
143  }
-
144 
-
145  std::size_t posFound = 0;
-
146  std::size_t lastFound = 0;
-
147 
-
148  while (posFound != std::string::npos)
-
149  {
-
150  lastFound = posFound;
-
151  posFound = str.find(delimiter, posFound);
-
152 
-
153  std::string found;
+
136  std::vector<std::string> parts;
+
137 
+
138  if (delimiter.length() == 0) // If the delimiter is "" (empty), just split between every single char. Not useful, but logical
+
139  {
+
140  for (std::size_t i = 0; i < str.length(); i++)
+
141  {
+
142  parts.push_back(std::string({ str[i] }));
+
143  }
+
144  return parts;
+
145  }
+
146 
+
147  std::size_t posFound = 0;
+
148  std::size_t lastFound = 0;
+
149 
+
150  while (posFound != std::string::npos)
+
151  {
+
152  lastFound = posFound;
+
153  posFound = str.find(delimiter, posFound);
154 
-
155  if (posFound != std::string::npos)
-
156  {
-
157  found = str.substr(lastFound, posFound - lastFound);
-
158  posFound += delimiter.length();
-
159  }
-
160  else
-
161  {
-
162  found = str.substr(lastFound, str.length() - lastFound);
-
163  }
-
164 
-
165  parts.push_back(found);
-
166  }
-
167 
-
168  return parts;
-
169 }
-
170 
-
171 std::string StringTools::ToLower(const std::string& str)
-
172 {
-
173  std::stringstream ss;
-
174  for (std::size_t i = 0; i < str.length(); i++)
-
175  {
-
176  if ((str[i] >= 'A') && (str[i] <= 'Z')) ss << (char)(((int)str[i]) + 32);
-
177  else if (str[i] == -60) ss << (char)-28; // AE => ae
-
178  else if (str[i] == -42) ss << (char)-10; // OE => oe
-
179  else if (str[i] == -36) ss << (char)-4; // UE => ue
-
180  else ss << str[i];
-
181  }
-
182 
-
183  return ss.str();
-
184 }
+
155  std::string found;
+
156 
+
157  if (posFound != std::string::npos)
+
158  {
+
159  found = str.substr(lastFound, posFound - lastFound);
+
160  posFound += delimiter.length();
+
161  }
+
162  else
+
163  {
+
164  found = str.substr(lastFound, str.length() - lastFound);
+
165  }
+
166 
+
167  parts.push_back(found);
+
168  }
+
169 
+
170  return parts;
+
171 }
+
172 
+
173 std::string StringTools::ToLower(const std::string& str)
+
174 {
+
175  std::stringstream ss;
+
176  for (std::size_t i = 0; i < str.length(); i++)
+
177  {
+
178  if ((str[i] >= 'A') && (str[i] <= 'Z')) ss << (char)(((int)str[i]) + 32);
+
179  else if (str[i] == -60) ss << (char)-28; // AE => ae
+
180  else if (str[i] == -42) ss << (char)-10; // OE => oe
+
181  else if (str[i] == -36) ss << (char)-4; // UE => ue
+
182  else ss << str[i];
+
183  }
+
184 
+
185  return ss.str();
+
186 }
-
StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:54
-
StringTools::ToLower
static std::string ToLower(const std::string &str)
Will make a string all lower-case.
Definition: StringTools.cpp:171
-
StringTools::Contains
static bool Contains(const std::string &str, const char c)
Will return wether or not a given char is in a string.
Definition: StringTools.cpp:3
-
StringTools::ParseNumber
static bool ParseNumber(const std::string &str, bool &out_isInt, long double &out_number)
Will convert the number in str to a number.
Definition: StringTools.cpp:80
-
StringTools::Replace
static std::string Replace(const std::string &str, const char find, const std::string &subst)
Will replace a part of a string with another string.
Definition: StringTools.cpp:12
-
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:123
+
Hazelnp::StringTools::Replace
static std::string Replace(const std::string &str, const char find, const std::string &subst)
Will replace a part of a string with another string.
Definition: StringTools.cpp:14
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:56
+
Hazelnp::StringTools::ParseNumber
static bool ParseNumber(const std::string &str, bool &out_isInt, long double &out_number)
Will convert the number in str to a number.
Definition: StringTools.cpp:82
+
Hazelnp::StringTools::Contains
static bool Contains(const std::string &str, const char c)
Will return wether or not a given char is in a string.
Definition: StringTools.cpp:5
+
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
StringTools.h
+
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 b529eba..8e3f93e 100644 --- a/docs/StringTools_8h.html +++ b/docs/StringTools_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
StringTools.h File Reference
@@ -111,14 +112,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  StringTools
 Internal helper class. More...
class  Hazelnp::StringTools
 Internal helper class. More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/StringTools_8h_source.html b/docs/StringTools_8h_source.html index 3f3d1a9..88cb13f 100644 --- a/docs/StringTools_8h_source.html +++ b/docs/StringTools_8h_source.html @@ -84,36 +84,40 @@ $(function() {
4 #include <vector>
5 #include <cmath>
6 
-
9 class StringTools
-
10 {
-
11 public:
-
13  static bool Contains(const std::string& str, const char c);
-
14 
-
16  static std::string Replace(const std::string& str, const char find, const std::string& subst);
-
17 
-
19  static std::string Replace(const std::string& str, const std::string& find, const std::string& subst);
-
20 
-
22  static bool IsNumeric(const std::string& str, const bool allowDecimalPoint = false);
-
23 
-
27  static bool ParseNumber(const std::string& str, bool& out_isInt, long double& out_number);
-
28 
-
30  static std::vector<std::string> SplitString(const std::string& str, const char delimiter);
-
31 
-
33  static std::vector<std::string> SplitString(const std::string& str, const std::string& delimiter);
-
34 
-
36  static std::string ToLower(const std::string& str);
-
37 };
+
7 namespace Hazelnp
+
8 {
+
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);
+
39  };
+
40 }
-
StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:54
-
StringTools::ToLower
static std::string ToLower(const std::string &str)
Will make a string all lower-case.
Definition: StringTools.cpp:171
-
StringTools::Contains
static bool Contains(const std::string &str, const char c)
Will return wether or not a given char is in a string.
Definition: StringTools.cpp:3
-
StringTools
Internal helper class.
Definition: StringTools.h:9
-
StringTools::ParseNumber
static bool ParseNumber(const std::string &str, bool &out_isInt, long double &out_number)
Will convert the number in str to a number.
Definition: StringTools.cpp:80
-
StringTools::Replace
static std::string Replace(const std::string &str, const char find, const std::string &subst)
Will replace a part of a string with another string.
Definition: StringTools.cpp:12
-
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:123
+
Hazelnp::StringTools::Replace
static std::string Replace(const std::string &str, const char find, const std::string &subst)
Will replace a part of a string with another string.
Definition: StringTools.cpp:14
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::StringTools::IsNumeric
static bool IsNumeric(const std::string &str, const bool allowDecimalPoint=false)
Will return true if the given string consists only of digits (including signage)
Definition: StringTools.cpp:56
+
Hazelnp::StringTools::ParseNumber
static bool ParseNumber(const std::string &str, bool &out_isInt, long double &out_number)
Will convert the number in str to a number.
Definition: StringTools.cpp:82
+
Hazelnp::StringTools::Contains
static bool Contains(const std::string &str, const char c)
Will return wether or not a given char is in a string.
Definition: StringTools.cpp:5
+
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
+
Hazelnp::StringTools
Internal helper class.
Definition: StringTools.h:11
+
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 2c9f29c..a3d7460 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 1d1c6fa..d0bc537 100644 --- a/docs/StringValue_8cpp_source.html +++ b/docs/StringValue_8cpp_source.html @@ -82,87 +82,90 @@ $(function() {
2 #include "HazelnuppException.h"
3 #include <sstream>
4 
-
5 StringValue::StringValue(const std::string& value)
-
6  :
-
7  Value(DATA_TYPE::STRING),
-
8  value { value }
-
9 {
-
10  return;
-
11 }
-
12 
-
13 Value* StringValue::Deepcopy() const
-
14 {
-
15  return new StringValue(value);
-
16 }
-
17 
-
18 std::string StringValue::GetAsOsString() const
-
19 {
-
20  std::stringstream ss;
-
21  ss << "StringValue: " << value;
-
22  return ss.str();
-
23 }
-
24 
-
25 const std::string& StringValue::GetValue() const
-
26 {
-
27  return value;
-
28 }
-
29 
-
30 StringValue::operator std::string() const
-
31 {
-
32  return value;
-
33 }
-
34 
-
35 
+
5 using namespace Hazelnp;
+
6 
+
7 StringValue::StringValue(const std::string& value)
+
8  :
+
9  Value(DATA_TYPE::STRING),
+
10  value { value }
+
11 {
+
12  return;
+
13 }
+
14 
+
15 Value* StringValue::Deepcopy() const
+
16 {
+
17  return new StringValue(value);
+
18 }
+
19 
+
20 std::string StringValue::GetAsOsString() const
+
21 {
+
22  std::stringstream ss;
+
23  ss << "StringValue: " << value;
+
24  return ss.str();
+
25 }
+
26 
+
27 const std::string& StringValue::GetValue() const
+
28 {
+
29  return value;
+
30 }
+
31 
+
32 StringValue::operator std::string() const
+
33 {
+
34  return value;
+
35 }
36 
-
37 long long int StringValue::GetInt64() const
-
38 {
-
39  throw HazelnuppValueNotConvertibleException();
-
40 }
-
41 
-
42 int StringValue::GetInt32() const
-
43 {
-
44  throw HazelnuppValueNotConvertibleException();
-
45 }
-
46 
-
47 long double StringValue::GetFloat64() const
-
48 {
-
49  throw HazelnuppValueNotConvertibleException();
-
50 }
-
51 
-
52 double StringValue::GetFloat32() const
-
53 {
-
54  throw HazelnuppValueNotConvertibleException();
-
55 }
-
56 
-
57 std::string StringValue::GetString() const
-
58 {
-
59  return value;
-
60 }
-
61 
-
62 const std::vector<Value*>& StringValue::GetList() const
-
63 {
-
64  throw HazelnuppValueNotConvertibleException();
-
65 }
+
37 
+
38 
+
39 long long int StringValue::GetInt64() const
+
40 {
+
41  throw HazelnuppValueNotConvertibleException();
+
42 }
+
43 
+
44 int StringValue::GetInt32() const
+
45 {
+
46  throw HazelnuppValueNotConvertibleException();
+
47 }
+
48 
+
49 long double StringValue::GetFloat64() const
+
50 {
+
51  throw HazelnuppValueNotConvertibleException();
+
52 }
+
53 
+
54 double StringValue::GetFloat32() const
+
55 {
+
56  throw HazelnuppValueNotConvertibleException();
+
57 }
+
58 
+
59 std::string StringValue::GetString() const
+
60 {
+
61  return value;
+
62 }
+
63 
+
64 const std::vector<Value*>& StringValue::GetList() const
+
65 {
+
66  throw HazelnuppValueNotConvertibleException();
+
67 }
HazelnuppException.h
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::StringValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:44
+
Hazelnp::StringValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: StringValue.cpp:20
+
Hazelnp::StringValue::StringValue
StringValue(const std::string &value)
Definition: StringValue.cpp:7
StringValue.h
-
StringValue::GetString
std::string GetString() const override
Will return this value as a string.
Definition: StringValue.cpp:57
-
Value
Abstract class for values.
Definition: Value.h:8
-
StringValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:42
-
StringValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:52
-
HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:33
-
StringValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: StringValue.cpp:13
-
StringValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: StringValue.cpp:18
-
StringValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:62
-
StringValue::StringValue
StringValue(const std::string &value)
Definition: StringValue.cpp:5
-
DATA_TYPE::STRING
@ STRING
-
StringValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:37
-
StringValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:47
-
StringValue::GetValue
const std::string & GetValue() const
Will return the raw value.
Definition: StringValue.cpp:25
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::StringValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:39
+
Hazelnp::StringValue::GetString
std::string GetString() const override
Will return this value as a string.
Definition: StringValue.cpp:59
+
Hazelnp::StringValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:54
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
Hazelnp::StringValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: StringValue.cpp:15
+
Hazelnp::DATA_TYPE::STRING
@ STRING
+
Hazelnp::StringValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:49
+
Hazelnp::StringValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:64
+
Hazelnp::StringValue::GetValue
const std::string & GetValue() const
Will return the raw value.
Definition: StringValue.cpp:27
+
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 b6fc1c0..b77aa89 100644 --- a/docs/StringValue_8h.html +++ b/docs/StringValue_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
StringValue.h File Reference
@@ -110,14 +111,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  StringValue
 Specializations for string values (uses std::string) More...
class  Hazelnp::StringValue
 Specializations for string values (uses std::string) More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/StringValue_8h_source.html b/docs/StringValue_8h_source.html index e155105..16daf68 100644 --- a/docs/StringValue_8h_source.html +++ b/docs/StringValue_8h_source.html @@ -82,51 +82,55 @@ $(function() {
2 #include "Value.h"
3 #include <string>
4 
-
7 class StringValue : public Value
-
8 {
-
9 public:
-
10  StringValue(const std::string& value);
-
11  ~StringValue() override {};
-
12 
-
14  Value* Deepcopy() const override;
-
15 
-
17  std::string GetAsOsString() const override;
-
18 
-
20  const std::string& GetValue() const;
-
21 
-
22  operator std::string() const;
+
5 namespace Hazelnp
+
6 {
+
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;
23 
-
25  long long int GetInt64() const override;
-
27  int GetInt32() const override;
-
28 
-
30  long double GetFloat64() const override;
-
32  double GetFloat32() const override;
-
33 
-
35  std::string GetString() const override;
-
36 
-
38  const std::vector<Value*>& GetList() const override;
-
39 
-
40 private:
-
41  std::string value;
-
42 };
+
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;
+
41 
+
42  private:
+
43  std::string value;
+
44  };
+
45 }
-
StringValue::GetString
std::string GetString() const override
Will return this value as a string.
Definition: StringValue.cpp:57
-
Value
Abstract class for values.
Definition: Value.h:8
-
StringValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:42
-
StringValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:52
-
StringValue
Specializations for string values (uses std::string)
Definition: StringValue.h:7
-
StringValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: StringValue.cpp:13
-
StringValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: StringValue.cpp:18
-
StringValue::~StringValue
~StringValue() override
Definition: StringValue.h:11
-
StringValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:62
-
StringValue::StringValue
StringValue(const std::string &value)
Definition: StringValue.cpp:5
-
StringValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:37
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::StringValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:44
+
Hazelnp::StringValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: StringValue.cpp:20
+
Hazelnp::StringValue::StringValue
StringValue(const std::string &value)
Definition: StringValue.cpp:7
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::StringValue::~StringValue
~StringValue() override
Definition: StringValue.h:13
+
Hazelnp::StringValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:39
+
Hazelnp::StringValue::GetString
std::string GetString() const override
Will return this value as a string.
Definition: StringValue.cpp:59
+
Hazelnp::StringValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:54
+
Hazelnp::StringValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: StringValue.cpp:15
+
Hazelnp::StringValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:49
+
Hazelnp::StringValue::GetList
const std::vector< Value * > & GetList() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:64
+
Hazelnp::StringValue
Specializations for string values (uses std::string)
Definition: StringValue.h:9
+
Hazelnp::StringValue::GetValue
const std::string & GetValue() const
Will return the raw value.
Definition: StringValue.cpp:27
Value.h
-
StringValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: StringValue.cpp:47
-
StringValue::GetValue
const std::string & GetValue() const
Will return the raw value.
Definition: StringValue.cpp:25
diff --git a/docs/Value_8cpp.html b/docs/Value_8cpp.html index 2a5a45f..b3f178a 100644 --- a/docs/Value_8cpp.html +++ b/docs/Value_8cpp.html @@ -96,7 +96,7 @@ Include dependency graph for Value.cpp: diff --git a/docs/Value_8cpp_source.html b/docs/Value_8cpp_source.html index 0bc6ec6..49294f2 100644 --- a/docs/Value_8cpp_source.html +++ b/docs/Value_8cpp_source.html @@ -80,26 +80,29 @@ $(function() {
Go to the documentation of this file.
1 #include "Value.h"
2 
- -
4  :
-
5  type{ type }
-
6 {
-
7  return;
-
8 }
-
9 
- -
11 {
-
12  return type;
-
13 }
+
3 using namespace Hazelnp;
+
4 
+ +
6  :
+
7  type{ type }
+
8 {
+
9  return;
+
10 }
+
11 
+ +
13 {
+
14  return type;
+
15 }
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
Value::type
DATA_TYPE type
Definition: Value.h:46
-
Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:3
-
Value::GetDataType
DATA_TYPE GetDataType() const
Will return the data type of this value.
Definition: Value.cpp:10
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:5
+
Hazelnp::Value::GetDataType
DATA_TYPE GetDataType() const
Will return the data type of this value.
Definition: Value.cpp:12
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
Hazelnp::Value::type
DATA_TYPE type
Definition: Value.h:48
Value.h
diff --git a/docs/Value_8h.html b/docs/Value_8h.html index a065cd5..077946f 100644 --- a/docs/Value_8h.html +++ b/docs/Value_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
Value.h File Reference
@@ -123,14 +124,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  Value
 Abstract class for values. More...
class  Hazelnp::Value
 Abstract class for values. More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/Value_8h_source.html b/docs/Value_8h_source.html index 6e8a897..02e7c2b 100644 --- a/docs/Value_8h_source.html +++ b/docs/Value_8h_source.html @@ -83,57 +83,61 @@ $(function() {
3 #include <ostream>
4 #include <vector>
5 
-
8 class Value
-
9 {
-
10 public:
-
11  virtual ~Value() {};
-
12 
-
14  virtual Value* Deepcopy() const = 0;
-
15 
-
17  virtual std::string GetAsOsString() const = 0;
-
18 
-
20  DATA_TYPE GetDataType() const;
-
21 
-
22  friend std::ostream& operator<< (std::ostream& os, const Value& v)
-
23  {
-
24  return os << v.GetAsOsString();
-
25  }
-
26 
-
28  virtual long long int GetInt64() const = 0;
-
30  virtual int GetInt32() const = 0;
-
31 
-
33  virtual long double GetFloat64() const = 0;
-
35  virtual double GetFloat32() const = 0;
-
36 
-
38  virtual std::string GetString() const = 0;
-
39 
-
41  virtual const std::vector<Value*>& GetList() const = 0;
-
42 
-
43 protected:
-
44  Value(DATA_TYPE type);
-
45 
-
46  DATA_TYPE type;
-
47 };
+
6 namespace Hazelnp
+
7 {
+
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;
+
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;
+
44 
+
45  protected:
+
46  Value(DATA_TYPE type);
+
47 
+
48  DATA_TYPE type;
+
49  };
+
50 }
+
Hazelnp
Definition: DataType.h:3
DataType.h
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
Value::type
DATA_TYPE type
Definition: Value.h:46
-
Value::GetList
virtual const std::vector< Value * > & GetList() const =0
Will attempt to return the list-data.
-
Value
Abstract class for values.
Definition: Value.h:8
-
Value::Deepcopy
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
-
Value::GetAsOsString
virtual std::string GetAsOsString() const =0
Will return a string suitable for an std::ostream.
-
Value::GetInt32
virtual int GetInt32() const =0
Will attempt to return the integer data (int)
-
Value::GetString
virtual std::string GetString() const =0
Will attempt to return the string-data.
-
Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:3
-
Value::operator<<
friend std::ostream & operator<<(std::ostream &os, const Value &v)
Definition: Value.h:22
-
Value::GetFloat64
virtual long double GetFloat64() const =0
Will attempt to return the floating-point data (long double)
-
Value::~Value
virtual ~Value()
Definition: Value.h:11
-
Value::GetInt64
virtual long long int GetInt64() const =0
Will attempt to return the integer data (long long)
-
Value::GetFloat32
virtual double GetFloat32() const =0
Will attempt to return the floating-point data (double)
-
Value::GetDataType
DATA_TYPE GetDataType() const
Will return the data type of this value.
Definition: Value.cpp:10
+
Hazelnp::Value::GetFloat32
virtual double GetFloat32() const =0
Will attempt to return the floating-point data (double)
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::Value::GetInt32
virtual int GetInt32() const =0
Will attempt to return the integer data (int)
+
Hazelnp::Value::GetString
virtual std::string GetString() const =0
Will attempt to return the string-data.
+
Hazelnp::Value::~Value
virtual ~Value()
Definition: Value.h:13
+
Hazelnp::Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:5
+
Hazelnp::Value::GetDataType
DATA_TYPE GetDataType() const
Will return the data type of this value.
Definition: Value.cpp:12
+
Hazelnp::Value::GetInt64
virtual long long int GetInt64() const =0
Will attempt to return the integer data (long long)
+
Hazelnp::Value::GetAsOsString
virtual std::string GetAsOsString() const =0
Will return a string suitable for an std::ostream.
+
Hazelnp::Value::GetList
virtual const std::vector< Value * > & GetList() const =0
Will attempt to return the list-data.
+
Hazelnp::Value::operator<<
friend std::ostream & operator<<(std::ostream &os, const Value &v)
Definition: Value.h:24
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
Hazelnp::Value::type
DATA_TYPE type
Definition: Value.h:48
+
Hazelnp::Value::Deepcopy
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
+
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 c441690..100ab35 100644 --- a/docs/VoidValue_8cpp.html +++ b/docs/VoidValue_8cpp.html @@ -100,7 +100,7 @@ Include dependency graph for VoidValue.cpp: diff --git a/docs/VoidValue_8cpp_source.html b/docs/VoidValue_8cpp_source.html index 16e992f..0d7f6c5 100644 --- a/docs/VoidValue_8cpp_source.html +++ b/docs/VoidValue_8cpp_source.html @@ -81,73 +81,76 @@ $(function() { Go to the documentation of this file.
1 #include "VoidValue.h"
2 #include "HazelnuppException.h"
3 
-
4 VoidValue::VoidValue()
-
5  :
-
6  Value(DATA_TYPE::VOID)
-
7 {
-
8  return;
-
9 }
-
10 
-
11 Value* VoidValue::Deepcopy() const
-
12 {
-
13  return new VoidValue();
-
14 }
-
15 
-
16 std::string VoidValue::GetAsOsString() const
-
17 {
-
18  return "VoidValue";
-
19 }
-
20 
-
21 
+
4 using namespace Hazelnp;
+
5 
+
6 VoidValue::VoidValue()
+
7  :
+
8  Value(DATA_TYPE::VOID)
+
9 {
+
10  return;
+
11 }
+
12 
+
13 Value* VoidValue::Deepcopy() const
+
14 {
+
15  return new VoidValue();
+
16 }
+
17 
+
18 std::string VoidValue::GetAsOsString() const
+
19 {
+
20  return "VoidValue";
+
21 }
22 
-
23 long long int VoidValue::GetInt64() const
-
24 {
-
25  throw HazelnuppValueNotConvertibleException();
-
26 }
-
27 
-
28 int VoidValue::GetInt32() const
-
29 {
-
30  throw HazelnuppValueNotConvertibleException();
-
31 }
-
32 
-
33 long double VoidValue::GetFloat64() const
-
34 {
-
35  throw HazelnuppValueNotConvertibleException();
-
36 }
-
37 
-
38 double VoidValue::GetFloat32() const
-
39 {
-
40  throw HazelnuppValueNotConvertibleException();
-
41 }
-
42 
-
43 std::string VoidValue::GetString() const
-
44 {
-
45  throw HazelnuppValueNotConvertibleException();
-
46 }
-
47 
-
48 const std::vector<Value*>& VoidValue::GetList() const
-
49 {
-
50  throw HazelnuppValueNotConvertibleException();
-
51 }
+
23 
+
24 
+
25 long long int VoidValue::GetInt64() const
+
26 {
+
27  throw HazelnuppValueNotConvertibleException();
+
28 }
+
29 
+
30 int VoidValue::GetInt32() const
+
31 {
+
32  throw HazelnuppValueNotConvertibleException();
+
33 }
+
34 
+
35 long double VoidValue::GetFloat64() const
+
36 {
+
37  throw HazelnuppValueNotConvertibleException();
+
38 }
+
39 
+
40 double VoidValue::GetFloat32() const
+
41 {
+
42  throw HazelnuppValueNotConvertibleException();
+
43 }
+
44 
+
45 std::string VoidValue::GetString() const
+
46 {
+
47  throw HazelnuppValueNotConvertibleException();
+
48 }
+
49 
+
50 const std::vector<Value*>& VoidValue::GetList() const
+
51 {
+
52  throw HazelnuppValueNotConvertibleException();
+
53 }
HazelnuppException.h
-
DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:5
-
VoidValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:43
-
DATA_TYPE::VOID
@ VOID
-
Value
Abstract class for values.
Definition: Value.h:8
-
VoidValue::VoidValue
VoidValue()
Definition: VoidValue.cpp:4
-
VoidValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:38
-
VoidValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: VoidValue.cpp:11
-
HazelnuppValueNotConvertibleException
Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not ...
Definition: HazelnuppException.h:33
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::VoidValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:25
+
Hazelnp::VoidValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:35
+
Hazelnp::DATA_TYPE::VOID
@ VOID
+
Hazelnp::VoidValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: VoidValue.cpp:18
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::VoidValue::GetList
const std::vector< Value * > & GetList() const
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:50
+
Hazelnp::VoidValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:30
VoidValue.h
-
VoidValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: VoidValue.cpp:16
-
VoidValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:23
-
VoidValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:33
-
VoidValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:28
-
VoidValue::GetList
const std::vector< Value * > & GetList() const
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:48
+
Hazelnp::VoidValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: VoidValue.cpp:13
+
Hazelnp::VoidValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:45
+
Hazelnp::DATA_TYPE
DATA_TYPE
The different data types a paramater can be.
Definition: DataType.h:7
+
Hazelnp::VoidValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:40
+
Hazelnp::VoidValue::VoidValue
VoidValue()
Definition: VoidValue.cpp:6
+
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 25b366c..68238e6 100644 --- a/docs/VoidValue_8h.html +++ b/docs/VoidValue_8h.html @@ -75,7 +75,8 @@ $(function() {
-Classes
+Classes | +Namespaces
VoidValue.h File Reference
@@ -108,14 +109,19 @@ This graph shows which files directly or indirectly include this file: - - + + + +

Classes

class  VoidValue
 Specializations for void values. More...
class  Hazelnp::VoidValue
 Specializations for void values. More...
 
+ +

+Namespaces

 Hazelnp
 
diff --git a/docs/VoidValue_8h_source.html b/docs/VoidValue_8h_source.html index fe39a6a..4731200 100644 --- a/docs/VoidValue_8h_source.html +++ b/docs/VoidValue_8h_source.html @@ -81,43 +81,47 @@ $(function() { Go to the documentation of this file.
1 #pragma once
2 #include "Value.h"
3 
-
6 class VoidValue : public Value
-
7 {
-
8 public:
-
9  VoidValue();
-
10  ~VoidValue() override {};
-
11 
-
13  Value* Deepcopy() const override;
-
14 
-
16  std::string GetAsOsString() const override;
-
17 
-
19  long long int GetInt64() const override;
-
21  int GetInt32() const override;
-
22 
-
24  long double GetFloat64() const override;
-
26  double GetFloat32() const override;
-
27 
-
29  std::string GetString() const override;
-
30 
-
32  const std::vector<Value*>& GetList() const;
-
33 };
+
4 namespace Hazelnp
+
5 {
+
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;
+
35  };
+
36 }
-
VoidValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:43
-
Value
Abstract class for values.
Definition: Value.h:8
-
VoidValue::VoidValue
VoidValue()
Definition: VoidValue.cpp:4
-
VoidValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:38
-
VoidValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: VoidValue.cpp:11
-
VoidValue
Specializations for void values.
Definition: VoidValue.h:6
-
VoidValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: VoidValue.cpp:16
-
VoidValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:23
-
VoidValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:33
-
VoidValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:28
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::VoidValue::GetInt64
long long int GetInt64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:25
+
Hazelnp::VoidValue::~VoidValue
~VoidValue() override
Definition: VoidValue.h:12
+
Hazelnp::VoidValue::GetFloat64
long double GetFloat64() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:35
+
Hazelnp::VoidValue::GetAsOsString
std::string GetAsOsString() const override
Will return a string suitable for an std::ostream;.
Definition: VoidValue.cpp:18
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::VoidValue::GetList
const std::vector< Value * > & GetList() const
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:50
+
Hazelnp::VoidValue::GetInt32
int GetInt32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:30
+
Hazelnp::VoidValue::Deepcopy
Value * Deepcopy() const override
Will return a deeopopy of this object.
Definition: VoidValue.cpp:13
+
Hazelnp::VoidValue
Specializations for void values.
Definition: VoidValue.h:8
+
Hazelnp::VoidValue::GetString
std::string GetString() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:45
+
Hazelnp::VoidValue::GetFloat32
double GetFloat32() const override
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:40
+
Hazelnp::VoidValue::VoidValue
VoidValue()
Definition: VoidValue.cpp:6
Value.h
-
VoidValue::~VoidValue
~VoidValue() override
Definition: VoidValue.h:10
-
VoidValue::GetList
const std::vector< Value * > & GetList() const
Throws HazelnuppValueNotConvertibleException.
Definition: VoidValue.cpp:48
diff --git a/docs/annotated.html b/docs/annotated.html index 77a95b8..bb4c61b 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -75,29 +75,30 @@ $(function() {
Here are the classes, structs, unions and interfaces with brief descriptions:
- - - - - - - - - - - - - - - - - +
[detail level 12]
 CFloatValueSpecializations for floating point values (uses long double)
 CHazelnuppThe main class to interface with
 CHazelnuppConstraintExceptionGets thrown something bad happens because of parameter constraints
 CHazelnuppConstraintMissingValueGets thrown when a parameter constrained to be required is not provided, and has no default value set
 CHazelnuppConstraintTypeMissmatchGets thrown when a parameter is of a type that does not match the required type, and is not convertible to it
 CHazelnuppExceptionGeneric hazelnupp exception
 CHazelnuppInvalidKeyExceptionGets thrown when an non-existent key gets dereferenced
 CHazelnuppValueNotConvertibleExceptionGets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible
 CIntValueSpecializations for integer values (uses long long int)
 CListValueSpecializations for list values (uses std::vector<Value*>)
 CParamConstraint
 CParameter
 CStringToolsInternal helper class
 CStringValueSpecializations for string values (uses std::string)
 CValueAbstract class for values
 CVoidValueSpecializations for void values
+ + + + + + + + + + + + + + + + +
 NHazelnp
 CFloatValueSpecializations for floating point values (uses long double)
 CHazelnuppThe main class to interface with
 CHazelnuppConstraintExceptionGets thrown something bad happens because of parameter constraints
 CHazelnuppConstraintMissingValueGets thrown when a parameter constrained to be required is not provided, and has no default value set
 CHazelnuppConstraintTypeMissmatchGets thrown when a parameter is of a type that does not match the required type, and is not convertible to it
 CHazelnuppExceptionGeneric hazelnupp exception
 CHazelnuppInvalidKeyExceptionGets thrown when an non-existent key gets dereferenced
 CHazelnuppValueNotConvertibleExceptionGets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible
 CIntValueSpecializations for integer values (uses long long int)
 CListValueSpecializations for list values (uses std::vector<Value*>)
 CParamConstraint
 CParameter
 CStringToolsInternal helper class
 CStringValueSpecializations for string values (uses std::string)
 CValueAbstract class for values
 CVoidValueSpecializations for void values
diff --git a/docs/classHazelnp_1_1FloatValue-members.html b/docs/classHazelnp_1_1FloatValue-members.html new file mode 100644 index 0000000..6362f18 --- /dev/null +++ b/docs/classHazelnp_1_1FloatValue-members.html @@ -0,0 +1,109 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::FloatValue Member List
+
+
+ +

This is the complete list of members for Hazelnp::FloatValue, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
Deepcopy() const overrideHazelnp::FloatValuevirtual
FloatValue(const long double &value)Hazelnp::FloatValue
GetAsOsString() const overrideHazelnp::FloatValuevirtual
GetDataType() constHazelnp::Value
GetFloat32() const overrideHazelnp::FloatValuevirtual
GetFloat64() const overrideHazelnp::FloatValuevirtual
GetInt32() const overrideHazelnp::FloatValuevirtual
GetInt64() const overrideHazelnp::FloatValuevirtual
GetList() const overrideHazelnp::FloatValuevirtual
GetString() const overrideHazelnp::FloatValuevirtual
GetValue() constHazelnp::FloatValue
operator double() constHazelnp::FloatValue
operator long double() constHazelnp::FloatValue
typeHazelnp::Valueprotected
Value(DATA_TYPE type)Hazelnp::Valueprotected
~FloatValue() overrideHazelnp::FloatValueinline
~Value()Hazelnp::Valueinlinevirtual
+ + + + diff --git a/docs/classHazelnp_1_1FloatValue.html b/docs/classHazelnp_1_1FloatValue.html new file mode 100644 index 0000000..aff0831 --- /dev/null +++ b/docs/classHazelnp_1_1FloatValue.html @@ -0,0 +1,582 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::FloatValue Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::FloatValue Class Reference
+
+
+ +

Specializations for floating point values (uses long double) + More...

+ +

#include <FloatValue.h>

+
+Inheritance diagram for Hazelnp::FloatValue:
+
+
Inheritance graph
+ + + + +
[legend]
+
+Collaboration diagram for Hazelnp::FloatValue:
+
+
Collaboration graph
+ + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 FloatValue (const long double &value)
 
 ~FloatValue () override
 
ValueDeepcopy () const override
 Will return a deeopopy of this object. More...
 
std::string GetAsOsString () const override
 Will return a string suitable for an std::ostream;. More...
 
const long double & GetValue () const
 Will return the raw value. More...
 
 operator long double () const
 
 operator double () const
 
long long int GetInt64 () const override
 Will return the data as a long long int. More...
 
int GetInt32 () const override
 Will return the data as an int. More...
 
long double GetFloat64 () const override
 Will return the data as a long double. More...
 
double GetFloat32 () const override
 Will return the data as a double. More...
 
std::string GetString () const override
 Will return the data as a string. More...
 
const std::vector< Value * > & GetList () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
- Public Member Functions inherited from Hazelnp::Value
virtual ~Value ()
 
DATA_TYPE GetDataType () const
 Will return the data type of this value. More...
 
+ + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from Hazelnp::Value
 Value (DATA_TYPE type)
 
- Protected Attributes inherited from Hazelnp::Value
DATA_TYPE type
 
+

Detailed Description

+

Specializations for floating point values (uses long double)

+ +

Definition at line 9 of file FloatValue.h.

+

Constructor & Destructor Documentation

+ +

◆ FloatValue()

+ +
+
+ + + + + + + + +
FloatValue::FloatValue (const long double & value)
+
+ +

Definition at line 7 of file FloatValue.cpp.

+
8  :
+ +
10  value { value }
+
11 {
+
12  return;
+
13 }
+
+
+
+ +

◆ ~FloatValue()

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::FloatValue::~FloatValue ()
+
+inlineoverride
+
+ +

Definition at line 13 of file FloatValue.h.

+
13 {};
+
+
+
+

Member Function Documentation

+ +

◆ Deepcopy()

+ +
+
+ + + + + +
+ + + + + + + +
Value * FloatValue::Deepcopy () const
+
+overridevirtual
+
+ +

Will return a deeopopy of this object.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 15 of file FloatValue.cpp.

+
16 {
+
17  return new FloatValue(value);
+
18 }
+
+
+
+ +

◆ GetAsOsString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string FloatValue::GetAsOsString () const
+
+overridevirtual
+
+ +

Will return a string suitable for an std::ostream;.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 20 of file FloatValue.cpp.

+
21 {
+
22  std::stringstream ss;
+
23  ss << "FloatValue: " << value;
+
24  return ss.str();
+
25 }
+
+
+
+ +

◆ GetFloat32()

+ +
+
+ + + + + +
+ + + + + + + +
double FloatValue::GetFloat32 () const
+
+overridevirtual
+
+ +

Will return the data as a double.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 59 of file FloatValue.cpp.

+
60 {
+
61  return (double)value;
+
62 }
+
+
+
+ +

◆ GetFloat64()

+ +
+
+ + + + + +
+ + + + + + + +
long double FloatValue::GetFloat64 () const
+
+overridevirtual
+
+ +

Will return the data as a long double.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 54 of file FloatValue.cpp.

+
55 {
+
56  return value;
+
57 }
+
+
+
+ +

◆ GetInt32()

+ +
+
+ + + + + +
+ + + + + + + +
int FloatValue::GetInt32 () const
+
+overridevirtual
+
+ +

Will return the data as an int.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 49 of file FloatValue.cpp.

+
50 {
+
51  return (int)value;
+
52 }
+
+
+
+ +

◆ GetInt64()

+ +
+
+ + + + + +
+ + + + + + + +
long long int FloatValue::GetInt64 () const
+
+overridevirtual
+
+ +

Will return the data as a long long int.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 44 of file FloatValue.cpp.

+
45 {
+
46  return (long long int)value;
+
47 }
+
+
+
+ +

◆ GetList()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Value * > & FloatValue::GetList () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 72 of file FloatValue.cpp.

+
73 {
+ +
75 }
+
+
+
+ +

◆ GetString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string FloatValue::GetString () const
+
+overridevirtual
+
+ +

Will return the data as a string.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 64 of file FloatValue.cpp.

+
65 {
+
66  std::stringstream ss;
+
67  ss << value;
+
68 
+
69  return ss.str();
+
70 }
+
+
+
+ +

◆ GetValue()

+ +
+
+ + + + + + + +
const long double & FloatValue::GetValue () const
+
+ +

Will return the raw value.

+ +

Definition at line 27 of file FloatValue.cpp.

+
28 {
+
29  return value;
+
30 }
+
+
+
+ +

◆ operator double()

+ +
+
+ + + + + + + +
FloatValue::operator double () const
+
+ +

Definition at line 37 of file FloatValue.cpp.

+
38 {
+
39  return (double)value;
+
40 }
+
+
+
+ +

◆ operator long double()

+ +
+
+ + + + + + + +
FloatValue::operator long double () const
+
+ +

Definition at line 32 of file FloatValue.cpp.

+
33 {
+
34  return value;
+
35 }
+
+
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:5
+
Hazelnp::DATA_TYPE::FLOAT
@ FLOAT
+
Hazelnp::FloatValue::FloatValue
FloatValue(const long double &value)
Definition: FloatValue.cpp:7
+
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_1FloatValue__coll__graph.map b/docs/classHazelnp_1_1FloatValue__coll__graph.map new file mode 100644 index 0000000..e7551d3 --- /dev/null +++ b/docs/classHazelnp_1_1FloatValue__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1FloatValue__coll__graph.md5 b/docs/classHazelnp_1_1FloatValue__coll__graph.md5 new file mode 100644 index 0000000..0638943 --- /dev/null +++ b/docs/classHazelnp_1_1FloatValue__coll__graph.md5 @@ -0,0 +1 @@ +e607f145b9f1053a2906e15f99f0542b \ No newline at end of file diff --git a/docs/classHazelnp_1_1FloatValue__coll__graph.png b/docs/classHazelnp_1_1FloatValue__coll__graph.png new file mode 100644 index 0000000..7f0b564 Binary files /dev/null and b/docs/classHazelnp_1_1FloatValue__coll__graph.png differ diff --git a/docs/classHazelnp_1_1FloatValue__inherit__graph.map b/docs/classHazelnp_1_1FloatValue__inherit__graph.map new file mode 100644 index 0000000..e7551d3 --- /dev/null +++ b/docs/classHazelnp_1_1FloatValue__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1FloatValue__inherit__graph.md5 b/docs/classHazelnp_1_1FloatValue__inherit__graph.md5 new file mode 100644 index 0000000..0638943 --- /dev/null +++ b/docs/classHazelnp_1_1FloatValue__inherit__graph.md5 @@ -0,0 +1 @@ +e607f145b9f1053a2906e15f99f0542b \ No newline at end of file diff --git a/docs/classHazelnp_1_1FloatValue__inherit__graph.png b/docs/classHazelnp_1_1FloatValue__inherit__graph.png new file mode 100644 index 0000000..7f0b564 Binary files /dev/null and b/docs/classHazelnp_1_1FloatValue__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1Hazelnupp-members.html b/docs/classHazelnp_1_1Hazelnupp-members.html new file mode 100644 index 0000000..00a07cc --- /dev/null +++ b/docs/classHazelnp_1_1Hazelnupp-members.html @@ -0,0 +1,107 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::Hazelnupp Member List
+
+
+ +

This is the complete list of members for Hazelnp::Hazelnupp, including all inherited members.

+ + + + + + + + + + + + + + + + +
ClearAbbreviations()Hazelnp::Hazelnupp
ClearConstraints()Hazelnp::Hazelnupp
GetAbbreviation(const std::string &abbrev) constHazelnp::Hazelnupp
GetCrashOnFail() constHazelnp::Hazelnupp
GetExecutableName() constHazelnp::Hazelnupp
HasAbbreviation(const std::string &abbrev) constHazelnp::Hazelnupp
HasParam(const std::string &key) constHazelnp::Hazelnupp
Hazelnupp()Hazelnp::Hazelnupp
Hazelnupp(const int argc, const char *const *argv)Hazelnp::Hazelnupp
operator[](const std::string &key) constHazelnp::Hazelnupp
Parse(const int argc, const char *const *argv)Hazelnp::Hazelnupp
RegisterAbbreviation(const std::string &abbrev, const std::string &target)Hazelnp::Hazelnupp
RegisterConstraints(const std::vector< ParamConstraint > &constraints)Hazelnp::Hazelnupp
SetCrashOnFail(bool crashOnFail)Hazelnp::Hazelnupp
~Hazelnupp()Hazelnp::Hazelnupp
+ + + + diff --git a/docs/classHazelnp_1_1Hazelnupp.html b/docs/classHazelnp_1_1Hazelnupp.html new file mode 100644 index 0000000..86f560d --- /dev/null +++ b/docs/classHazelnp_1_1Hazelnupp.html @@ -0,0 +1,634 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::Hazelnupp Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::Hazelnupp Class Reference
+
+
+ +

The main class to interface with. + More...

+ +

#include <Hazelnupp.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 Hazelnupp ()
 
 Hazelnupp (const int argc, const char *const *argv)
 
 ~Hazelnupp ()
 
void Parse (const int argc, const char *const *argv)
 Will parse command line arguments. More...
 
const std::string & GetExecutableName () const
 Will return argv[0], the name of the executable. More...
 
const Valueoperator[] (const std::string &key) const
 Will return the value given a key. More...
 
bool HasParam (const std::string &key) const
 Will check wether a parameter exists given a key, or not. More...
 
void RegisterAbbreviation (const std::string &abbrev, const std::string &target)
 Will register an abbreviation (like -f for –force) More...
 
const std::string & GetAbbreviation (const std::string &abbrev) const
 Will return the long form of an abbreviation (like –force for -f) More...
 
bool HasAbbreviation (const std::string &abbrev) const
 Will check wether or not an abbreviation is registered. More...
 
void ClearAbbreviations ()
 Will delete all abbreviations. More...
 
void RegisterConstraints (const std::vector< ParamConstraint > &constraints)
 Will register parameter constraints. More...
 
void ClearConstraints ()
 Will delete all constraints. More...
 
void SetCrashOnFail (bool crashOnFail)
 Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsing, or not. More...
 
bool GetCrashOnFail () const
 Gets whether the application crashes on an exception whilst parsing, and prints to stderr. More...
 
+

Detailed Description

+

The main class to interface with.

+ +

Definition at line 11 of file Hazelnupp.h.

+

Constructor & Destructor Documentation

+ +

◆ Hazelnupp() [1/2]

+ +
+
+ + + + + + + +
Hazelnupp::Hazelnupp ()
+
+ +

Definition at line 14 of file Hazelnupp.cpp.

+
15 {
+
16  return;
+
17 }
+
+
+
+ +

◆ Hazelnupp() [2/2]

+ +
+
+ + + + + + + + + + + + + + + + + + +
Hazelnupp::Hazelnupp (const int argc,
const char *const * argv 
)
+
+ +

Definition at line 19 of file Hazelnupp.cpp.

+
20 {
+
21  Parse(argc, argv);
+
22  return;
+
23 }
+
+
+
+ +

◆ ~Hazelnupp()

+ +
+
+ + + + + + + +
Hazelnupp::~Hazelnupp ()
+
+ +

Definition at line 25 of file Hazelnupp.cpp.

+
26 {
+
27  for (auto& it : parameters)
+
28  delete it.second;
+
29 
+
30  parameters.clear();
+
31 
+
32  return;
+
33 }
+
+
+
+

Member Function Documentation

+ +

◆ ClearAbbreviations()

+ +
+
+ + + + + + + +
void Hazelnupp::ClearAbbreviations ()
+
+ +

Will delete all abbreviations.

+ +

Definition at line 348 of file Hazelnupp.cpp.

+
349 {
+
350  abbreviations.clear();
+
351  return;
+
352 }
+
+
+
+ +

◆ ClearConstraints()

+ +
+
+ + + + + + + +
void Hazelnupp::ClearConstraints ()
+
+ +

Will delete all constraints.

+ +

Definition at line 375 of file Hazelnupp.cpp.

+
376 {
+
377  constraints.clear();
+
378  return;
+
379 }
+
+
+
+ +

◆ GetAbbreviation()

+ +
+
+ + + + + + + + +
const std::string & Hazelnupp::GetAbbreviation (const std::string & abbrev) const
+
+ +

Will return the long form of an abbreviation (like –force for -f)

+ +

Definition at line 338 of file Hazelnupp.cpp.

+
339 {
+
340  return abbreviations.find(abbrev)->second;
+
341 }
+
+
+
+ +

◆ GetCrashOnFail()

+ +
+
+ + + + + + + +
bool Hazelnupp::GetCrashOnFail () const
+
+ +

Gets whether the application crashes on an exception whilst parsing, and prints to stderr.

+ +

Definition at line 279 of file Hazelnupp.cpp.

+
280 {
+
281  return crashOnFail;
+
282 }
+
+
+
+ +

◆ GetExecutableName()

+ +
+
+ + + + + + + +
const std::string & Hazelnupp::GetExecutableName () const
+
+ +

Will return argv[0], the name of the executable.

+ +

Definition at line 318 of file Hazelnupp.cpp.

+
319 {
+
320  return executableName;
+
321 }
+
+
+
+ +

◆ HasAbbreviation()

+ +
+
+ + + + + + + + +
bool Hazelnupp::HasAbbreviation (const std::string & abbrev) const
+
+ +

Will check wether or not an abbreviation is registered.

+ +

Definition at line 343 of file Hazelnupp.cpp.

+
344 {
+
345  return abbreviations.find(abbrev) != abbreviations.end();
+
346 }
+
+
+
+ +

◆ HasParam()

+ +
+
+ + + + + + + + +
bool Hazelnupp::HasParam (const std::string & key) const
+
+ +

Will check wether a parameter exists given a key, or not.

+ +

Definition at line 153 of file Hazelnupp.cpp.

+
154 {
+
155  return parameters.find(key) != parameters.end();
+
156 }
+
+
+
+ +

◆ operator[]()

+ +
+
+ + + + + + + + +
const Value & Hazelnupp::operator[] (const std::string & key) const
+
+ +

Will return the value given a key.

+ +

Definition at line 323 of file Hazelnupp.cpp.

+
324 {
+
325  // Throw exception if param is unknown
+
326  if (!HasParam(key))
+ +
328 
+
329  return *parameters.find(key)->second->GetValue();
+
330 }
+
+
+
+ +

◆ Parse()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void Hazelnupp::Parse (const int argc,
const char *const * argv 
)
+
+ +

Will parse command line arguments.

+ +

Definition at line 35 of file Hazelnupp.cpp.

+
36 {
+
37  try
+
38  {
+
39  // Populate raw arguments
+
40  PopulateRawArgs(argc, argv);
+
41 
+
42  // Expand abbreviations
+
43  ExpandAbbreviations();
+
44 
+
45  executableName = std::string(rawArgs[0]);
+
46 
+
47  std::size_t i = 1;
+
48  while (i < rawArgs.size())
+
49  {
+
50  if ((rawArgs[i].length() > 2) && (rawArgs[i].substr(0, 2) == "--"))
+
51  {
+
52  Parameter* param = nullptr;
+
53  i = ParseNextParameter(i, param);
+
54 
+
55  parameters.insert(std::pair<std::string, Parameter*>(param->Key(), param));
+
56  }
+
57  else
+
58  i++;
+
59  }
+
60 
+
61  // Apply constraints such as default values, and required parameters.
+
62  // Types have already been enforced.
+
63  ApplyConstraints();
+
64  }
+
65  catch (const HazelnuppConstraintTypeMissmatch& hctm)
+
66  {
+
67  if (crashOnFail)
+
68  {
+
69  std::cerr << "Fatal error: Command-line parameter value-type mismatch at \"" << hctm.What() << "\"!";
+
70  quick_exit(-1009);
+
71  }
+
72  else
+
73  throw hctm; // yeet
+
74  }
+
75  catch (const HazelnuppConstraintMissingValue& hctm)
+
76  {
+
77  if (crashOnFail)
+
78  {
+
79  std::cerr << "Fatal error: Missing required command-line parameter \"" << hctm.What() << "\"!";
+
80  quick_exit(-1010);
+
81  }
+
82  else
+
83  throw hctm; // yeet
+
84  }
+
85 
+
86  return;
+
87 }
+
+
+
+ +

◆ RegisterAbbreviation()

+ +
+
+ + + + + + + + + + + + + + + + + + +
void Hazelnupp::RegisterAbbreviation (const std::string & abbrev,
const std::string & target 
)
+
+ +

Will register an abbreviation (like -f for –force)

+ +

Definition at line 332 of file Hazelnupp.cpp.

+
333 {
+
334  abbreviations.insert(std::pair<std::string, std::string>(abbrev, target));
+
335  return;
+
336 }
+
+
+
+ +

◆ RegisterConstraints()

+ +
+
+ + + + + + + + +
void Hazelnupp::RegisterConstraints (const std::vector< ParamConstraint > & constraints)
+
+ +

Will register parameter constraints.

+ +

Definition at line 354 of file Hazelnupp.cpp.

+
355 {
+
356  for (const ParamConstraint& pc : constraints)
+
357  {
+
358  // Does this constraint already exist?
+
359  const auto constraint = this->constraints.find(pc.key);
+
360  // If yes, replace it.
+
361  if (constraint != this->constraints.end())
+
362  constraint->second = pc;
+
363 
+
364  // Else, create a new pair
+
365  else
+
366  this->constraints.insert(std::pair<std::string, ParamConstraint>(
+
367  pc.key,
+
368  pc
+
369  ));
+
370  }
+
371 
+
372  return;
+
373 }
+
+
+
+ +

◆ SetCrashOnFail()

+ +
+
+ + + + + + + + +
void Hazelnupp::SetCrashOnFail (bool crashOnFail)
+
+ +

Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsing, or not.

+ +

Definition at line 381 of file Hazelnupp.cpp.

+
382 {
+
383  this->crashOnFail = crashOnFail;
+
384  return;
+
385 }
+
+
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:26
+
Hazelnp::HazelnuppException::What
const std::string & What() const
Will return an error message.
Definition: HazelnuppException.h:15
+
Hazelnp::Parameter
Definition: Parameter.h:8
+
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
+
Hazelnp::Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:153
+
Hazelnp::Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:35
+
Hazelnp::Parameter::Key
const std::string & Key() const
Will return the key of this parameter.
Definition: Parameter.cpp:21
+
Hazelnp::HazelnuppConstraintMissingValue
Gets thrown when a parameter constrained to be required is not provided, and has no default value set...
Definition: HazelnuppException.h:62
+
Hazelnp::HazelnuppConstraintTypeMissmatch
Gets thrown when a parameter is of a type that does not match the required type, and is not convertib...
Definition: HazelnuppException.h:53
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException-members.html b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html new file mode 100644 index 0000000..28b9400 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintException-members.html @@ -0,0 +1,98 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::HazelnuppConstraintException Member List
+
+
+ +

This is the complete list of members for Hazelnp::HazelnuppConstraintException, including all inherited members.

+ + + + + + + +
HazelnuppConstraintException()Hazelnp::HazelnuppConstraintExceptioninline
HazelnuppConstraintException(const std::string &msg)Hazelnp::HazelnuppConstraintExceptioninline
HazelnuppException()Hazelnp::HazelnuppExceptioninline
HazelnuppException(const std::string &msg)Hazelnp::HazelnuppExceptioninline
messageHazelnp::HazelnuppExceptionprotected
What() constHazelnp::HazelnuppExceptioninline
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException.html b/docs/classHazelnp_1_1HazelnuppConstraintException.html new file mode 100644 index 0000000..646ef7c --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintException.html @@ -0,0 +1,209 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::HazelnuppConstraintException Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::HazelnuppConstraintException Class Reference
+
+
+ +

Gets thrown something bad happens because of parameter constraints. + More...

+ +

#include <HazelnuppException.h>

+
+Inheritance diagram for Hazelnp::HazelnuppConstraintException:
+
+
Inheritance graph
+ + + + + + + +
[legend]
+
+Collaboration diagram for Hazelnp::HazelnuppConstraintException:
+
+
Collaboration graph
+ + + + + + + +
[legend]
+ + + + + + + + + + + + + + +

+Public Member Functions

 HazelnuppConstraintException ()
 
 HazelnuppConstraintException (const std::string &msg)
 
- Public Member Functions inherited from Hazelnp::HazelnuppException
 HazelnuppException ()
 
 HazelnuppException (const std::string &msg)
 
const std::string & What () const
 Will return an error message. More...
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from Hazelnp::HazelnuppException
std::string message
 
+

Detailed Description

+

Gets thrown something bad happens because of parameter constraints.

+ +

Definition at line 44 of file HazelnuppException.h.

+

Constructor & Destructor Documentation

+ +

◆ HazelnuppConstraintException() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException ()
+
+inline
+
+ +

Definition at line 47 of file HazelnuppException.h.

+
47 : HazelnuppException() {};
+
+
+
+ +

◆ HazelnuppConstraintException() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException (const std::string & msg)
+
+inline
+
+ +

Definition at line 48 of file HazelnuppException.h.

+
48 : HazelnuppException(msg) {};
+
+
+
+
The documentation for this class was generated from the following file: +
+
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:11
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.map b/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.map new file mode 100644 index 0000000..18f00b3 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.md5 b/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.md5 new file mode 100644 index 0000000..e3422d4 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.md5 @@ -0,0 +1 @@ +96b8a2e382311cb88b3e8d75cff008e2 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.png b/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.png new file mode 100644 index 0000000..9d7f56c Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppConstraintException__coll__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.map b/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.map new file mode 100644 index 0000000..e549bde --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.md5 b/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.md5 new file mode 100644 index 0000000..2e1f6f1 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.md5 @@ -0,0 +1 @@ +6bfea744987fc602457174078cb295d2 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.png b/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.png new file mode 100644 index 0000000..81563bd Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppConstraintException__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html new file mode 100644 index 0000000..ee20767 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue-members.html @@ -0,0 +1,100 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::HazelnuppConstraintMissingValue Member List
+
+
+ +

This is the complete list of members for Hazelnp::HazelnuppConstraintMissingValue, including all inherited members.

+ + + + + + + + + +
HazelnuppConstraintException()Hazelnp::HazelnuppConstraintExceptioninline
HazelnuppConstraintException(const std::string &msg)Hazelnp::HazelnuppConstraintExceptioninline
HazelnuppConstraintMissingValue()Hazelnp::HazelnuppConstraintMissingValueinline
HazelnuppConstraintMissingValue(const std::string &msg)Hazelnp::HazelnuppConstraintMissingValueinline
HazelnuppException()Hazelnp::HazelnuppExceptioninline
HazelnuppException(const std::string &msg)Hazelnp::HazelnuppExceptioninline
messageHazelnp::HazelnuppExceptionprotected
What() constHazelnp::HazelnuppExceptioninline
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html new file mode 100644 index 0000000..4004aae --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue.html @@ -0,0 +1,214 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::HazelnuppConstraintMissingValue Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::HazelnuppConstraintMissingValue Class Reference
+
+
+ +

Gets thrown when a parameter constrained to be required is not provided, and has no default value set. + More...

+ +

#include <HazelnuppException.h>

+
+Inheritance diagram for Hazelnp::HazelnuppConstraintMissingValue:
+
+
Inheritance graph
+ + + + + + +
[legend]
+
+Collaboration diagram for Hazelnp::HazelnuppConstraintMissingValue:
+
+
Collaboration graph
+ + + + + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 HazelnuppConstraintMissingValue ()
 
 HazelnuppConstraintMissingValue (const std::string &msg)
 
- Public Member Functions inherited from Hazelnp::HazelnuppConstraintException
 HazelnuppConstraintException ()
 
 HazelnuppConstraintException (const std::string &msg)
 
- Public Member Functions inherited from Hazelnp::HazelnuppException
 HazelnuppException ()
 
 HazelnuppException (const std::string &msg)
 
const std::string & What () const
 Will return an error message. More...
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from Hazelnp::HazelnuppException
std::string message
 
+

Detailed Description

+

Gets thrown when a parameter constrained to be required is not provided, and has no default value set.

+ +

Definition at line 62 of file HazelnuppException.h.

+

Constructor & Destructor Documentation

+ +

◆ HazelnuppConstraintMissingValue() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue ()
+
+inline
+
+ +

Definition at line 65 of file HazelnuppException.h.

+ +
+
+ +

◆ HazelnuppConstraintMissingValue() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue (const std::string & msg)
+
+inline
+
+ +

Definition at line 66 of file HazelnuppException.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException()
Definition: HazelnuppException.h:47
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.map b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.map new file mode 100644 index 0000000..e1c0d27 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.md5 b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.md5 new file mode 100644 index 0000000..22698a5 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.md5 @@ -0,0 +1 @@ +14fd73384f3d4b5bc6a4c29d9bd57dbd \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.png b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.png new file mode 100644 index 0000000..984f957 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__coll__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.map b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.map new file mode 100644 index 0000000..35b990d --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.md5 b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.md5 new file mode 100644 index 0000000..799a788 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.md5 @@ -0,0 +1 @@ +ac239fb6436ae22f9572ebde6d1fe1f3 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.png b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.png new file mode 100644 index 0000000..dd33504 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppConstraintMissingValue__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html new file mode 100644 index 0000000..082ffa2 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch-members.html @@ -0,0 +1,100 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::HazelnuppConstraintTypeMissmatch Member List
+
+
+ +

This is the complete list of members for Hazelnp::HazelnuppConstraintTypeMissmatch, including all inherited members.

+ + + + + + + + + +
HazelnuppConstraintException()Hazelnp::HazelnuppConstraintExceptioninline
HazelnuppConstraintException(const std::string &msg)Hazelnp::HazelnuppConstraintExceptioninline
HazelnuppConstraintTypeMissmatch()Hazelnp::HazelnuppConstraintTypeMissmatchinline
HazelnuppConstraintTypeMissmatch(const std::string &msg)Hazelnp::HazelnuppConstraintTypeMissmatchinline
HazelnuppException()Hazelnp::HazelnuppExceptioninline
HazelnuppException(const std::string &msg)Hazelnp::HazelnuppExceptioninline
messageHazelnp::HazelnuppExceptionprotected
What() constHazelnp::HazelnuppExceptioninline
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html new file mode 100644 index 0000000..4600db7 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html @@ -0,0 +1,214 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::HazelnuppConstraintTypeMissmatch Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::HazelnuppConstraintTypeMissmatch Class Reference
+
+
+ +

Gets thrown when a parameter is of a type that does not match the required type, and is not convertible to it. + More...

+ +

#include <HazelnuppException.h>

+
+Inheritance diagram for Hazelnp::HazelnuppConstraintTypeMissmatch:
+
+
Inheritance graph
+ + + + + + +
[legend]
+
+Collaboration diagram for Hazelnp::HazelnuppConstraintTypeMissmatch:
+
+
Collaboration graph
+ + + + + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 HazelnuppConstraintTypeMissmatch ()
 
 HazelnuppConstraintTypeMissmatch (const std::string &msg)
 
- Public Member Functions inherited from Hazelnp::HazelnuppConstraintException
 HazelnuppConstraintException ()
 
 HazelnuppConstraintException (const std::string &msg)
 
- Public Member Functions inherited from Hazelnp::HazelnuppException
 HazelnuppException ()
 
 HazelnuppException (const std::string &msg)
 
const std::string & What () const
 Will return an error message. More...
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from Hazelnp::HazelnuppException
std::string message
 
+

Detailed Description

+

Gets thrown when a parameter is of a type that does not match the required type, and is not convertible to it.

+ +

Definition at line 53 of file HazelnuppException.h.

+

Constructor & Destructor Documentation

+ +

◆ HazelnuppConstraintTypeMissmatch() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch ()
+
+inline
+
+ +

Definition at line 56 of file HazelnuppException.h.

+ +
+
+ +

◆ HazelnuppConstraintTypeMissmatch() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch (const std::string & msg)
+
+inline
+
+ +

Definition at line 57 of file HazelnuppException.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException
HazelnuppConstraintException()
Definition: HazelnuppException.h:47
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.map b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.map new file mode 100644 index 0000000..46ef196 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.md5 b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.md5 new file mode 100644 index 0000000..4b128bd --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.md5 @@ -0,0 +1 @@ +1f1eaf8f767f1aa9bb72dbd4a84338b9 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.png b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.png new file mode 100644 index 0000000..72419d4 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__coll__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.map b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.map new file mode 100644 index 0000000..92de922 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.md5 b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.md5 new file mode 100644 index 0000000..6666277 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.md5 @@ -0,0 +1 @@ +6e5f5d5345e3073deeee322acf58c7e9 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.png b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.png new file mode 100644 index 0000000..dfea604 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppConstraintTypeMissmatch__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppException-members.html b/docs/classHazelnp_1_1HazelnuppException-members.html new file mode 100644 index 0000000..6fe80e8 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppException-members.html @@ -0,0 +1,96 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::HazelnuppException Member List
+
+
+ +

This is the complete list of members for Hazelnp::HazelnuppException, including all inherited members.

+ + + + + +
HazelnuppException()Hazelnp::HazelnuppExceptioninline
HazelnuppException(const std::string &msg)Hazelnp::HazelnuppExceptioninline
messageHazelnp::HazelnuppExceptionprotected
What() constHazelnp::HazelnuppExceptioninline
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppException.html b/docs/classHazelnp_1_1HazelnuppException.html new file mode 100644 index 0000000..c55aae8 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppException.html @@ -0,0 +1,263 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::HazelnuppException Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
Hazelnp::HazelnuppException Class Reference
+
+
+ +

Generic hazelnupp exception. + More...

+ +

#include <HazelnuppException.h>

+
+Inheritance diagram for Hazelnp::HazelnuppException:
+
+
Inheritance graph
+ + + + + + + + + +
[legend]
+
+Collaboration diagram for Hazelnp::HazelnuppException:
+
+
Collaboration graph
+ + + + + + +
[legend]
+ + + + + + + + + +

+Public Member Functions

 HazelnuppException ()
 
 HazelnuppException (const std::string &msg)
 
const std::string & What () const
 Will return an error message. More...
 
+ + + +

+Protected Attributes

std::string message
 
+

Detailed Description

+

Generic hazelnupp exception.

+ +

Definition at line 8 of file HazelnuppException.h.

+

Constructor & Destructor Documentation

+ +

◆ HazelnuppException() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::HazelnuppException::HazelnuppException ()
+
+inline
+
+ +

Definition at line 11 of file HazelnuppException.h.

+
11 {};
+
+
+
+ +

◆ HazelnuppException() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Hazelnp::HazelnuppException::HazelnuppException (const std::string & msg)
+
+inline
+
+ +

Definition at line 12 of file HazelnuppException.h.

+
12 : message{ msg } {};
+
+
+
+

Member Function Documentation

+ +

◆ What()

+ +
+
+ + + + + +
+ + + + + + + +
const std::string& Hazelnp::HazelnuppException::What () const
+
+inline
+
+ +

Will return an error message.

+ +

Definition at line 15 of file HazelnuppException.h.

+
16  {
+
17  return message;
+
18  }
+
+
+
+

Member Data Documentation

+ +

◆ message

+ +
+
+ + + + + +
+ + + + +
std::string Hazelnp::HazelnuppException::message
+
+protected
+
+ +

Definition at line 21 of file HazelnuppException.h.

+ +
+
+
The documentation for this class was generated from the following file: +
+
Hazelnp::HazelnuppException::message
std::string message
Definition: HazelnuppException.h:21
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppException__coll__graph.map b/docs/classHazelnp_1_1HazelnuppException__coll__graph.map new file mode 100644 index 0000000..029a14c --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppException__coll__graph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppException__coll__graph.md5 b/docs/classHazelnp_1_1HazelnuppException__coll__graph.md5 new file mode 100644 index 0000000..e7d6faf --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppException__coll__graph.md5 @@ -0,0 +1 @@ +2c5462b81c42480e2dc96be21e93b854 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppException__coll__graph.png b/docs/classHazelnp_1_1HazelnuppException__coll__graph.png new file mode 100644 index 0000000..ad6d263 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppException__coll__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppException__inherit__graph.map b/docs/classHazelnp_1_1HazelnuppException__inherit__graph.map new file mode 100644 index 0000000..a6ea366 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppException__inherit__graph.map @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppException__inherit__graph.md5 b/docs/classHazelnp_1_1HazelnuppException__inherit__graph.md5 new file mode 100644 index 0000000..62507df --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppException__inherit__graph.md5 @@ -0,0 +1 @@ +00b4353ac48aa1c3c667f124b7f43920 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppException__inherit__graph.png b/docs/classHazelnp_1_1HazelnuppException__inherit__graph.png new file mode 100644 index 0000000..cd68df8 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppException__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html new file mode 100644 index 0000000..5bb996f --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException-members.html @@ -0,0 +1,98 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::HazelnuppInvalidKeyException Member List
+
+
+ +

This is the complete list of members for Hazelnp::HazelnuppInvalidKeyException, including all inherited members.

+ + + + + + + +
HazelnuppException()Hazelnp::HazelnuppExceptioninline
HazelnuppException(const std::string &msg)Hazelnp::HazelnuppExceptioninline
HazelnuppInvalidKeyException()Hazelnp::HazelnuppInvalidKeyExceptioninline
HazelnuppInvalidKeyException(const std::string &msg)Hazelnp::HazelnuppInvalidKeyExceptioninline
messageHazelnp::HazelnuppExceptionprotected
What() constHazelnp::HazelnuppExceptioninline
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html new file mode 100644 index 0000000..0112923 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException.html @@ -0,0 +1,207 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::HazelnuppInvalidKeyException Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::HazelnuppInvalidKeyException Class Reference
+
+
+ +

Gets thrown when an non-existent key gets dereferenced. + More...

+ +

#include <HazelnuppException.h>

+
+Inheritance diagram for Hazelnp::HazelnuppInvalidKeyException:
+
+
Inheritance graph
+ + + + + +
[legend]
+
+Collaboration diagram for Hazelnp::HazelnuppInvalidKeyException:
+
+
Collaboration graph
+ + + + + + + +
[legend]
+ + + + + + + + + + + + + + +

+Public Member Functions

 HazelnuppInvalidKeyException ()
 
 HazelnuppInvalidKeyException (const std::string &msg)
 
- Public Member Functions inherited from Hazelnp::HazelnuppException
 HazelnuppException ()
 
 HazelnuppException (const std::string &msg)
 
const std::string & What () const
 Will return an error message. More...
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from Hazelnp::HazelnuppException
std::string message
 
+

Detailed Description

+

Gets thrown when an non-existent key gets dereferenced.

+ +

Definition at line 26 of file HazelnuppException.h.

+

Constructor & Destructor Documentation

+ +

◆ HazelnuppInvalidKeyException() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException ()
+
+inline
+
+ +

Definition at line 29 of file HazelnuppException.h.

+
29 : HazelnuppException() {};
+
+
+
+ +

◆ HazelnuppInvalidKeyException() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException (const std::string & msg)
+
+inline
+
+ +

Definition at line 30 of file HazelnuppException.h.

+
30 : HazelnuppException(msg) {};
+
+
+
+
The documentation for this class was generated from the following file: +
+
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:11
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.map b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.map new file mode 100644 index 0000000..94b2ad3 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.md5 b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.md5 new file mode 100644 index 0000000..7de0395 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.md5 @@ -0,0 +1 @@ +16ffa3b5ee2be4c5c1c81b7d6b31ef6e \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.png b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.png new file mode 100644 index 0000000..1005044 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__coll__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.map b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.map new file mode 100644 index 0000000..ac469e9 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.md5 b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.md5 new file mode 100644 index 0000000..7beb2ba --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.md5 @@ -0,0 +1 @@ +ec76222368f87411cfe04b269a65aae9 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.png b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.png new file mode 100644 index 0000000..bbeb20c Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppInvalidKeyException__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html new file mode 100644 index 0000000..f2283e3 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException-members.html @@ -0,0 +1,98 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::HazelnuppValueNotConvertibleException Member List
+
+
+ +

This is the complete list of members for Hazelnp::HazelnuppValueNotConvertibleException, including all inherited members.

+ + + + + + + +
HazelnuppException()Hazelnp::HazelnuppExceptioninline
HazelnuppException(const std::string &msg)Hazelnp::HazelnuppExceptioninline
HazelnuppValueNotConvertibleException()Hazelnp::HazelnuppValueNotConvertibleExceptioninline
HazelnuppValueNotConvertibleException(const std::string &msg)Hazelnp::HazelnuppValueNotConvertibleExceptioninline
messageHazelnp::HazelnuppExceptionprotected
What() constHazelnp::HazelnuppExceptioninline
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html new file mode 100644 index 0000000..d8d7c1e --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException.html @@ -0,0 +1,207 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::HazelnuppValueNotConvertibleException Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::HazelnuppValueNotConvertibleException Class Reference
+
+
+ +

Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible. + More...

+ +

#include <HazelnuppException.h>

+
+Inheritance diagram for Hazelnp::HazelnuppValueNotConvertibleException:
+
+
Inheritance graph
+ + + + + +
[legend]
+
+Collaboration diagram for Hazelnp::HazelnuppValueNotConvertibleException:
+
+
Collaboration graph
+ + + + + + + +
[legend]
+ + + + + + + + + + + + + + +

+Public Member Functions

 HazelnuppValueNotConvertibleException ()
 
 HazelnuppValueNotConvertibleException (const std::string &msg)
 
- Public Member Functions inherited from Hazelnp::HazelnuppException
 HazelnuppException ()
 
 HazelnuppException (const std::string &msg)
 
const std::string & What () const
 Will return an error message. More...
 
+ + + + +

+Additional Inherited Members

- Protected Attributes inherited from Hazelnp::HazelnuppException
std::string message
 
+

Detailed Description

+

Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible.

+ +

Definition at line 35 of file HazelnuppException.h.

+

Constructor & Destructor Documentation

+ +

◆ HazelnuppValueNotConvertibleException() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException ()
+
+inline
+
+ +

Definition at line 38 of file HazelnuppException.h.

+
38 : HazelnuppException() {};
+
+
+
+ +

◆ HazelnuppValueNotConvertibleException() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + +
Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException (const std::string & msg)
+
+inline
+
+ +

Definition at line 39 of file HazelnuppException.h.

+
39 : HazelnuppException(msg) {};
+
+
+
+
The documentation for this class was generated from the following file: +
+
Hazelnp::HazelnuppException::HazelnuppException
HazelnuppException()
Definition: HazelnuppException.h:11
+ + + + diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.map b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.map new file mode 100644 index 0000000..45a6978 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.map @@ -0,0 +1,7 @@ + + + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.md5 b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.md5 new file mode 100644 index 0000000..3b39ca0 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.md5 @@ -0,0 +1 @@ +6a4d9f244c4f2ea667c5f6cb28e730f4 \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.png b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.png new file mode 100644 index 0000000..44df348 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__coll__graph.png differ diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.map b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.map new file mode 100644 index 0000000..f754562 --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.map @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.md5 b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.md5 new file mode 100644 index 0000000..04e6bea --- /dev/null +++ b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.md5 @@ -0,0 +1 @@ +2c8552ee30b1bf6307565ce38078f9be \ No newline at end of file diff --git a/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.png b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.png new file mode 100644 index 0000000..951d4d3 Binary files /dev/null and b/docs/classHazelnp_1_1HazelnuppValueNotConvertibleException__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1IntValue-members.html b/docs/classHazelnp_1_1IntValue-members.html new file mode 100644 index 0000000..dfecb79 --- /dev/null +++ b/docs/classHazelnp_1_1IntValue-members.html @@ -0,0 +1,109 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::IntValue Member List
+
+
+ +

This is the complete list of members for Hazelnp::IntValue, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
Deepcopy() const overrideHazelnp::IntValuevirtual
GetAsOsString() const overrideHazelnp::IntValuevirtual
GetDataType() constHazelnp::Value
GetFloat32() const overrideHazelnp::IntValuevirtual
GetFloat64() const overrideHazelnp::IntValuevirtual
GetInt32() const overrideHazelnp::IntValuevirtual
GetInt64() const overrideHazelnp::IntValuevirtual
GetList() const overrideHazelnp::IntValuevirtual
GetString() const overrideHazelnp::IntValuevirtual
GetValue() constHazelnp::IntValue
IntValue(const long long int &value)Hazelnp::IntValue
operator int() constHazelnp::IntValue
operator long long int() constHazelnp::IntValue
typeHazelnp::Valueprotected
Value(DATA_TYPE type)Hazelnp::Valueprotected
~IntValue() overrideHazelnp::IntValueinline
~Value()Hazelnp::Valueinlinevirtual
+ + + + diff --git a/docs/classHazelnp_1_1IntValue.html b/docs/classHazelnp_1_1IntValue.html new file mode 100644 index 0000000..3e607ac --- /dev/null +++ b/docs/classHazelnp_1_1IntValue.html @@ -0,0 +1,582 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::IntValue Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::IntValue Class Reference
+
+
+ +

Specializations for integer values (uses long long int) + More...

+ +

#include <IntValue.h>

+
+Inheritance diagram for Hazelnp::IntValue:
+
+
Inheritance graph
+ + + + +
[legend]
+
+Collaboration diagram for Hazelnp::IntValue:
+
+
Collaboration graph
+ + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 IntValue (const long long int &value)
 
 ~IntValue () override
 
ValueDeepcopy () const override
 Will return a deeopopy of this object. More...
 
std::string GetAsOsString () const override
 Will return a string suitable for an std::ostream;. More...
 
const long long int & GetValue () const
 Will return the raw value. More...
 
 operator long long int () const
 
 operator int () const
 
long long int GetInt64 () const override
 Will return the data as a long long int. More...
 
int GetInt32 () const override
 Will return the data as an int. More...
 
long double GetFloat64 () const override
 Will return the data as a long double. More...
 
double GetFloat32 () const override
 Will return the data as a double. More...
 
std::string GetString () const override
 Will return the data as a string. More...
 
const std::vector< Value * > & GetList () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
- Public Member Functions inherited from Hazelnp::Value
virtual ~Value ()
 
DATA_TYPE GetDataType () const
 Will return the data type of this value. More...
 
+ + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from Hazelnp::Value
 Value (DATA_TYPE type)
 
- Protected Attributes inherited from Hazelnp::Value
DATA_TYPE type
 
+

Detailed Description

+

Specializations for integer values (uses long long int)

+ +

Definition at line 8 of file IntValue.h.

+

Constructor & Destructor Documentation

+ +

◆ IntValue()

+ +
+
+ + + + + + + + +
IntValue::IntValue (const long long int & value)
+
+ +

Definition at line 7 of file IntValue.cpp.

+
8  :
+ +
10  value { value }
+
11 {
+
12  return;
+
13 }
+
+
+
+ +

◆ ~IntValue()

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::IntValue::~IntValue ()
+
+inlineoverride
+
+ +

Definition at line 12 of file IntValue.h.

+
12 {};
+
+
+
+

Member Function Documentation

+ +

◆ Deepcopy()

+ +
+
+ + + + + +
+ + + + + + + +
Value * IntValue::Deepcopy () const
+
+overridevirtual
+
+ +

Will return a deeopopy of this object.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 15 of file IntValue.cpp.

+
16 {
+
17  return new IntValue(value);
+
18 }
+
+
+
+ +

◆ GetAsOsString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string IntValue::GetAsOsString () const
+
+overridevirtual
+
+ +

Will return a string suitable for an std::ostream;.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 20 of file IntValue.cpp.

+
21 {
+
22  std::stringstream ss;
+
23  ss << "IntValue: " << value;
+
24  return ss.str();
+
25 }
+
+
+
+ +

◆ GetFloat32()

+ +
+
+ + + + + +
+ + + + + + + +
double IntValue::GetFloat32 () const
+
+overridevirtual
+
+ +

Will return the data as a double.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 59 of file IntValue.cpp.

+
60 {
+
61  return (double)value;
+
62 }
+
+
+
+ +

◆ GetFloat64()

+ +
+
+ + + + + +
+ + + + + + + +
long double IntValue::GetFloat64 () const
+
+overridevirtual
+
+ +

Will return the data as a long double.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 54 of file IntValue.cpp.

+
55 {
+
56  return (long double)value;
+
57 }
+
+
+
+ +

◆ GetInt32()

+ +
+
+ + + + + +
+ + + + + + + +
int IntValue::GetInt32 () const
+
+overridevirtual
+
+ +

Will return the data as an int.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 49 of file IntValue.cpp.

+
50 {
+
51  return (int)value;
+
52 }
+
+
+
+ +

◆ GetInt64()

+ +
+
+ + + + + +
+ + + + + + + +
long long int IntValue::GetInt64 () const
+
+overridevirtual
+
+ +

Will return the data as a long long int.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 44 of file IntValue.cpp.

+
45 {
+
46  return value;
+
47 }
+
+
+
+ +

◆ GetList()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Value * > & IntValue::GetList () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 72 of file IntValue.cpp.

+
73 {
+ +
75 }
+
+
+
+ +

◆ GetString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string IntValue::GetString () const
+
+overridevirtual
+
+ +

Will return the data as a string.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 64 of file IntValue.cpp.

+
65 {
+
66  std::stringstream ss;
+
67  ss << value;
+
68 
+
69  return ss.str();
+
70 }
+
+
+
+ +

◆ GetValue()

+ +
+
+ + + + + + + +
const long long int & IntValue::GetValue () const
+
+ +

Will return the raw value.

+ +

Definition at line 27 of file IntValue.cpp.

+
28 {
+
29  return value;
+
30 }
+
+
+
+ +

◆ operator int()

+ +
+
+ + + + + + + +
IntValue::operator int () const
+
+ +

Definition at line 37 of file IntValue.cpp.

+
38 {
+
39  return (int)value;
+
40 }
+
+
+
+ +

◆ operator long long int()

+ +
+
+ + + + + + + +
IntValue::operator long long int () const
+
+ +

Definition at line 32 of file IntValue.cpp.

+
33 {
+
34  return value;
+
35 }
+
+
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::IntValue::IntValue
IntValue(const long long int &value)
Definition: IntValue.cpp:7
+
Hazelnp::Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:5
+
Hazelnp::DATA_TYPE::INT
@ INT
+
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_1IntValue__coll__graph.map b/docs/classHazelnp_1_1IntValue__coll__graph.map new file mode 100644 index 0000000..346ceea --- /dev/null +++ b/docs/classHazelnp_1_1IntValue__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1IntValue__coll__graph.md5 b/docs/classHazelnp_1_1IntValue__coll__graph.md5 new file mode 100644 index 0000000..8f77434 --- /dev/null +++ b/docs/classHazelnp_1_1IntValue__coll__graph.md5 @@ -0,0 +1 @@ +d1c122153bd42fb55af0f1031cd38231 \ No newline at end of file diff --git a/docs/classHazelnp_1_1IntValue__coll__graph.png b/docs/classHazelnp_1_1IntValue__coll__graph.png new file mode 100644 index 0000000..1577bd4 Binary files /dev/null and b/docs/classHazelnp_1_1IntValue__coll__graph.png differ diff --git a/docs/classHazelnp_1_1IntValue__inherit__graph.map b/docs/classHazelnp_1_1IntValue__inherit__graph.map new file mode 100644 index 0000000..346ceea --- /dev/null +++ b/docs/classHazelnp_1_1IntValue__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1IntValue__inherit__graph.md5 b/docs/classHazelnp_1_1IntValue__inherit__graph.md5 new file mode 100644 index 0000000..8f77434 --- /dev/null +++ b/docs/classHazelnp_1_1IntValue__inherit__graph.md5 @@ -0,0 +1 @@ +d1c122153bd42fb55af0f1031cd38231 \ No newline at end of file diff --git a/docs/classHazelnp_1_1IntValue__inherit__graph.png b/docs/classHazelnp_1_1IntValue__inherit__graph.png new file mode 100644 index 0000000..1577bd4 Binary files /dev/null and b/docs/classHazelnp_1_1IntValue__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1ListValue-members.html b/docs/classHazelnp_1_1ListValue-members.html new file mode 100644 index 0000000..d6be580 --- /dev/null +++ b/docs/classHazelnp_1_1ListValue-members.html @@ -0,0 +1,109 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::ListValue Member List
+
+
+ +

This is the complete list of members for Hazelnp::ListValue, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
AddValue(const Value *value)Hazelnp::ListValue
Deepcopy() const overrideHazelnp::ListValuevirtual
GetAsOsString() const overrideHazelnp::ListValuevirtual
GetDataType() constHazelnp::Value
GetFloat32() const overrideHazelnp::ListValuevirtual
GetFloat64() const overrideHazelnp::ListValuevirtual
GetInt32() const overrideHazelnp::ListValuevirtual
GetInt64() const overrideHazelnp::ListValuevirtual
GetList() const overrideHazelnp::ListValuevirtual
GetString() const overrideHazelnp::ListValuevirtual
GetValue() constHazelnp::ListValue
ListValue()Hazelnp::ListValue
operator std::vector< Value * >() constHazelnp::ListValue
typeHazelnp::Valueprotected
Value(DATA_TYPE type)Hazelnp::Valueprotected
~ListValue() overrideHazelnp::ListValue
~Value()Hazelnp::Valueinlinevirtual
+ + + + diff --git a/docs/classHazelnp_1_1ListValue.html b/docs/classHazelnp_1_1ListValue.html new file mode 100644 index 0000000..825823c --- /dev/null +++ b/docs/classHazelnp_1_1ListValue.html @@ -0,0 +1,609 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::ListValue Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::ListValue Class Reference
+
+
+ +

Specializations for list values (uses std::vector<Value*>) + More...

+ +

#include <ListValue.h>

+
+Inheritance diagram for Hazelnp::ListValue:
+
+
Inheritance graph
+ + + + +
[legend]
+
+Collaboration diagram for Hazelnp::ListValue:
+
+
Collaboration graph
+ + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 ListValue ()
 
 ~ListValue () override
 
ValueDeepcopy () const override
 Will return a deeopopy of this object. More...
 
std::string GetAsOsString () const override
 Will return a string suitable for an std::ostream;. More...
 
void AddValue (const Value *value)
 Will add this value to the list. More...
 
const std::vector< Value * > & GetValue () const
 Will return the raw value. More...
 
 operator std::vector< Value * > () const
 
long long int GetInt64 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
int GetInt32 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
long double GetFloat64 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
double GetFloat32 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
std::string GetString () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
const std::vector< Value * > & GetList () const override
 Will return this values list. More...
 
- Public Member Functions inherited from Hazelnp::Value
virtual ~Value ()
 
DATA_TYPE GetDataType () const
 Will return the data type of this value. More...
 
+ + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from Hazelnp::Value
 Value (DATA_TYPE type)
 
- Protected Attributes inherited from Hazelnp::Value
DATA_TYPE type
 
+

Detailed Description

+

Specializations for list values (uses std::vector<Value*>)

+ +

Definition at line 9 of file ListValue.h.

+

Constructor & Destructor Documentation

+ +

◆ ListValue()

+ +
+
+ + + + + + + +
ListValue::ListValue ()
+
+ +

Definition at line 7 of file ListValue.cpp.

+
7  :
+ +
9 {
+
10  return;
+
11 }
+
+
+
+ +

◆ ~ListValue()

+ +
+
+ + + + + +
+ + + + + + + +
ListValue::~ListValue ()
+
+override
+
+ +

Definition at line 13 of file ListValue.cpp.

+
14 {
+
15  for (Value* val : value)
+
16  delete val;
+
17 
+
18  value.clear();
+
19 
+
20  return;
+
21 }
+
+
+
+

Member Function Documentation

+ +

◆ AddValue()

+ +
+
+ + + + + + + + +
void ListValue::AddValue (const Valuevalue)
+
+ +

Will add this value to the list.

+ +

Definition at line 33 of file ListValue.cpp.

+
34 {
+
35  this->value.emplace_back(value->Deepcopy());
+
36  return;
+
37 }
+
+
+
+ +

◆ Deepcopy()

+ +
+
+ + + + + +
+ + + + + + + +
Value * ListValue::Deepcopy () const
+
+overridevirtual
+
+ +

Will return a deeopopy of this object.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 23 of file ListValue.cpp.

+
24 {
+
25  ListValue* newList = new ListValue();
+
26 
+
27  for (const Value* val : value)
+
28  newList->AddValue(val);
+
29 
+
30  return newList;
+
31 }
+
+
+
+ +

◆ GetAsOsString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string ListValue::GetAsOsString () const
+
+overridevirtual
+
+ +

Will return a string suitable for an std::ostream;.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 44 of file ListValue.cpp.

+
45 {
+
46  std::stringstream ss;
+
47 
+
48  ss << "ListValue: [";
+
49 
+
50  for (const Value* val : value)
+
51  {
+
52  ss << *val;
+
53  if (val != value.back())
+
54  ss << ", ";
+
55  }
+
56 
+
57  ss << "]";
+
58 
+
59  return ss.str();
+
60 }
+
+
+
+ +

◆ GetFloat32()

+ +
+
+ + + + + +
+ + + + + + + +
double ListValue::GetFloat32 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 84 of file ListValue.cpp.

+
85 {
+ +
87 }
+
+
+
+ +

◆ GetFloat64()

+ +
+
+ + + + + +
+ + + + + + + +
long double ListValue::GetFloat64 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 79 of file ListValue.cpp.

+
80 {
+ +
82 }
+
+
+
+ +

◆ GetInt32()

+ +
+
+ + + + + +
+ + + + + + + +
int ListValue::GetInt32 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 74 of file ListValue.cpp.

+
75 {
+ +
77 }
+
+
+
+ +

◆ GetInt64()

+ +
+
+ + + + + +
+ + + + + + + +
long long int ListValue::GetInt64 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 69 of file ListValue.cpp.

+
70 {
+ +
72 }
+
+
+
+ +

◆ GetList()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Value * > & ListValue::GetList () const
+
+overridevirtual
+
+ +

Will return this values list.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 94 of file ListValue.cpp.

+
95 {
+
96  return value;
+
97 }
+
+
+
+ +

◆ GetString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string ListValue::GetString () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 89 of file ListValue.cpp.

+
90 {
+ +
92 }
+
+
+
+ +

◆ GetValue()

+ +
+
+ + + + + + + +
const std::vector< Value * > & ListValue::GetValue () const
+
+ +

Will return the raw value.

+ +

Definition at line 39 of file ListValue.cpp.

+
40 {
+
41  return value;
+
42 }
+
+
+
+ +

◆ operator std::vector< Value * >()

+ +
+
+ + + + + + + +
ListValue::operator std::vector< Value * > () const
+
+ +

Definition at line 62 of file ListValue.cpp.

+
63 {
+
64  return value;
+
65 }
+
+
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::Value
Abstract class for values.
Definition: Value.h:10
+
Hazelnp::DATA_TYPE::LIST
@ LIST
+
Hazelnp::Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:5
+
Hazelnp::ListValue::AddValue
void AddValue(const Value *value)
Will add this value to the list.
Definition: ListValue.cpp:33
+
Hazelnp::ListValue::ListValue
ListValue()
Definition: ListValue.cpp:7
+
Hazelnp::Value::Deepcopy
virtual Value * Deepcopy() const =0
Will return a deeopopy of this object.
+
Hazelnp::ListValue
Specializations for list values (uses std::vector<Value*>)
Definition: ListValue.h:9
+
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__coll__graph.map b/docs/classHazelnp_1_1ListValue__coll__graph.map new file mode 100644 index 0000000..058621e --- /dev/null +++ b/docs/classHazelnp_1_1ListValue__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1ListValue__coll__graph.md5 b/docs/classHazelnp_1_1ListValue__coll__graph.md5 new file mode 100644 index 0000000..92755e4 --- /dev/null +++ b/docs/classHazelnp_1_1ListValue__coll__graph.md5 @@ -0,0 +1 @@ +6921e127b70abed544fbb3e125f3d3b2 \ No newline at end of file diff --git a/docs/classHazelnp_1_1ListValue__coll__graph.png b/docs/classHazelnp_1_1ListValue__coll__graph.png new file mode 100644 index 0000000..108f96b Binary files /dev/null and b/docs/classHazelnp_1_1ListValue__coll__graph.png differ diff --git a/docs/classHazelnp_1_1ListValue__inherit__graph.map b/docs/classHazelnp_1_1ListValue__inherit__graph.map new file mode 100644 index 0000000..058621e --- /dev/null +++ b/docs/classHazelnp_1_1ListValue__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1ListValue__inherit__graph.md5 b/docs/classHazelnp_1_1ListValue__inherit__graph.md5 new file mode 100644 index 0000000..92755e4 --- /dev/null +++ b/docs/classHazelnp_1_1ListValue__inherit__graph.md5 @@ -0,0 +1 @@ +6921e127b70abed544fbb3e125f3d3b2 \ No newline at end of file diff --git a/docs/classHazelnp_1_1ListValue__inherit__graph.png b/docs/classHazelnp_1_1ListValue__inherit__graph.png new file mode 100644 index 0000000..108f96b Binary files /dev/null and b/docs/classHazelnp_1_1ListValue__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1Parameter-members.html b/docs/classHazelnp_1_1Parameter-members.html new file mode 100644 index 0000000..00fc385 --- /dev/null +++ b/docs/classHazelnp_1_1Parameter-members.html @@ -0,0 +1,97 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::Parameter Member List
+
+
+ +

This is the complete list of members for Hazelnp::Parameter, including all inherited members.

+ + + + + + +
GetValue() constHazelnp::Parameter
Key() constHazelnp::Parameter
operator<<(std::ostream &os, const Parameter &p)Hazelnp::Parameterfriend
Parameter(const std::string &key, const Value *value)Hazelnp::Parameterexplicit
~Parameter()Hazelnp::Parameter
+ + + + diff --git a/docs/classHazelnp_1_1Parameter.html b/docs/classHazelnp_1_1Parameter.html new file mode 100644 index 0000000..e728b3b --- /dev/null +++ b/docs/classHazelnp_1_1Parameter.html @@ -0,0 +1,283 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::Parameter Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Friends | +List of all members
+
+
Hazelnp::Parameter Class Reference
+
+
+ +

#include <Parameter.h>

+ + + + + + + + + + + + +

+Public Member Functions

 Parameter (const std::string &key, const Value *value)
 
 ~Parameter ()
 
const std::string & Key () const
 Will return the key of this parameter. More...
 
const ValueGetValue () const
 Will return the value of this parameter. More...
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const Parameter &p)
 
+

Detailed Description

+
+

Definition at line 8 of file Parameter.h.

+

Constructor & Destructor Documentation

+ +

◆ Parameter()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Parameter::Parameter (const std::string & key,
const Valuevalue 
)
+
+explicit
+
+ +

Definition at line 5 of file Parameter.cpp.

+
6  :
+
7  key{ key }
+
8 {
+
9  this->value = value->Deepcopy();
+
10  return;
+
11 }
+
+
+
+ +

◆ ~Parameter()

+ +
+
+ + + + + + + +
Parameter::~Parameter ()
+
+ +

Definition at line 13 of file Parameter.cpp.

+
14 {
+
15  delete value;
+
16  value = nullptr;
+
17 
+
18  return;
+
19 }
+
+
+
+

Member Function Documentation

+ +

◆ GetValue()

+ +
+
+ + + + + + + +
const ::Value * Parameter::GetValue () const
+
+ +

Will return the value of this parameter.

+ +

Definition at line 26 of file Parameter.cpp.

+
27 {
+
28  return value;
+
29 }
+
+
+
+ +

◆ Key()

+ +
+
+ + + + + + + +
const std::string & Parameter::Key () const
+
+ +

Will return the key of this parameter.

+ +

Definition at line 21 of file Parameter.cpp.

+
22 {
+
23  return key;
+
24 }
+
+
+
+

Friends And Related Function Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream& operator<< (std::ostream & os,
const Parameterp 
)
+
+friend
+
+ +

Definition at line 20 of file Parameter.h.

+
21  {
+
22  return os << "{ Key: \"" << p.key << "\" -> " << *p.value << " }";
+
23  }
+
+
+
+
The documentation for this class was generated from the following files: +
+
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 new file mode 100644 index 0000000..02d6a91 --- /dev/null +++ b/docs/classHazelnp_1_1StringTools-members.html @@ -0,0 +1,100 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::StringTools Member List
+
+
+ +

This is the complete list of members for Hazelnp::StringTools, including all inherited members.

+ + + + + + + + + +
Contains(const std::string &str, const char c)Hazelnp::StringToolsstatic
IsNumeric(const std::string &str, const bool allowDecimalPoint=false)Hazelnp::StringToolsstatic
ParseNumber(const std::string &str, bool &out_isInt, long double &out_number)Hazelnp::StringToolsstatic
Replace(const std::string &str, const char find, const std::string &subst)Hazelnp::StringToolsstatic
Replace(const std::string &str, const std::string &find, const std::string &subst)Hazelnp::StringToolsstatic
SplitString(const std::string &str, const char delimiter)Hazelnp::StringToolsstatic
SplitString(const std::string &str, const std::string &delimiter)Hazelnp::StringToolsstatic
ToLower(const std::string &str)Hazelnp::StringToolsstatic
+ + + + diff --git a/docs/classHazelnp_1_1StringTools.html b/docs/classHazelnp_1_1StringTools.html new file mode 100644 index 0000000..c3ed9f2 --- /dev/null +++ b/docs/classHazelnp_1_1StringTools.html @@ -0,0 +1,634 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::StringTools Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Static Public Member Functions | +List of all members
+
+
Hazelnp::StringTools Class Reference
+
+
+ +

Internal helper class. + More...

+ +

#include <StringTools.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + +

+Static Public Member Functions

static bool Contains (const std::string &str, const char c)
 Will return wether or not a given char is in a string. More...
 
static std::string Replace (const std::string &str, const char find, const std::string &subst)
 Will replace a part of a string with another string. More...
 
static std::string Replace (const std::string &str, const std::string &find, const std::string &subst)
 Will replace a part of a string with another string. More...
 
static bool IsNumeric (const std::string &str, const bool allowDecimalPoint=false)
 Will return true if the given string consists only of digits (including signage) More...
 
static bool ParseNumber (const std::string &str, bool &out_isInt, long double &out_number)
 Will convert the number in str to a number. More...
 
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! More...
 
static std::vector< std::string > SplitString (const std::string &str, const std::string &delimiter)
 Will split a string by a delimiter string. The delimiter will be excluded! More...
 
static std::string ToLower (const std::string &str)
 Will make a string all lower-case. More...
 
+

Detailed Description

+

Internal helper class.

+

Feel free to use it tho.

+ +

Definition at line 11 of file StringTools.h.

+

Member Function Documentation

+ +

◆ Contains()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool StringTools::Contains (const std::string & str,
const char c 
)
+
+static
+
+ +

Will return wether or not a given char is in a string.

+ +

Definition at line 5 of file StringTools.cpp.

+
6 {
+
7  for (const char& i : str)
+
8  if (i == c)
+
9  return true;
+
10 
+
11  return false;
+
12 }
+
+
+
+ +

◆ IsNumeric()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
bool StringTools::IsNumeric (const std::string & str,
const bool allowDecimalPoint = false 
)
+
+static
+
+ +

Will return true if the given string consists only of digits (including signage)

+ +

Definition at line 56 of file StringTools.cpp.

+
57 {
+
58  if (str.length() == 0) return false;
+
59 
+
60  bool alreadyParsedDecimalPoint = false;
+
61  std::size_t digitCount = 0;
+
62 
+
63  for (std::size_t i = 0; i < str.length(); i++)
+
64  {
+
65  if (!(
+
66  ((str[i] >= '0') && (str[i] <= '9')) ||
+
67  ((str[i] == '-') && (i == 0)) ||
+
68  ((str[i] == '.') && (allowDecimalPoint) && (!alreadyParsedDecimalPoint) && (digitCount > 0))
+
69  )) return false;
+
70 
+
71 
+
72  // Here we just have to check for the character. Not for any other conditions.
+
73  // Why? Because if these conditions failed, the function would have already returned false.
+
74  if (((str[i] >= '0') && (str[i] <= '9'))) digitCount++;
+
75  if (str[i] == '.') alreadyParsedDecimalPoint = true;
+
76  }
+
77 
+
78  // Even if we did not find any invalid chars, we should still return false, if we found no digits at all.
+
79  return digitCount > 0;
+
80 }
+
+
+
+ +

◆ ParseNumber()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
bool StringTools::ParseNumber (const std::string & str,
bool & out_isInt,
long double & out_number 
)
+
+static
+
+ +

Will convert the number in str to a number.

+


+ Returns wether or not the operation was successful.
+ Also returns wether the number is an integer, or floating point. If int, cast out_number to int.

+ +

Definition at line 82 of file StringTools.cpp.

+
83 {
+
84  bool isDecimal = false;
+
85 
+
86  if (str.length() == 0) return false;
+
87  if (Contains(str, '.')) isDecimal = true;
+
88 
+
89  if (isDecimal)
+
90  {
+
91  try
+
92  {
+
93  out_number = std::stold(str);
+
94  out_isInt = false;
+
95  }
+
96  catch (std::invalid_argument&)
+
97  {
+
98  return false;
+
99  }
+
100  catch (std::out_of_range&)
+
101  {
+
102  return false;
+
103  }
+
104  }
+
105  else
+
106  {
+
107  try
+
108  {
+
109  out_number = (long double)std::stoll(str);
+
110  out_isInt = true;
+
111  }
+
112  catch (std::invalid_argument&)
+
113  {
+
114  return false;
+
115  }
+
116  catch (std::out_of_range&)
+
117  {
+
118  return false;
+
119  }
+
120  }
+
121 
+
122  return true;
+
123 }
+
+
+
+ +

◆ Replace() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::string StringTools::Replace (const std::string & str,
const char find,
const std::string & subst 
)
+
+static
+
+ +

Will replace a part of a string with another string.

+ +

Definition at line 14 of file StringTools.cpp.

+
15 {
+
16  std::stringstream ss;
+
17 
+
18  for (std::size_t i = 0; i < str.length(); i++)
+
19  {
+
20  if (str[i] != find) ss << str[i];
+
21  else ss << subst;
+
22  }
+
23 
+
24  return ss.str();
+
25 }
+
+
+
+ +

◆ Replace() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
std::string StringTools::Replace (const std::string & str,
const std::string & find,
const std::string & subst 
)
+
+static
+
+ +

Will replace a part of a string with another string.

+ +

Definition at line 27 of file StringTools.cpp.

+
28 {
+
29  if (find.length() == 0) return str;
+
30 
+
31  std::stringstream ss;
+
32 
+
33  std::size_t posFound = 0;
+
34  std::size_t lastFound = 0;
+
35 
+
36  while (posFound != std::string::npos)
+
37  {
+
38  lastFound = posFound;
+
39  posFound = str.find(find, posFound);
+
40 
+
41  if (posFound != std::string::npos)
+
42  {
+
43  ss << str.substr(lastFound, posFound - lastFound) << subst;
+
44  posFound += find.length();
+
45  }
+
46  else
+
47  {
+
48  ss << str.substr(lastFound, (str.length()) - lastFound);
+
49  }
+
50  }
+
51 
+
52  return ss.str();
+
53 }
+
+
+
+ +

◆ SplitString() [1/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::vector< std::string > StringTools::SplitString (const std::string & str,
const char delimiter 
)
+
+static
+
+ +

Will split a string by a delimiter char. The delimiter will be excluded!

+ +

Definition at line 125 of file StringTools.cpp.

+
126 {
+
127  if (str.length() == 0) return std::vector<std::string>();
+
128 
+
129  return SplitString(str, delimiter);
+
130 }
+
+
+
+ +

◆ SplitString() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::vector< std::string > StringTools::SplitString (const std::string & str,
const std::string & delimiter 
)
+
+static
+
+ +

Will split a string by a delimiter string. The delimiter will be excluded!

+ +

Definition at line 132 of file StringTools.cpp.

+
133 {
+
134  if (str.length() == 0) return std::vector<std::string>();
+
135 
+
136  std::vector<std::string> parts;
+
137 
+
138  if (delimiter.length() == 0) // If the delimiter is "" (empty), just split between every single char. Not useful, but logical
+
139  {
+
140  for (std::size_t i = 0; i < str.length(); i++)
+
141  {
+
142  parts.push_back(std::string({ str[i] }));
+
143  }
+
144  return parts;
+
145  }
+
146 
+
147  std::size_t posFound = 0;
+
148  std::size_t lastFound = 0;
+
149 
+
150  while (posFound != std::string::npos)
+
151  {
+
152  lastFound = posFound;
+
153  posFound = str.find(delimiter, posFound);
+
154 
+
155  std::string found;
+
156 
+
157  if (posFound != std::string::npos)
+
158  {
+
159  found = str.substr(lastFound, posFound - lastFound);
+
160  posFound += delimiter.length();
+
161  }
+
162  else
+
163  {
+
164  found = str.substr(lastFound, str.length() - lastFound);
+
165  }
+
166 
+
167  parts.push_back(found);
+
168  }
+
169 
+
170  return parts;
+
171 }
+
+
+
+ +

◆ ToLower()

+ +
+
+ + + + + +
+ + + + + + + + +
std::string StringTools::ToLower (const std::string & str)
+
+static
+
+ +

Will make a string all lower-case.

+ +

Definition at line 173 of file StringTools.cpp.

+
174 {
+
175  std::stringstream ss;
+
176  for (std::size_t i = 0; i < str.length(); i++)
+
177  {
+
178  if ((str[i] >= 'A') && (str[i] <= 'Z')) ss << (char)(((int)str[i]) + 32);
+
179  else if (str[i] == -60) ss << (char)-28; // AE => ae
+
180  else if (str[i] == -42) ss << (char)-10; // OE => oe
+
181  else if (str[i] == -36) ss << (char)-4; // UE => ue
+
182  else ss << str[i];
+
183  }
+
184 
+
185  return ss.str();
+
186 }
+
+
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::StringTools::Contains
static bool Contains(const std::string &str, const char c)
Will return wether or not a given char is in a string.
Definition: StringTools.cpp:5
+
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 new file mode 100644 index 0000000..7d3c8c7 --- /dev/null +++ b/docs/classHazelnp_1_1StringValue-members.html @@ -0,0 +1,108 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::StringValue Member List
+
+
+ +

This is the complete list of members for Hazelnp::StringValue, including all inherited members.

+ + + + + + + + + + + + + + + + + +
Deepcopy() const overrideHazelnp::StringValuevirtual
GetAsOsString() const overrideHazelnp::StringValuevirtual
GetDataType() constHazelnp::Value
GetFloat32() const overrideHazelnp::StringValuevirtual
GetFloat64() const overrideHazelnp::StringValuevirtual
GetInt32() const overrideHazelnp::StringValuevirtual
GetInt64() const overrideHazelnp::StringValuevirtual
GetList() const overrideHazelnp::StringValuevirtual
GetString() const overrideHazelnp::StringValuevirtual
GetValue() constHazelnp::StringValue
operator std::string() constHazelnp::StringValue
StringValue(const std::string &value)Hazelnp::StringValue
typeHazelnp::Valueprotected
Value(DATA_TYPE type)Hazelnp::Valueprotected
~StringValue() overrideHazelnp::StringValueinline
~Value()Hazelnp::Valueinlinevirtual
+ + + + diff --git a/docs/classHazelnp_1_1StringValue.html b/docs/classHazelnp_1_1StringValue.html new file mode 100644 index 0000000..33bb35c --- /dev/null +++ b/docs/classHazelnp_1_1StringValue.html @@ -0,0 +1,555 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::StringValue Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::StringValue Class Reference
+
+
+ +

Specializations for string values (uses std::string) + More...

+ +

#include <StringValue.h>

+
+Inheritance diagram for Hazelnp::StringValue:
+
+
Inheritance graph
+ + + + +
[legend]
+
+Collaboration diagram for Hazelnp::StringValue:
+
+
Collaboration graph
+ + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 StringValue (const std::string &value)
 
 ~StringValue () override
 
ValueDeepcopy () const override
 Will return a deeopopy of this object. More...
 
std::string GetAsOsString () const override
 Will return a string suitable for an std::ostream;. More...
 
const std::string & GetValue () const
 Will return the raw value. More...
 
 operator std::string () const
 
long long int GetInt64 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
int GetInt32 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
long double GetFloat64 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
double GetFloat32 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
std::string GetString () const override
 Will return this value as a string. More...
 
const std::vector< Value * > & GetList () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
- Public Member Functions inherited from Hazelnp::Value
virtual ~Value ()
 
DATA_TYPE GetDataType () const
 Will return the data type of this value. More...
 
+ + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from Hazelnp::Value
 Value (DATA_TYPE type)
 
- Protected Attributes inherited from Hazelnp::Value
DATA_TYPE type
 
+

Detailed Description

+

Specializations for string values (uses std::string)

+ +

Definition at line 9 of file StringValue.h.

+

Constructor & Destructor Documentation

+ +

◆ StringValue()

+ +
+
+ + + + + + + + +
StringValue::StringValue (const std::string & value)
+
+ +

Definition at line 7 of file StringValue.cpp.

+
8  :
+ +
10  value { value }
+
11 {
+
12  return;
+
13 }
+
+
+
+ +

◆ ~StringValue()

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::StringValue::~StringValue ()
+
+inlineoverride
+
+ +

Definition at line 13 of file StringValue.h.

+
13 {};
+
+
+
+

Member Function Documentation

+ +

◆ Deepcopy()

+ +
+
+ + + + + +
+ + + + + + + +
Value * StringValue::Deepcopy () const
+
+overridevirtual
+
+ +

Will return a deeopopy of this object.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 15 of file StringValue.cpp.

+
16 {
+
17  return new StringValue(value);
+
18 }
+
+
+
+ +

◆ GetAsOsString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string StringValue::GetAsOsString () const
+
+overridevirtual
+
+ +

Will return a string suitable for an std::ostream;.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 20 of file StringValue.cpp.

+
21 {
+
22  std::stringstream ss;
+
23  ss << "StringValue: " << value;
+
24  return ss.str();
+
25 }
+
+
+
+ +

◆ GetFloat32()

+ +
+
+ + + + + +
+ + + + + + + +
double StringValue::GetFloat32 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 54 of file StringValue.cpp.

+
55 {
+ +
57 }
+
+
+
+ +

◆ GetFloat64()

+ +
+
+ + + + + +
+ + + + + + + +
long double StringValue::GetFloat64 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 49 of file StringValue.cpp.

+
50 {
+ +
52 }
+
+
+
+ +

◆ GetInt32()

+ +
+
+ + + + + +
+ + + + + + + +
int StringValue::GetInt32 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 44 of file StringValue.cpp.

+
45 {
+ +
47 }
+
+
+
+ +

◆ GetInt64()

+ +
+
+ + + + + +
+ + + + + + + +
long long int StringValue::GetInt64 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 39 of file StringValue.cpp.

+
40 {
+ +
42 }
+
+
+
+ +

◆ GetList()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Value * > & StringValue::GetList () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 64 of file StringValue.cpp.

+
65 {
+ +
67 }
+
+
+
+ +

◆ GetString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string StringValue::GetString () const
+
+overridevirtual
+
+ +

Will return this value as a string.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 59 of file StringValue.cpp.

+
60 {
+
61  return value;
+
62 }
+
+
+
+ +

◆ GetValue()

+ +
+
+ + + + + + + +
const std::string & StringValue::GetValue () const
+
+ +

Will return the raw value.

+ +

Definition at line 27 of file StringValue.cpp.

+
28 {
+
29  return value;
+
30 }
+
+
+
+ +

◆ operator std::string()

+ +
+
+ + + + + + + +
StringValue::operator std::string () const
+
+ +

Definition at line 32 of file StringValue.cpp.

+
33 {
+
34  return value;
+
35 }
+
+
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::StringValue::StringValue
StringValue(const std::string &value)
Definition: StringValue.cpp:7
+
Hazelnp::Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:5
+
Hazelnp::DATA_TYPE::STRING
@ STRING
+
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_1StringValue__coll__graph.map b/docs/classHazelnp_1_1StringValue__coll__graph.map new file mode 100644 index 0000000..3296184 --- /dev/null +++ b/docs/classHazelnp_1_1StringValue__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1StringValue__coll__graph.md5 b/docs/classHazelnp_1_1StringValue__coll__graph.md5 new file mode 100644 index 0000000..09c0ce8 --- /dev/null +++ b/docs/classHazelnp_1_1StringValue__coll__graph.md5 @@ -0,0 +1 @@ +4997cc0c07834e05bdfd8f7c9c787db0 \ No newline at end of file diff --git a/docs/classHazelnp_1_1StringValue__coll__graph.png b/docs/classHazelnp_1_1StringValue__coll__graph.png new file mode 100644 index 0000000..d04958c Binary files /dev/null and b/docs/classHazelnp_1_1StringValue__coll__graph.png differ diff --git a/docs/classHazelnp_1_1StringValue__inherit__graph.map b/docs/classHazelnp_1_1StringValue__inherit__graph.map new file mode 100644 index 0000000..3296184 --- /dev/null +++ b/docs/classHazelnp_1_1StringValue__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1StringValue__inherit__graph.md5 b/docs/classHazelnp_1_1StringValue__inherit__graph.md5 new file mode 100644 index 0000000..09c0ce8 --- /dev/null +++ b/docs/classHazelnp_1_1StringValue__inherit__graph.md5 @@ -0,0 +1 @@ +4997cc0c07834e05bdfd8f7c9c787db0 \ No newline at end of file diff --git a/docs/classHazelnp_1_1StringValue__inherit__graph.png b/docs/classHazelnp_1_1StringValue__inherit__graph.png new file mode 100644 index 0000000..d04958c Binary files /dev/null and b/docs/classHazelnp_1_1StringValue__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1Value-members.html b/docs/classHazelnp_1_1Value-members.html new file mode 100644 index 0000000..f599f0d --- /dev/null +++ b/docs/classHazelnp_1_1Value-members.html @@ -0,0 +1,105 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::Value Member List
+
+
+ +

This is the complete list of members for Hazelnp::Value, including all inherited members.

+ + + + + + + + + + + + + + +
Deepcopy() const =0Hazelnp::Valuepure virtual
GetAsOsString() const =0Hazelnp::Valuepure virtual
GetDataType() constHazelnp::Value
GetFloat32() const =0Hazelnp::Valuepure virtual
GetFloat64() const =0Hazelnp::Valuepure virtual
GetInt32() const =0Hazelnp::Valuepure virtual
GetInt64() const =0Hazelnp::Valuepure virtual
GetList() const =0Hazelnp::Valuepure virtual
GetString() const =0Hazelnp::Valuepure virtual
operator<<(std::ostream &os, const Value &v)Hazelnp::Valuefriend
typeHazelnp::Valueprotected
Value(DATA_TYPE type)Hazelnp::Valueprotected
~Value()Hazelnp::Valueinlinevirtual
+ + + + diff --git a/docs/classHazelnp_1_1Value.html b/docs/classHazelnp_1_1Value.html new file mode 100644 index 0000000..f94d65b --- /dev/null +++ b/docs/classHazelnp_1_1Value.html @@ -0,0 +1,556 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::Value Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +Protected Attributes | +Friends | +List of all members
+
+
Hazelnp::Value Class Referenceabstract
+
+
+ +

Abstract class for values. + More...

+ +

#include <Value.h>

+
+Inheritance diagram for Hazelnp::Value:
+
+
Inheritance graph
+ + + + + + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

virtual ~Value ()
 
virtual ValueDeepcopy () const =0
 Will return a deeopopy of this object. More...
 
virtual std::string GetAsOsString () const =0
 Will return a string suitable for an std::ostream. More...
 
DATA_TYPE GetDataType () const
 Will return the data type of this value. More...
 
virtual long long int GetInt64 () const =0
 Will attempt to return the integer data (long long) More...
 
virtual int GetInt32 () const =0
 Will attempt to return the integer data (int) More...
 
virtual long double GetFloat64 () const =0
 Will attempt to return the floating-point data (long double) More...
 
virtual double GetFloat32 () const =0
 Will attempt to return the floating-point data (double) More...
 
virtual std::string GetString () const =0
 Will attempt to return the string-data. More...
 
virtual const std::vector< Value * > & GetList () const =0
 Will attempt to return the list-data. More...
 
+ + + +

+Protected Member Functions

 Value (DATA_TYPE type)
 
+ + + +

+Protected Attributes

DATA_TYPE type
 
+ + + +

+Friends

std::ostream & operator<< (std::ostream &os, const Value &v)
 
+

Detailed Description

+

Abstract class for values.

+ +

Definition at line 10 of file Value.h.

+

Constructor & Destructor Documentation

+ +

◆ ~Value()

+ +
+
+ + + + + +
+ + + + + + + +
virtual Hazelnp::Value::~Value ()
+
+inlinevirtual
+
+ +

Definition at line 13 of file Value.h.

+
13 {};
+
+
+
+ +

◆ Value()

+ +
+
+ + + + + +
+ + + + + + + + +
Value::Value (DATA_TYPE type)
+
+protected
+
+ +

Definition at line 5 of file Value.cpp.

+
6  :
+
7  type{ type }
+
8 {
+
9  return;
+
10 }
+
+
+
+

Member Function Documentation

+ +

◆ Deepcopy()

+ +
+
+ + + + + +
+ + + + + + + +
virtual Value* Hazelnp::Value::Deepcopy () const
+
+pure virtual
+
+ +

Will return a deeopopy of this object.

+ +

Implemented in Hazelnp::FloatValue, Hazelnp::ListValue, Hazelnp::StringValue, Hazelnp::IntValue, and Hazelnp::VoidValue.

+ +
+
+ +

◆ GetAsOsString()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string Hazelnp::Value::GetAsOsString () const
+
+pure virtual
+
+ +

Will return a string suitable for an std::ostream.

+ +

Implemented in Hazelnp::FloatValue, Hazelnp::ListValue, Hazelnp::StringValue, Hazelnp::IntValue, and Hazelnp::VoidValue.

+ +
+
+ +

◆ GetDataType()

+ +
+
+ + + + + + + +
DATA_TYPE Value::GetDataType () const
+
+ +

Will return the data type of this value.

+ +

Definition at line 12 of file Value.cpp.

+
13 {
+
14  return type;
+
15 }
+
+
+
+ +

◆ GetFloat32()

+ +
+
+ + + + + +
+ + + + + + + +
virtual double Hazelnp::Value::GetFloat32 () const
+
+pure virtual
+
+ +

Will attempt to return the floating-point data (double)

+ +

Implemented in Hazelnp::ListValue, Hazelnp::FloatValue, Hazelnp::IntValue, Hazelnp::StringValue, and Hazelnp::VoidValue.

+ +
+
+ +

◆ GetFloat64()

+ +
+
+ + + + + +
+ + + + + + + +
virtual long double Hazelnp::Value::GetFloat64 () const
+
+pure virtual
+
+ +

Will attempt to return the floating-point data (long double)

+ +

Implemented in Hazelnp::ListValue, Hazelnp::FloatValue, Hazelnp::IntValue, Hazelnp::StringValue, and Hazelnp::VoidValue.

+ +
+
+ +

◆ GetInt32()

+ +
+
+ + + + + +
+ + + + + + + +
virtual int Hazelnp::Value::GetInt32 () const
+
+pure virtual
+
+ +

Will attempt to return the integer data (int)

+ +

Implemented in Hazelnp::ListValue, Hazelnp::FloatValue, Hazelnp::IntValue, Hazelnp::StringValue, and Hazelnp::VoidValue.

+ +
+
+ +

◆ GetInt64()

+ +
+
+ + + + + +
+ + + + + + + +
virtual long long int Hazelnp::Value::GetInt64 () const
+
+pure virtual
+
+ +

Will attempt to return the integer data (long long)

+ +

Implemented in Hazelnp::ListValue, Hazelnp::FloatValue, Hazelnp::IntValue, Hazelnp::StringValue, and Hazelnp::VoidValue.

+ +
+
+ +

◆ GetList()

+ +
+
+ + + + + +
+ + + + + + + +
virtual const std::vector<Value*>& Hazelnp::Value::GetList () const
+
+pure virtual
+
+ +

Will attempt to return the list-data.

+ +

Implemented in Hazelnp::ListValue, Hazelnp::FloatValue, Hazelnp::IntValue, Hazelnp::StringValue, and Hazelnp::VoidValue.

+ +
+
+ +

◆ GetString()

+ +
+
+ + + + + +
+ + + + + + + +
virtual std::string Hazelnp::Value::GetString () const
+
+pure virtual
+
+ +

Will attempt to return the string-data.

+ +

Implemented in Hazelnp::ListValue, Hazelnp::FloatValue, Hazelnp::IntValue, Hazelnp::StringValue, and Hazelnp::VoidValue.

+ +
+
+

Friends And Related Function Documentation

+ +

◆ operator<<

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
std::ostream& operator<< (std::ostream & os,
const Valuev 
)
+
+friend
+
+ +

Definition at line 24 of file Value.h.

+
25  {
+
26  return os << v.GetAsOsString();
+
27  }
+
+
+
+

Member Data Documentation

+ +

◆ type

+ +
+
+ + + + + +
+ + + + +
DATA_TYPE Hazelnp::Value::type
+
+protected
+
+ +

Definition at line 48 of file Value.h.

+ +
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::Value::type
DATA_TYPE type
Definition: Value.h:48
+ + + + diff --git a/docs/classHazelnp_1_1Value__inherit__graph.map b/docs/classHazelnp_1_1Value__inherit__graph.map new file mode 100644 index 0000000..d1f45d5 --- /dev/null +++ b/docs/classHazelnp_1_1Value__inherit__graph.map @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/classHazelnp_1_1Value__inherit__graph.md5 b/docs/classHazelnp_1_1Value__inherit__graph.md5 new file mode 100644 index 0000000..806245e --- /dev/null +++ b/docs/classHazelnp_1_1Value__inherit__graph.md5 @@ -0,0 +1 @@ +8c449cea971b5762dc13a0d94fcc64bd \ No newline at end of file diff --git a/docs/classHazelnp_1_1Value__inherit__graph.png b/docs/classHazelnp_1_1Value__inherit__graph.png new file mode 100644 index 0000000..fe2031a Binary files /dev/null and b/docs/classHazelnp_1_1Value__inherit__graph.png differ diff --git a/docs/classHazelnp_1_1VoidValue-members.html b/docs/classHazelnp_1_1VoidValue-members.html new file mode 100644 index 0000000..6e3f5af --- /dev/null +++ b/docs/classHazelnp_1_1VoidValue-members.html @@ -0,0 +1,106 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::VoidValue Member List
+
+
+ +

This is the complete list of members for Hazelnp::VoidValue, including all inherited members.

+ + + + + + + + + + + + + + + +
Deepcopy() const overrideHazelnp::VoidValuevirtual
GetAsOsString() const overrideHazelnp::VoidValuevirtual
GetDataType() constHazelnp::Value
GetFloat32() const overrideHazelnp::VoidValuevirtual
GetFloat64() const overrideHazelnp::VoidValuevirtual
GetInt32() const overrideHazelnp::VoidValuevirtual
GetInt64() const overrideHazelnp::VoidValuevirtual
GetList() constHazelnp::VoidValuevirtual
GetString() const overrideHazelnp::VoidValuevirtual
typeHazelnp::Valueprotected
Value(DATA_TYPE type)Hazelnp::Valueprotected
VoidValue()Hazelnp::VoidValue
~Value()Hazelnp::Valueinlinevirtual
~VoidValue() overrideHazelnp::VoidValueinline
+ + + + diff --git a/docs/classHazelnp_1_1VoidValue.html b/docs/classHazelnp_1_1VoidValue.html new file mode 100644 index 0000000..c066260 --- /dev/null +++ b/docs/classHazelnp_1_1VoidValue.html @@ -0,0 +1,501 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::VoidValue Class Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Hazelnp::VoidValue Class Reference
+
+
+ +

Specializations for void values. + More...

+ +

#include <VoidValue.h>

+
+Inheritance diagram for Hazelnp::VoidValue:
+
+
Inheritance graph
+ + + + +
[legend]
+
+Collaboration diagram for Hazelnp::VoidValue:
+
+
Collaboration graph
+ + + + +
[legend]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 VoidValue ()
 
 ~VoidValue () override
 
ValueDeepcopy () const override
 Will return a deeopopy of this object. More...
 
std::string GetAsOsString () const override
 Will return a string suitable for an std::ostream;. More...
 
long long int GetInt64 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
int GetInt32 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
long double GetFloat64 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
double GetFloat32 () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
std::string GetString () const override
 Throws HazelnuppValueNotConvertibleException. More...
 
const std::vector< Value * > & GetList () const
 Throws HazelnuppValueNotConvertibleException. More...
 
- Public Member Functions inherited from Hazelnp::Value
virtual ~Value ()
 
DATA_TYPE GetDataType () const
 Will return the data type of this value. More...
 
+ + + + + + + +

+Additional Inherited Members

- Protected Member Functions inherited from Hazelnp::Value
 Value (DATA_TYPE type)
 
- Protected Attributes inherited from Hazelnp::Value
DATA_TYPE type
 
+

Detailed Description

+

Specializations for void values.

+

These house no value whatsoever, but only communicate information by merely existing.

+ +

Definition at line 8 of file VoidValue.h.

+

Constructor & Destructor Documentation

+ +

◆ VoidValue()

+ +
+
+ + + + + + + +
VoidValue::VoidValue ()
+
+ +

Definition at line 6 of file VoidValue.cpp.

+
7  :
+ +
9 {
+
10  return;
+
11 }
+
+
+
+ +

◆ ~VoidValue()

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::VoidValue::~VoidValue ()
+
+inlineoverride
+
+ +

Definition at line 12 of file VoidValue.h.

+
12 {};
+
+
+
+

Member Function Documentation

+ +

◆ Deepcopy()

+ +
+
+ + + + + +
+ + + + + + + +
Value * VoidValue::Deepcopy () const
+
+overridevirtual
+
+ +

Will return a deeopopy of this object.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 13 of file VoidValue.cpp.

+
14 {
+
15  return new VoidValue();
+
16 }
+
+
+
+ +

◆ GetAsOsString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string VoidValue::GetAsOsString () const
+
+overridevirtual
+
+ +

Will return a string suitable for an std::ostream;.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 18 of file VoidValue.cpp.

+
19 {
+
20  return "VoidValue";
+
21 }
+
+
+
+ +

◆ GetFloat32()

+ +
+
+ + + + + +
+ + + + + + + +
double VoidValue::GetFloat32 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 40 of file VoidValue.cpp.

+
41 {
+ +
43 }
+
+
+
+ +

◆ GetFloat64()

+ +
+
+ + + + + +
+ + + + + + + +
long double VoidValue::GetFloat64 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 35 of file VoidValue.cpp.

+
36 {
+ +
38 }
+
+
+
+ +

◆ GetInt32()

+ +
+
+ + + + + +
+ + + + + + + +
int VoidValue::GetInt32 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 30 of file VoidValue.cpp.

+
31 {
+ +
33 }
+
+
+
+ +

◆ GetInt64()

+ +
+
+ + + + + +
+ + + + + + + +
long long int VoidValue::GetInt64 () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 25 of file VoidValue.cpp.

+
26 {
+ +
28 }
+
+
+
+ +

◆ GetList()

+ +
+
+ + + + + +
+ + + + + + + +
const std::vector< Value * > & VoidValue::GetList () const
+
+virtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 50 of file VoidValue.cpp.

+
51 {
+ +
53 }
+
+
+
+ +

◆ GetString()

+ +
+
+ + + + + +
+ + + + + + + +
std::string VoidValue::GetString () const
+
+overridevirtual
+
+ +

Throws HazelnuppValueNotConvertibleException.

+ +

Implements Hazelnp::Value.

+ +

Definition at line 45 of file VoidValue.cpp.

+
46 {
+ +
48 }
+
+
+
+
The documentation for this class was generated from the following files: +
+
Hazelnp::DATA_TYPE::VOID
@ VOID
+
Hazelnp::Value::Value
Value(DATA_TYPE type)
Definition: Value.cpp:5
+
Hazelnp::VoidValue::VoidValue
VoidValue()
Definition: VoidValue.cpp:6
+
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_1VoidValue__coll__graph.map b/docs/classHazelnp_1_1VoidValue__coll__graph.map new file mode 100644 index 0000000..684c89f --- /dev/null +++ b/docs/classHazelnp_1_1VoidValue__coll__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1VoidValue__coll__graph.md5 b/docs/classHazelnp_1_1VoidValue__coll__graph.md5 new file mode 100644 index 0000000..8e50936 --- /dev/null +++ b/docs/classHazelnp_1_1VoidValue__coll__graph.md5 @@ -0,0 +1 @@ +906e2b64b26f1d1be0180b938b6a9e45 \ No newline at end of file diff --git a/docs/classHazelnp_1_1VoidValue__coll__graph.png b/docs/classHazelnp_1_1VoidValue__coll__graph.png new file mode 100644 index 0000000..abca5b1 Binary files /dev/null and b/docs/classHazelnp_1_1VoidValue__coll__graph.png differ diff --git a/docs/classHazelnp_1_1VoidValue__inherit__graph.map b/docs/classHazelnp_1_1VoidValue__inherit__graph.map new file mode 100644 index 0000000..684c89f --- /dev/null +++ b/docs/classHazelnp_1_1VoidValue__inherit__graph.map @@ -0,0 +1,4 @@ + + + + diff --git a/docs/classHazelnp_1_1VoidValue__inherit__graph.md5 b/docs/classHazelnp_1_1VoidValue__inherit__graph.md5 new file mode 100644 index 0000000..8e50936 --- /dev/null +++ b/docs/classHazelnp_1_1VoidValue__inherit__graph.md5 @@ -0,0 +1 @@ +906e2b64b26f1d1be0180b938b6a9e45 \ No newline at end of file diff --git a/docs/classHazelnp_1_1VoidValue__inherit__graph.png b/docs/classHazelnp_1_1VoidValue__inherit__graph.png new file mode 100644 index 0000000..abca5b1 Binary files /dev/null and b/docs/classHazelnp_1_1VoidValue__inherit__graph.png differ diff --git a/docs/classes.html b/docs/classes.html index 4b8568e..a676677 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -78,40 +78,40 @@ $(function() { - + - + - + - - - - + + + + - + - - + + - + - + - - - + + + - +
  f  
HazelnuppConstraintException   HazelnuppConstraintException (Hazelnp)   
  i  
  p  
StringValue   StringValue (Hazelnp)   
HazelnuppConstraintMissingValue   
HazelnuppConstraintMissingValue (Hazelnp)   
  v  
FloatValue   HazelnuppConstraintTypeMissmatch   IntValue   ParamConstraint   
FloatValue (Hazelnp)   HazelnuppConstraintTypeMissmatch (Hazelnp)   IntValue (Hazelnp)   ParamConstraint (Hazelnp)   
  h  
HazelnuppException   HazelnuppException (Hazelnp)   
  l  
Parameter   Value   Parameter (Hazelnp)   Value (Hazelnp)   
HazelnuppInvalidKeyException   
HazelnuppInvalidKeyException (Hazelnp)   
  s  
VoidValue   VoidValue (Hazelnp)   
Hazelnupp   HazelnuppValueNotConvertibleException   ListValue   
Hazelnupp (Hazelnp)   HazelnuppValueNotConvertibleException (Hazelnp)   ListValue (Hazelnp)   
StringTools   
StringTools (Hazelnp)   
@@ -119,7 +119,7 @@ $(function() { diff --git a/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html b/docs/dir_0202e1e26df2e040f4dc3d434eecf04c.html index 55dd772..33ad36e 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 93ce022..f346fae 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 4513d6e..1848835 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 724bb46..b3346c8 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 e36eb98..992ca35 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 f197558..e28ca04 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -74,333 +74,333 @@ $(function() {

- a -

- c -

- d -

- f -

- g -

- h -

- i -

- k -

- l -

- m -

- o -

- p -

- r -

- s -

- t -

- v -

- w -

- ~ -

diff --git a/docs/functions_func.html b/docs/functions_func.html index 323c228..f88c8a2 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -74,304 +74,304 @@ $(function() {

- a -

- c -

- d -

- f -

- g -

- h -

- i -

- k -

- l -

- o -

- p -

- r -

- s -

- t -

- v -

- w -

- ~ -

diff --git a/docs/functions_rela.html b/docs/functions_rela.html index c19da44..9ef9c62 100644 --- a/docs/functions_rela.html +++ b/docs/functions_rela.html @@ -72,14 +72,14 @@ $(function() {
 
diff --git a/docs/functions_vars.html b/docs/functions_vars.html index 5b5a23a..f1ccee6 100644 --- a/docs/functions_vars.html +++ b/docs/functions_vars.html @@ -72,31 +72,31 @@ $(function() {
 
diff --git a/docs/globals.html b/docs/globals.html index c2d87eb..d609643 100644 --- a/docs/globals.html +++ b/docs/globals.html @@ -71,9 +71,6 @@ $(function() {
Here is a list of all file members with links to the files they belong to:
diff --git a/docs/globals_func.html b/docs/globals_func.html index aaf8e66..5251efb 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 5f5d4e7..69bf1a6 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 99dbae8..4010523 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -79,28 +79,28 @@ $(function() { This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 1234]
- - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +
 Cstd::exceptionSTL class
 CHazelnuppExceptionGeneric hazelnupp exception
 CHazelnuppConstraintExceptionGets thrown something bad happens because of parameter constraints
 CHazelnuppConstraintMissingValueGets thrown when a parameter constrained to be required is not provided, and has no default value set
 CHazelnuppConstraintTypeMissmatchGets thrown when a parameter is of a type that does not match the required type, and is not convertible to it
 CHazelnuppInvalidKeyExceptionGets thrown when an non-existent key gets dereferenced
 CHazelnuppValueNotConvertibleExceptionGets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible
 CHazelnuppThe main class to interface with
 CParamConstraint
 CParameter
 CStringToolsInternal helper class
 CValueAbstract class for values
 CFloatValueSpecializations for floating point values (uses long double)
 CIntValueSpecializations for integer values (uses long long int)
 CListValueSpecializations for list values (uses std::vector<Value*>)
 CStringValueSpecializations for string values (uses std::string)
 CVoidValueSpecializations for void values
 CHazelnp::HazelnuppExceptionGeneric hazelnupp exception
 CHazelnp::HazelnuppConstraintExceptionGets thrown something bad happens because of parameter constraints
 CHazelnp::HazelnuppConstraintMissingValueGets thrown when a parameter constrained to be required is not provided, and has no default value set
 CHazelnp::HazelnuppConstraintTypeMissmatchGets thrown when a parameter is of a type that does not match the required type, and is not convertible to it
 CHazelnp::HazelnuppInvalidKeyExceptionGets thrown when an non-existent key gets dereferenced
 CHazelnp::HazelnuppValueNotConvertibleExceptionGets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible
 CHazelnp::HazelnuppThe main class to interface with
 CHazelnp::ParamConstraint
 CHazelnp::Parameter
 CHazelnp::StringToolsInternal helper class
 CHazelnp::ValueAbstract class for values
 CHazelnp::FloatValueSpecializations for floating point values (uses long double)
 CHazelnp::IntValueSpecializations for integer values (uses long long int)
 CHazelnp::ListValueSpecializations for list values (uses std::vector<Value*>)
 CHazelnp::StringValueSpecializations for string values (uses std::string)
 CHazelnp::VoidValueSpecializations for void values
diff --git a/docs/index.html b/docs/index.html index 67fdd8a..c5a4f02 100644 --- a/docs/index.html +++ b/docs/index.html @@ -71,11 +71,11 @@ $(function() {
+
Hazelnupp

is a simple, easy to use command line parameter parser.
- Hazelnupp does not support windows-, or bsd-style arguments. Only linux-style.
+ Hazelnupp does not support windows-, or bsd-style arguments. Only linux-style.

What is the linux-style? This:

# Using a long parameter
a.out --long-parameter 1234
@@ -84,8 +84,8 @@ $(function() {

Note

These examples reference exceptions. These are not enabled by default. The default behaviour for user-fault exceptions is to produce output to stderr and kill the process.
- To enable exceptions, call this method:

Hazelnupp args;
-
args.SetCrashOnFail(false);
+ To enable exceptions, call this method:

Hazelnupp args;
+
args.SetCrashOnFail(false);

Importing into a project

@@ -124,13 +124,13 @@ What's the concept?

These parameters can then be accessed via a simple lookup!

Minimal working example

-

So what's the simplest way to use Hazelnupp to work with command-line parameters? See:

#include "Hazelnupp.h"
+

So what's the simplest way to use Hazelnupp to work with command-line parameters? See:

#include "Hazelnupp.h"
int main(int argc, char** argv)
{
-
Hazelnupp args(argc, argv);
+
Hazelnupp args(argc, argv);
-
if (args.HasParam("--force"))
+
if (args.HasParam("--force"))
// do forced
else
// be gentle
@@ -141,7 +141,7 @@ Minimal working example
int main(int argc, char** argv)
{
-
Hazelnupp args(argc, argv);
+
Hazelnupp args(argc, argv);
// Either check via HasParam(), or do a try-catch
try
@@ -150,7 +150,7 @@ Minimal working example
double myInt = args["--my-float"].GetFloat32();
std::string myStr = args["--my-string"].GetString();
}
- +
catch (HazelnuppInvalidKeyException&)
{
return -1;
}
@@ -161,7 +161,7 @@ Minimal working example
int main(int argc, char** argv)
{
-
Hazelnupp args(argc, argv);
+
Hazelnupp args(argc, argv);
const auto& myList = args["--my-list"].GetList(); // std::vector<Value*>
@@ -175,19 +175,19 @@ Minimal working example
}

Abbreviations

-

Abbreviations are a very important part of command line arguments. Like, typing -f instead of --force. Here's how to use them in Hazelnupp:

#include "Hazelnupp.h"
+

Abbreviations are a very important part of command line arguments. Like, typing -f instead of --force. Here's how to use them in Hazelnupp:

#include "Hazelnupp.h"
int main(int argc, char** argv)
{
-
Hazelnupp args;
+
Hazelnupp args;
// Register abbreviations
-
args.RegisterAbbreviation("-f", "--force");
+
args.RegisterAbbreviation("-f", "--force");
// Parse
-
args.Parse(argc, argv);
+
args.Parse(argc, argv);
-
if (args.HasParam("--force")) // This key will be present, even if the user passed '-f'
+
if (args.HasParam("--force")) // This key will be present, even if the user passed '-f'
// do forced
else
// be gentle
@@ -202,7 +202,7 @@ Constraints

For exactly this reason, there are constraints. With this, you can control what the data looks like! Constraints serve two main purposes:

Requiring data

-

With ParamConstraint::Require() you can declare that a paramater must either always be present, or provide a default value.
+

With ParamConstraint::Require() you can declare that a paramater must either always be present, or provide a default value.

  • If a parameter is not present, but has a default value, it will be automatically created.
  • If a parameter is not present, and has no default value, an exception will be thrown.
  • @@ -211,23 +211,23 @@ Requiring data
    int main(int argc, char** argv)
    {
    -
    Hazelnupp args;
    +
    Hazelnupp args;
    // Register constraints
    - -
    ParamConstraint::Require("--this-is-required"), // This missing throws an exception
    -
    ParamConstraint::Require("--also-required-but-defaulted", {"122"}), // This will default to 122
    +
    args.RegisterConstraints({
    +
    ParamConstraint::Require("--this-is-required"), // This missing throws an exception
    +
    ParamConstraint::Require("--also-required-but-defaulted", {"122"}), // This will default to 122
    });
    // Parse
    -
    args.Parse(argc, argv);
    +
    args.Parse(argc, argv);
    return 0;
    }

Type safety

With type safety you can always be certain that you are working with the correct type!
- By creating a type-constraint you force Hazelnupp to use a certain type.
+ By creating a type-constraint you force Hazelnupp to use a certain type.
If a supplied type does not match, but is convertible, it will be converted.
If it is not convertible, an exception will be thrown.

These conversions are:

    @@ -243,33 +243,33 @@ Type safety
    int main(int argc, char** argv)
    {
    -
    Hazelnupp args;
    +
    Hazelnupp args;
    // Register constraints
    - - +
    args.RegisterConstraints({
    +
    ParamConstraint::TypeSafety("--this-must-be-int", DATA_TYPE::INT)
    });
    // Parse
    -
    args.Parse(argc, argv);
    +
    args.Parse(argc, argv);
    return 0;
    }

If --this-must-be-int would be passed as a float, it would be converted to int. If it was passed, for example, as a string, it would throw an exception.


-

Note that you can also combine these two constraint-types by populating the struct yourself:

-
pc.key = "--my-key";
-
pc.constrainType = true;
- -
pc.defaultValue = {}; // no default value
-
pc.required = true;
+

Note that you can also combine these two constraint-types by populating the struct yourself:

ParamConstraint pc;
+
pc.key = "--my-key";
+
pc.constrainType = true;
+
pc.wantedType = DATA_TYPE::STRING;
+
pc.defaultValue = {}; // no default value
+
pc.required = true;
- +
args.RegisterConstraints({pc});

What doesn't work is inserting multiple constraints for one key. It will just discard the oldest one. But that's okay because one can describe all possible constraints for a single key in one struct.

More examples?

Check out the unit tests! They may help you out!
- Also make sure to check out the doxygen docs!

+ Also make sure to check out the doxygen docs!

Further notes

This is still in alpha! There is no guarantee at all that this actually works.
@@ -295,28 +295,11 @@ LICENSE

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:330
-
ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:64
-
Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:352
-
ParamConstraint::TypeSafety
static ParamConstraint TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)
Constructs a type-safety constraint.
Definition: ParamConstraint.h:25
-
main
int main(int argc, char **argv)
Definition: main.cpp:5
-
ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:60
-
DATA_TYPE::INT
@ INT
-
ParamConstraint::Require
static ParamConstraint Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)
Constructs a require constraint.
Definition: ParamConstraint.h:14
-
ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:48
+
main
int main(int argc, char **argv)
Definition: main.cpp:7
Hazelnupp.h
-
HazelnuppInvalidKeyException
Gets thrown when an non-existent key gets dereferenced.
Definition: HazelnuppException.h:24
-
Hazelnupp::SetCrashOnFail
void SetCrashOnFail(bool crashOnFail)
Sets whether to crash the application, and print to stderr, when an exception is raised whilst parsin...
Definition: Hazelnupp.cpp:379
-
Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:151
-
ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:52
-
DATA_TYPE::STRING
@ STRING
-
ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:55
-
Hazelnupp
The main class to interface with.
Definition: Hazelnupp.h:9
-
ParamConstraint
Definition: ParamConstraint.h:6
-
Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:33
diff --git a/docs/index_8md.html b/docs/index_8md.html index be5e7cb..7fada0c 100644 --- a/docs/index_8md.html +++ b/docs/index_8md.html @@ -77,7 +77,7 @@ $(function() { diff --git a/docs/inherit_graph_0.map b/docs/inherit_graph_0.map index 9741c9e..7d45561 100644 --- a/docs/inherit_graph_0.map +++ b/docs/inherit_graph_0.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_0.md5 b/docs/inherit_graph_0.md5 index 232c3e6..ee20c76 100644 --- a/docs/inherit_graph_0.md5 +++ b/docs/inherit_graph_0.md5 @@ -1 +1 @@ -05f5fbf778280a49be054f37088fe987 \ No newline at end of file +f47a2c7011f1310cd8570b2c41da9627 \ No newline at end of file diff --git a/docs/inherit_graph_0.png b/docs/inherit_graph_0.png index 8b3ae89..72d4369 100644 Binary files a/docs/inherit_graph_0.png and b/docs/inherit_graph_0.png differ diff --git a/docs/inherit_graph_1.map b/docs/inherit_graph_1.map index bbbbf01..543bbec 100644 --- a/docs/inherit_graph_1.map +++ b/docs/inherit_graph_1.map @@ -1,9 +1,9 @@ - - - - - - - + + + + + + + diff --git a/docs/inherit_graph_1.md5 b/docs/inherit_graph_1.md5 index 9fcad0b..6543f74 100644 --- a/docs/inherit_graph_1.md5 +++ b/docs/inherit_graph_1.md5 @@ -1 +1 @@ -11f045deeaf9a601d5ad34a79967a0f9 \ No newline at end of file +86946d00981da1d932b71231e74d4918 \ No newline at end of file diff --git a/docs/inherit_graph_1.png b/docs/inherit_graph_1.png index 827eff2..f28e203 100644 Binary files a/docs/inherit_graph_1.png and b/docs/inherit_graph_1.png differ diff --git a/docs/inherit_graph_2.map b/docs/inherit_graph_2.map index 67e54a1..28dcc03 100644 --- a/docs/inherit_graph_2.map +++ b/docs/inherit_graph_2.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_2.md5 b/docs/inherit_graph_2.md5 index 3373ae5..b80eac4 100644 --- a/docs/inherit_graph_2.md5 +++ b/docs/inherit_graph_2.md5 @@ -1 +1 @@ -192546f8044e385dcb4e1aca18ebe513 \ No newline at end of file +4f0b35bc688eabf2cb9ac18b4e4afbc3 \ No newline at end of file diff --git a/docs/inherit_graph_2.png b/docs/inherit_graph_2.png index 7cac96f..1282d1d 100644 Binary files a/docs/inherit_graph_2.png and b/docs/inherit_graph_2.png differ diff --git a/docs/inherit_graph_3.map b/docs/inherit_graph_3.map index b155a08..d7e3fbb 100644 --- a/docs/inherit_graph_3.map +++ b/docs/inherit_graph_3.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_3.md5 b/docs/inherit_graph_3.md5 index 308f1f7..fd7dc51 100644 --- a/docs/inherit_graph_3.md5 +++ b/docs/inherit_graph_3.md5 @@ -1 +1 @@ -6481c4409a2d34d7347ae0ab04e39488 \ No newline at end of file +3396960537c122b0b3247a767ac311f4 \ No newline at end of file diff --git a/docs/inherit_graph_3.png b/docs/inherit_graph_3.png index 15e18f4..a1f8985 100644 Binary files a/docs/inherit_graph_3.png and b/docs/inherit_graph_3.png differ diff --git a/docs/inherit_graph_4.map b/docs/inherit_graph_4.map index 1a5cc03..c39bd88 100644 --- a/docs/inherit_graph_4.map +++ b/docs/inherit_graph_4.map @@ -1,3 +1,3 @@ - + diff --git a/docs/inherit_graph_4.md5 b/docs/inherit_graph_4.md5 index 86dc5ad..b9f2b56 100644 --- a/docs/inherit_graph_4.md5 +++ b/docs/inherit_graph_4.md5 @@ -1 +1 @@ -c74d2ba194164b7d25404563e65b9801 \ No newline at end of file +6342d44ad7883eecc3d02ecc59236d50 \ No newline at end of file diff --git a/docs/inherit_graph_4.png b/docs/inherit_graph_4.png index 8b0046f..424df9f 100644 Binary files a/docs/inherit_graph_4.png and b/docs/inherit_graph_4.png differ diff --git a/docs/inherit_graph_5.map b/docs/inherit_graph_5.map index 262f085..29d72ae 100644 --- a/docs/inherit_graph_5.map +++ b/docs/inherit_graph_5.map @@ -1,8 +1,8 @@ - - - - - - + + + + + + diff --git a/docs/inherit_graph_5.md5 b/docs/inherit_graph_5.md5 index 8306c47..7583c18 100644 --- a/docs/inherit_graph_5.md5 +++ b/docs/inherit_graph_5.md5 @@ -1 +1 @@ -62f776d5de34d54281012fb34d2f62cc \ No newline at end of file +7e4a693e66d05f2ee8664e3ea22c9807 \ No newline at end of file diff --git a/docs/inherit_graph_5.png b/docs/inherit_graph_5.png index a1ae793..be7a7d7 100644 Binary files a/docs/inherit_graph_5.png and b/docs/inherit_graph_5.png differ diff --git a/docs/inherits.html b/docs/inherits.html index cb18cf9..d946ad0 100644 --- a/docs/inherits.html +++ b/docs/inherits.html @@ -77,52 +77,52 @@ $(function() {

Go to the textual class hierarchy

- - - - - -
- - +
+ +
- - - - - - - - +
+ + + + + + + +
- - +
+ +
- - +
+ +
- - +
+ +
- - - - - - - +
+ + + + + + +
diff --git a/docs/main_8cpp.html b/docs/main_8cpp.html index cc2a642..836c38b 100644 --- a/docs/main_8cpp.html +++ b/docs/main_8cpp.html @@ -137,81 +137,80 @@ Functions
-

Definition at line 5 of file main.cpp.

-
6 {
-
7  while (1)
-
8  {
-
9  // Mock command-line params
-
10  std::vector<const char*> testArgv = {
-
11  "meinpfad",
-
12  "-w",
-
13  "-99",
-
14  "--alfred",
-
15  "apfel",
-
16  "banane",
-
17  "triangle",
-
18  "--numbers",
-
19  "1",
-
20  "2",
-
21  "3",
-
22  "4",
-
23  "5",
-
24  };
-
25 
-
26  argc = testArgv.size();
-
27  argv = const_cast<char**>(testArgv.data());
-
28 
-
29  // Prepare Hazelnupp parser
-
30  Hazelnupp args;
-
31 
-
32  ParamConstraint pc;
-
33  pc.key = "--alfredo";
-
34  pc.constrainType = true;
- -
36  pc.required = true;
-
37  pc.defaultValue = { "coca cola", "fanta" };
-
38 
-
39  args.RegisterConstraints({
-
40  pc
-
41  });
-
42 
-
43  args.RegisterAbbreviation("-w", "--word");
+

Definition at line 7 of file main.cpp.

+
8 {
+
9  while (1)
+
10  {
+
11  // Mock command-line params
+
12  std::vector<const char*> testArgv = {
+
13  "meinpfad",
+
14  "-w",
+
15  "-99",
+
16  "--alfred",
+
17  "apfel",
+
18  "banane",
+
19  "triangle",
+
20  "--numbers",
+
21  "1",
+
22  "2",
+
23  "3",
+
24  "4",
+
25  "5",
+
26  };
+
27 
+
28  argc = testArgv.size();
+
29  argv = const_cast<char**>(testArgv.data());
+
30 
+
31  // Prepare Hazelnupp parser
+
32  Hazelnupp args;
+
33 
+
34  ParamConstraint pc;
+
35  pc.key = "--alfredo";
+
36  pc.constrainType = true;
+
37  pc.wantedType = DATA_TYPE::LIST;
+
38  pc.required = true;
+
39  pc.defaultValue = { "coca cola", "fanta" };
+
40 
+
41  args.RegisterConstraints({
+
42  pc
+
43  });
44 
-
45  // Parse
-
46  args.Parse(argc, argv);
-
47 
-
48  // Use
-
49  if (args.HasParam("--alfredo"))
-
50  {
-
51  std::cout << args["--alfredo"].GetInt32() << std::endl;
-
52  }
-
53  else
-
54  {
-
55  std::cout << "No --alfredo!" << std::endl;
-
56  }
-
57  }
-
58 
-
59  return 0;
-
60 }
+
45  args.RegisterAbbreviation("-w", "--word");
+
46 
+
47  // Parse
+
48  args.Parse(argc, argv);
+
49 
+
50  // Use
+
51  if (args.HasParam("--alfredo"))
+
52  {
+
53  std::cout << args["--alfredo"].GetInt32() << std::endl;
+
54  }
+
55  else
+
56  {
+
57  std::cout << "No --alfredo!" << std::endl;
+
58  }
+
59  }
+
60 
+
61  return 0;
+
62 }
-
Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:330
-
ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:64
-
Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:352
-
DATA_TYPE::LIST
@ LIST
-
ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:60
-
ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:48
-
Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:151
-
ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:52
-
ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:55
-
Hazelnupp
The main class to interface with.
Definition: Hazelnupp.h:9
-
ParamConstraint
Definition: ParamConstraint.h:6
-
Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:33
+
Hazelnp::Hazelnupp
The main class to interface with.
Definition: Hazelnupp.h:11
+
Hazelnp::ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:57
+
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
+
Hazelnp::Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:153
+
Hazelnp::Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:35
+
Hazelnp::ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:54
+
Hazelnp::Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:332
+
Hazelnp::Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:354
+
Hazelnp::ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:50
+
Hazelnp::ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:66
+
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:62
diff --git a/docs/main_8cpp_source.html b/docs/main_8cpp_source.html index 302509f..5c9ed6e 100644 --- a/docs/main_8cpp_source.html +++ b/docs/main_8cpp_source.html @@ -82,81 +82,84 @@ $(function() {
2 #include "Hazelnupp.h"
3 #include "IntValue.h"
4 
-
5 int main(int argc, char** argv)
-
6 {
-
7  while (1)
-
8  {
-
9  // Mock command-line params
-
10  std::vector<const char*> testArgv = {
-
11  "meinpfad",
-
12  "-w",
-
13  "-99",
-
14  "--alfred",
-
15  "apfel",
-
16  "banane",
-
17  "triangle",
-
18  "--numbers",
-
19  "1",
-
20  "2",
-
21  "3",
-
22  "4",
-
23  "5",
-
24  };
-
25 
-
26  argc = testArgv.size();
-
27  argv = const_cast<char**>(testArgv.data());
-
28 
-
29  // Prepare Hazelnupp parser
-
30  Hazelnupp args;
-
31 
-
32  ParamConstraint pc;
-
33  pc.key = "--alfredo";
-
34  pc.constrainType = true;
-
35  pc.wantedType = DATA_TYPE::LIST;
-
36  pc.required = true;
-
37  pc.defaultValue = { "coca cola", "fanta" };
-
38 
-
39  args.RegisterConstraints({
-
40  pc
-
41  });
-
42 
-
43  args.RegisterAbbreviation("-w", "--word");
+
5 using namespace Hazelnp;
+
6 
+
7 int main(int argc, char** argv)
+
8 {
+
9  while (1)
+
10  {
+
11  // Mock command-line params
+
12  std::vector<const char*> testArgv = {
+
13  "meinpfad",
+
14  "-w",
+
15  "-99",
+
16  "--alfred",
+
17  "apfel",
+
18  "banane",
+
19  "triangle",
+
20  "--numbers",
+
21  "1",
+
22  "2",
+
23  "3",
+
24  "4",
+
25  "5",
+
26  };
+
27 
+
28  argc = testArgv.size();
+
29  argv = const_cast<char**>(testArgv.data());
+
30 
+
31  // Prepare Hazelnupp parser
+
32  Hazelnupp args;
+
33 
+
34  ParamConstraint pc;
+
35  pc.key = "--alfredo";
+
36  pc.constrainType = true;
+
37  pc.wantedType = DATA_TYPE::LIST;
+
38  pc.required = true;
+
39  pc.defaultValue = { "coca cola", "fanta" };
+
40 
+
41  args.RegisterConstraints({
+
42  pc
+
43  });
44 
-
45  // Parse
-
46  args.Parse(argc, argv);
-
47 
-
48  // Use
-
49  if (args.HasParam("--alfredo"))
-
50  {
-
51  std::cout << args["--alfredo"].GetInt32() << std::endl;
-
52  }
-
53  else
-
54  {
-
55  std::cout << "No --alfredo!" << std::endl;
-
56  }
-
57  }
-
58 
-
59  return 0;
-
60 }
+
45  args.RegisterAbbreviation("-w", "--word");
+
46 
+
47  // Parse
+
48  args.Parse(argc, argv);
+
49 
+
50  // Use
+
51  if (args.HasParam("--alfredo"))
+
52  {
+
53  std::cout << args["--alfredo"].GetInt32() << std::endl;
+
54  }
+
55  else
+
56  {
+
57  std::cout << "No --alfredo!" << std::endl;
+
58  }
+
59  }
+
60 
+
61  return 0;
+
62 }
-
Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:330
-
ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:64
-
Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:352
-
DATA_TYPE::LIST
@ LIST
+
Hazelnp
Definition: DataType.h:3
+
Hazelnp::Hazelnupp
The main class to interface with.
Definition: Hazelnupp.h:11
IntValue.h
-
main
int main(int argc, char **argv)
Definition: main.cpp:5
-
ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:60
-
ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:48
+
main
int main(int argc, char **argv)
Definition: main.cpp:7
+
Hazelnp::DATA_TYPE::LIST
@ LIST
+
Hazelnp::ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:57
+
Hazelnp::ParamConstraint
Definition: ParamConstraint.h:8
+
Hazelnp::Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:153
+
Hazelnp::Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:35
+
Hazelnp::ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:54
+
Hazelnp::Hazelnupp::RegisterAbbreviation
void RegisterAbbreviation(const std::string &abbrev, const std::string &target)
Will register an abbreviation (like -f for –force)
Definition: Hazelnupp.cpp:332
+
Hazelnp::Hazelnupp::RegisterConstraints
void RegisterConstraints(const std::vector< ParamConstraint > &constraints)
Will register parameter constraints.
Definition: Hazelnupp.cpp:354
Hazelnupp.h
-
Hazelnupp::HasParam
bool HasParam(const std::string &key) const
Will check wether a parameter exists given a key, or not.
Definition: Hazelnupp.cpp:151
-
ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:52
-
ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:55
-
Hazelnupp
The main class to interface with.
Definition: Hazelnupp.h:9
-
ParamConstraint
Definition: ParamConstraint.h:6
-
Hazelnupp::Parse
void Parse(const int argc, const char *const *argv)
Will parse command line arguments.
Definition: Hazelnupp.cpp:33
+
Hazelnp::ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:50
+
Hazelnp::ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:66
+
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:62
diff --git a/docs/menudata.js b/docs/menudata.js index bfb6993..930d87d 100644 --- a/docs/menudata.js +++ b/docs/menudata.js @@ -22,6 +22,11 @@ for the JavaScript code in this file */ var menudata={children:[ {text:"Main Page",url:"index.html"}, +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}, +{text:"Namespace Members",url:"namespacemembers.html",children:[ +{text:"All",url:"namespacemembers.html"}, +{text:"Enumerations",url:"namespacemembers_enum.html"}]}]}, {text:"Classes",url:"annotated.html",children:[ {text:"Class List",url:"annotated.html"}, {text:"Class Index",url:"classes.html"}, @@ -70,5 +75,4 @@ var menudata={children:[ {text:"File List",url:"files.html"}, {text:"File Members",url:"globals.html",children:[ {text:"All",url:"globals.html"}, -{text:"Functions",url:"globals_func.html"}, -{text:"Enumerations",url:"globals_enum.html"}]}]}]} +{text:"Functions",url:"globals_func.html"}]}]}]} diff --git a/docs/namespaceHazelnp.html b/docs/namespaceHazelnp.html new file mode 100644 index 0000000..922618b --- /dev/null +++ b/docs/namespaceHazelnp.html @@ -0,0 +1,198 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp Namespace Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Classes | +Enumerations
+
+
Hazelnp Namespace Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Classes

class  FloatValue
 Specializations for floating point values (uses long double) More...
 
class  Hazelnupp
 The main class to interface with. More...
 
class  HazelnuppConstraintException
 Gets thrown something bad happens because of parameter constraints. More...
 
class  HazelnuppConstraintMissingValue
 Gets thrown when a parameter constrained to be required is not provided, and has no default value set. More...
 
class  HazelnuppConstraintTypeMissmatch
 Gets thrown when a parameter is of a type that does not match the required type, and is not convertible to it. More...
 
class  HazelnuppException
 Generic hazelnupp exception. More...
 
class  HazelnuppInvalidKeyException
 Gets thrown when an non-existent key gets dereferenced. More...
 
class  HazelnuppValueNotConvertibleException
 Gets thrown when an attempt is made to retrieve the wrong data type from a value, when the value not convertible. More...
 
class  IntValue
 Specializations for integer values (uses long long int) More...
 
class  ListValue
 Specializations for list values (uses std::vector<Value*>) More...
 
struct  ParamConstraint
 
class  Parameter
 
class  StringTools
 Internal helper class. More...
 
class  StringValue
 Specializations for string values (uses std::string) More...
 
class  Value
 Abstract class for values. More...
 
class  VoidValue
 Specializations for void values. More...
 
+ + + + +

+Enumerations

enum  DATA_TYPE {
+  DATA_TYPE::VOID, +DATA_TYPE::INT, +DATA_TYPE::FLOAT, +DATA_TYPE::STRING, +
+  DATA_TYPE::LIST +
+ }
 The different data types a paramater can be. More...
 
+

Enumeration Type Documentation

+ +

◆ DATA_TYPE

+ +
+
+ + + + + +
+ + + + +
enum Hazelnp::DATA_TYPE
+
+strong
+
+ +

The different data types a paramater can be.

+ + + + + + +
Enumerator
VOID 
INT 
FLOAT 
STRING 
LIST 
+ +

Definition at line 7 of file DataType.h.

+
8  {
+
9  VOID,
+
10  INT,
+
11  FLOAT,
+
12  STRING,
+
13  LIST
+
14  };
+
+
+
+
+
Hazelnp::DATA_TYPE::VOID
@ VOID
+
Hazelnp::DATA_TYPE::LIST
@ LIST
+
Hazelnp::DATA_TYPE::FLOAT
@ FLOAT
+
Hazelnp::DATA_TYPE::INT
@ INT
+
Hazelnp::DATA_TYPE::STRING
@ STRING
+ + + + diff --git a/docs/namespacemembers.html b/docs/namespacemembers.html index 98ec2ca..f506c2b 100644 --- a/docs/namespacemembers.html +++ b/docs/namespacemembers.html @@ -71,14 +71,14 @@ $(function() {
Here is a list of all namespace members with links to the namespace documentation for each member:
diff --git a/docs/namespacemembers_enum.html b/docs/namespacemembers_enum.html new file mode 100644 index 0000000..ca64a6b --- /dev/null +++ b/docs/namespacemembers_enum.html @@ -0,0 +1,86 @@ + + + + + + + +Leonetienne/Hazelnupp: Namespace Members + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+ + + + diff --git a/docs/namespaces.html b/docs/namespaces.html index 29bd5f7..acd14bf 100644 --- a/docs/namespaces.html +++ b/docs/namespaces.html @@ -76,13 +76,13 @@ $(function() {
Here is a list of all namespaces with brief descriptions:
- +
 NTestHazelnupp
 NHazelnp
diff --git a/docs/search/all_0.js b/docs/search/all_0.js index 23c78f5..2913dee 100644 --- a/docs/search/all_0.js +++ b/docs/search/all_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['addvalue_0',['AddValue',['../classListValue.html#af8787d266aa353d3f96e2c76cce76c41',1,'ListValue']]] + ['addvalue_0',['AddValue',['../classHazelnp_1_1ListValue.html#af8787d266aa353d3f96e2c76cce76c41',1,'Hazelnp::ListValue']]] ]; diff --git a/docs/search/all_1.js b/docs/search/all_1.js index e0aea9d..e487ca4 100644 --- a/docs/search/all_1.js +++ b/docs/search/all_1.js @@ -1,7 +1,7 @@ var searchData= [ - ['clearabbreviations_1',['ClearAbbreviations',['../classHazelnupp.html#a5175869b025468324cefad487081e91d',1,'Hazelnupp']]], - ['clearconstraints_2',['ClearConstraints',['../classHazelnupp.html#a3970b74583def49c6632fe08a4499809',1,'Hazelnupp']]], - ['constraintype_3',['constrainType',['../structParamConstraint.html#ab35444d2957439bc52c2056a829145a2',1,'ParamConstraint']]], - ['contains_4',['Contains',['../classStringTools.html#aec1abd8b22146c7a9ebeb6a94d6af5ee',1,'StringTools']]] + ['clearabbreviations_1',['ClearAbbreviations',['../classHazelnp_1_1Hazelnupp.html#a5175869b025468324cefad487081e91d',1,'Hazelnp::Hazelnupp']]], + ['clearconstraints_2',['ClearConstraints',['../classHazelnp_1_1Hazelnupp.html#a3970b74583def49c6632fe08a4499809',1,'Hazelnp::Hazelnupp']]], + ['constraintype_3',['constrainType',['../structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac',1,'Hazelnp::ParamConstraint']]], + ['contains_4',['Contains',['../classHazelnp_1_1StringTools.html#aec1abd8b22146c7a9ebeb6a94d6af5ee',1,'Hazelnp::StringTools']]] ]; diff --git a/docs/search/all_10.js b/docs/search/all_10.js index 9e0d0c0..8ea22f6 100644 --- a/docs/search/all_10.js +++ b/docs/search/all_10.js @@ -1,5 +1,5 @@ var searchData= [ - ['wantedtype_92',['wantedType',['../structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a',1,'ParamConstraint']]], - ['what_93',['What',['../classHazelnuppException.html#ac087d5190a9b3f6964120cc35321c3a6',1,'HazelnuppException']]] + ['wantedtype_93',['wantedType',['../structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329',1,'Hazelnp::ParamConstraint']]], + ['what_94',['What',['../classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e',1,'Hazelnp::HazelnuppException']]] ]; diff --git a/docs/search/all_11.js b/docs/search/all_11.js index b13fe20..fed2343 100644 --- a/docs/search/all_11.js +++ b/docs/search/all_11.js @@ -1,11 +1,11 @@ var searchData= [ - ['_7efloatvalue_94',['~FloatValue',['../classFloatValue.html#a5c6c7a2c805ac0207d325edd28a5db1c',1,'FloatValue']]], - ['_7ehazelnupp_95',['~Hazelnupp',['../classHazelnupp.html#a25f8810d24d647b6a57e2dd00ead42be',1,'Hazelnupp']]], - ['_7eintvalue_96',['~IntValue',['../classIntValue.html#a45514417be35da78376822a0dd50f488',1,'IntValue']]], - ['_7elistvalue_97',['~ListValue',['../classListValue.html#a91f1450f299d46b3301774a6b4eb6c18',1,'ListValue']]], - ['_7eparameter_98',['~Parameter',['../classParameter.html#a6e2ade42a712f1d3675653329266e42d',1,'Parameter']]], - ['_7estringvalue_99',['~StringValue',['../classStringValue.html#a829a8f064ec6b31b57d1dbebc8cd05d8',1,'StringValue']]], - ['_7evalue_100',['~Value',['../classValue.html#aceb26b90be781020c0c71ae5d16ca06f',1,'Value']]], - ['_7evoidvalue_101',['~VoidValue',['../classVoidValue.html#a8229e255a6fc31da4a4ec7aba97d4111',1,'VoidValue']]] + ['_7efloatvalue_95',['~FloatValue',['../classHazelnp_1_1FloatValue.html#a02e61e453c3e8e32d4d527799c11fd4a',1,'Hazelnp::FloatValue']]], + ['_7ehazelnupp_96',['~Hazelnupp',['../classHazelnp_1_1Hazelnupp.html#a25f8810d24d647b6a57e2dd00ead42be',1,'Hazelnp::Hazelnupp']]], + ['_7eintvalue_97',['~IntValue',['../classHazelnp_1_1IntValue.html#af69f25847b0666f9d6c1bb1fed18d917',1,'Hazelnp::IntValue']]], + ['_7elistvalue_98',['~ListValue',['../classHazelnp_1_1ListValue.html#a91f1450f299d46b3301774a6b4eb6c18',1,'Hazelnp::ListValue']]], + ['_7eparameter_99',['~Parameter',['../classHazelnp_1_1Parameter.html#a6e2ade42a712f1d3675653329266e42d',1,'Hazelnp::Parameter']]], + ['_7estringvalue_100',['~StringValue',['../classHazelnp_1_1StringValue.html#a5176062e2110d121466a6855fdc65d6d',1,'Hazelnp::StringValue']]], + ['_7evalue_101',['~Value',['../classHazelnp_1_1Value.html#a977dea61ee5b00b6c6d77ad6ad2c8d4c',1,'Hazelnp::Value']]], + ['_7evoidvalue_102',['~VoidValue',['../classHazelnp_1_1VoidValue.html#a6024b40919c3a6acea92be0439be2db0',1,'Hazelnp::VoidValue']]] ]; diff --git a/docs/search/all_2.js b/docs/search/all_2.js index f9650a7..ea03580 100644 --- a/docs/search/all_2.js +++ b/docs/search/all_2.js @@ -1,7 +1,7 @@ var searchData= [ - ['data_5ftype_5',['DATA_TYPE',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b',1,'DataType.h']]], + ['data_5ftype_5',['DATA_TYPE',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f',1,'Hazelnp']]], ['datatype_2eh_6',['DataType.h',['../DataType_8h.html',1,'']]], - ['deepcopy_7',['Deepcopy',['../classFloatValue.html#ab071916339a0d5a266d821ebbc8f12b0',1,'FloatValue::Deepcopy()'],['../classIntValue.html#aa599004242b27f8f3e246b88742b034e',1,'IntValue::Deepcopy()'],['../classListValue.html#a51c89ff315026b03d908345c6f58169d',1,'ListValue::Deepcopy()'],['../classStringValue.html#a1952487a786fb53cb0b9aefdb3367268',1,'StringValue::Deepcopy()'],['../classValue.html#a54439631b2c5b933c03baf65836838fc',1,'Value::Deepcopy()'],['../classVoidValue.html#ac36e85add840057659ec24484548165f',1,'VoidValue::Deepcopy()']]], - ['defaultvalue_8',['defaultValue',['../structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff',1,'ParamConstraint']]] + ['deepcopy_7',['Deepcopy',['../classHazelnp_1_1FloatValue.html#ab071916339a0d5a266d821ebbc8f12b0',1,'Hazelnp::FloatValue::Deepcopy()'],['../classHazelnp_1_1IntValue.html#aa599004242b27f8f3e246b88742b034e',1,'Hazelnp::IntValue::Deepcopy()'],['../classHazelnp_1_1ListValue.html#a51c89ff315026b03d908345c6f58169d',1,'Hazelnp::ListValue::Deepcopy()'],['../classHazelnp_1_1StringValue.html#a1952487a786fb53cb0b9aefdb3367268',1,'Hazelnp::StringValue::Deepcopy()'],['../classHazelnp_1_1Value.html#aec9bc16f1630734c79bc69e916622dc6',1,'Hazelnp::Value::Deepcopy()'],['../classHazelnp_1_1VoidValue.html#ac36e85add840057659ec24484548165f',1,'Hazelnp::VoidValue::Deepcopy()']]], + ['defaultvalue_8',['defaultValue',['../structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/all_3.js b/docs/search/all_3.js index 0cd0514..256c472 100644 --- a/docs/search/all_3.js +++ b/docs/search/all_3.js @@ -1,7 +1,7 @@ var searchData= [ - ['float_9',['FLOAT',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27bae738c26bf4ce1037fa81b039a915cbf6',1,'DataType.h']]], - ['floatvalue_10',['FloatValue',['../classFloatValue.html',1,'FloatValue'],['../classFloatValue.html#a6bb35564e3331a3feb57b08caad0df44',1,'FloatValue::FloatValue()']]], + ['float_9',['FLOAT',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fae738c26bf4ce1037fa81b039a915cbf6',1,'Hazelnp']]], + ['floatvalue_10',['FloatValue',['../classHazelnp_1_1FloatValue.html',1,'Hazelnp::FloatValue'],['../classHazelnp_1_1FloatValue.html#a6bb35564e3331a3feb57b08caad0df44',1,'Hazelnp::FloatValue::FloatValue()']]], ['floatvalue_2ecpp_11',['FloatValue.cpp',['../FloatValue_8cpp.html',1,'']]], ['floatvalue_2eh_12',['FloatValue.h',['../FloatValue_8h.html',1,'']]] ]; diff --git a/docs/search/all_4.js b/docs/search/all_4.js index 0ef4092..6b45a9b 100644 --- a/docs/search/all_4.js +++ b/docs/search/all_4.js @@ -1,15 +1,15 @@ var searchData= [ - ['getabbreviation_13',['GetAbbreviation',['../classHazelnupp.html#a579e78129f19cb9f17a6075366ababe5',1,'Hazelnupp']]], - ['getasosstring_14',['GetAsOsString',['../classFloatValue.html#a6c9a4b70a7618252f56d9062c483531c',1,'FloatValue::GetAsOsString()'],['../classIntValue.html#a7d7dbda9a051084600d3eabdac96ee45',1,'IntValue::GetAsOsString()'],['../classListValue.html#a5b1f8af329e48c5469fee16634b7889c',1,'ListValue::GetAsOsString()'],['../classStringValue.html#a71869ee46b88a3cbb9571f481f0c216d',1,'StringValue::GetAsOsString()'],['../classValue.html#a37bf4df9917f2d60ebfd0cee0bde3497',1,'Value::GetAsOsString()'],['../classVoidValue.html#a44b1917d9ba41ee91e2131432e01ec90',1,'VoidValue::GetAsOsString()']]], - ['getcrashonfail_15',['GetCrashOnFail',['../classHazelnupp.html#a1b810cc7db2cf64aecaa70c686b14bb7',1,'Hazelnupp']]], - ['getdatatype_16',['GetDataType',['../classValue.html#adbb80bf6d455a316e6e5103353429993',1,'Value']]], - ['getexecutablename_17',['GetExecutableName',['../classHazelnupp.html#af6bb41fb079131f8b91fe981f63f7469',1,'Hazelnupp']]], - ['getfloat32_18',['GetFloat32',['../classFloatValue.html#a1653ab3f4fa1700cf1b618ac6552ea81',1,'FloatValue::GetFloat32()'],['../classIntValue.html#ad0734e4cf67bac0bcc58251a4b3e56c4',1,'IntValue::GetFloat32()'],['../classListValue.html#a637fec02ed7f7325554e494fc7cd4e86',1,'ListValue::GetFloat32()'],['../classStringValue.html#a31fc4d2517a7454c1e9f329df2f14be7',1,'StringValue::GetFloat32()'],['../classValue.html#ac936fa09ba401a748ef67292ad823004',1,'Value::GetFloat32()'],['../classVoidValue.html#a6d39d2983e54e1a407c66e303273aa48',1,'VoidValue::GetFloat32()']]], - ['getfloat64_19',['GetFloat64',['../classFloatValue.html#add33b370ef691ccb2f0957d0fe4ef6f9',1,'FloatValue::GetFloat64()'],['../classIntValue.html#a5ceb2030e8a2a665953fdd4f1715e6a5',1,'IntValue::GetFloat64()'],['../classListValue.html#a571178db1c9d23f6c685ea8898dbb60e',1,'ListValue::GetFloat64()'],['../classStringValue.html#a74bedb828c901a4895062f62303b9653',1,'StringValue::GetFloat64()'],['../classValue.html#ac3d3a5b3ba7bf5aee0f41d19b242b7e8',1,'Value::GetFloat64()'],['../classVoidValue.html#a18b6f0d697c5f9286372a05927e4759c',1,'VoidValue::GetFloat64()']]], - ['getint32_20',['GetInt32',['../classFloatValue.html#a565741e80cd99a4d2af861ddc3c2dc99',1,'FloatValue::GetInt32()'],['../classIntValue.html#a163f21536fa49491aa0ae03c8091344a',1,'IntValue::GetInt32()'],['../classListValue.html#a565c2b86fcfb3a13de29e59d95a358e7',1,'ListValue::GetInt32()'],['../classStringValue.html#ac8b53a7792ff1ed048722e2e404f3e6b',1,'StringValue::GetInt32()'],['../classValue.html#afcbcf8a064895b6b9d2964aecee01f22',1,'Value::GetInt32()'],['../classVoidValue.html#a5b7f50c390ef8f3636ba211a72a78065',1,'VoidValue::GetInt32()']]], - ['getint64_21',['GetInt64',['../classFloatValue.html#a762520d504d4564c48cf3bbefbb0f183',1,'FloatValue::GetInt64()'],['../classIntValue.html#ae0643023dfd56eafe2e3da5a4ba13080',1,'IntValue::GetInt64()'],['../classListValue.html#a9a7a1161ddeb3e56eaafee5f10f75995',1,'ListValue::GetInt64()'],['../classStringValue.html#aabdc7d681945403d24df6a8fe27948af',1,'StringValue::GetInt64()'],['../classValue.html#a77229fe49da12240fbfbc6657101cb27',1,'Value::GetInt64()'],['../classVoidValue.html#a3806945596866f3630dc5426a6b55e58',1,'VoidValue::GetInt64()']]], - ['getlist_22',['GetList',['../classFloatValue.html#a60b2698f28f1aacac0b67b6453c89fd1',1,'FloatValue::GetList()'],['../classIntValue.html#acc74ba6070a516a4bcad10bb113d6fa2',1,'IntValue::GetList()'],['../classListValue.html#ad578d9088c0375cd9b9c6658e5d9ba1f',1,'ListValue::GetList()'],['../classStringValue.html#a2b2810350b5eb7e58062ad095320aa69',1,'StringValue::GetList()'],['../classValue.html#a930ca504a3e52e73f736a7e72f44e5ce',1,'Value::GetList()'],['../classVoidValue.html#aba53ae37d415959b583f33f3e381be16',1,'VoidValue::GetList()']]], - ['getstring_23',['GetString',['../classFloatValue.html#afd5d078683f410cb9d450c61f12f250d',1,'FloatValue::GetString()'],['../classIntValue.html#a3631e3b16f010889e942c0c0f72d403c',1,'IntValue::GetString()'],['../classListValue.html#aeaf80c07236045a77d72349ebcfc3b89',1,'ListValue::GetString()'],['../classStringValue.html#a7ed55493cfd25274f8571c1ea45f93e5',1,'StringValue::GetString()'],['../classValue.html#a1dd7df6be1d7298e5098a48622d0b65f',1,'Value::GetString()'],['../classVoidValue.html#a5af0c47a873b84226df47a90e63b2acd',1,'VoidValue::GetString()']]], - ['getvalue_24',['GetValue',['../classFloatValue.html#a2ad79d8bfe75e45120d1fce132a89b8f',1,'FloatValue::GetValue()'],['../classIntValue.html#a89967cafbdeb21362336067b772808c7',1,'IntValue::GetValue()'],['../classListValue.html#a7907ae7433e4011157f1b31dd5339702',1,'ListValue::GetValue()'],['../classParameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af',1,'Parameter::GetValue()'],['../classStringValue.html#a521a573887a3f31718f74e71ff01e86e',1,'StringValue::GetValue()']]] + ['getabbreviation_13',['GetAbbreviation',['../classHazelnp_1_1Hazelnupp.html#a579e78129f19cb9f17a6075366ababe5',1,'Hazelnp::Hazelnupp']]], + ['getasosstring_14',['GetAsOsString',['../classHazelnp_1_1FloatValue.html#a6c9a4b70a7618252f56d9062c483531c',1,'Hazelnp::FloatValue::GetAsOsString()'],['../classHazelnp_1_1IntValue.html#a7d7dbda9a051084600d3eabdac96ee45',1,'Hazelnp::IntValue::GetAsOsString()'],['../classHazelnp_1_1ListValue.html#a5b1f8af329e48c5469fee16634b7889c',1,'Hazelnp::ListValue::GetAsOsString()'],['../classHazelnp_1_1StringValue.html#a71869ee46b88a3cbb9571f481f0c216d',1,'Hazelnp::StringValue::GetAsOsString()'],['../classHazelnp_1_1Value.html#ae1fdc694ed1c2b3080ad3929efda0a0e',1,'Hazelnp::Value::GetAsOsString()'],['../classHazelnp_1_1VoidValue.html#a44b1917d9ba41ee91e2131432e01ec90',1,'Hazelnp::VoidValue::GetAsOsString()']]], + ['getcrashonfail_15',['GetCrashOnFail',['../classHazelnp_1_1Hazelnupp.html#a1b810cc7db2cf64aecaa70c686b14bb7',1,'Hazelnp::Hazelnupp']]], + ['getdatatype_16',['GetDataType',['../classHazelnp_1_1Value.html#adbb80bf6d455a316e6e5103353429993',1,'Hazelnp::Value']]], + ['getexecutablename_17',['GetExecutableName',['../classHazelnp_1_1Hazelnupp.html#af6bb41fb079131f8b91fe981f63f7469',1,'Hazelnp::Hazelnupp']]], + ['getfloat32_18',['GetFloat32',['../classHazelnp_1_1FloatValue.html#a1653ab3f4fa1700cf1b618ac6552ea81',1,'Hazelnp::FloatValue::GetFloat32()'],['../classHazelnp_1_1IntValue.html#ad0734e4cf67bac0bcc58251a4b3e56c4',1,'Hazelnp::IntValue::GetFloat32()'],['../classHazelnp_1_1ListValue.html#a637fec02ed7f7325554e494fc7cd4e86',1,'Hazelnp::ListValue::GetFloat32()'],['../classHazelnp_1_1StringValue.html#a31fc4d2517a7454c1e9f329df2f14be7',1,'Hazelnp::StringValue::GetFloat32()'],['../classHazelnp_1_1Value.html#a64eeb2943ccea6e16ce4e6f53a6e9b6d',1,'Hazelnp::Value::GetFloat32()'],['../classHazelnp_1_1VoidValue.html#a6d39d2983e54e1a407c66e303273aa48',1,'Hazelnp::VoidValue::GetFloat32()']]], + ['getfloat64_19',['GetFloat64',['../classHazelnp_1_1FloatValue.html#add33b370ef691ccb2f0957d0fe4ef6f9',1,'Hazelnp::FloatValue::GetFloat64()'],['../classHazelnp_1_1IntValue.html#a5ceb2030e8a2a665953fdd4f1715e6a5',1,'Hazelnp::IntValue::GetFloat64()'],['../classHazelnp_1_1ListValue.html#a571178db1c9d23f6c685ea8898dbb60e',1,'Hazelnp::ListValue::GetFloat64()'],['../classHazelnp_1_1StringValue.html#a74bedb828c901a4895062f62303b9653',1,'Hazelnp::StringValue::GetFloat64()'],['../classHazelnp_1_1Value.html#af645b9d78970d102360be37fc18e9e8a',1,'Hazelnp::Value::GetFloat64()'],['../classHazelnp_1_1VoidValue.html#a18b6f0d697c5f9286372a05927e4759c',1,'Hazelnp::VoidValue::GetFloat64()']]], + ['getint32_20',['GetInt32',['../classHazelnp_1_1FloatValue.html#a565741e80cd99a4d2af861ddc3c2dc99',1,'Hazelnp::FloatValue::GetInt32()'],['../classHazelnp_1_1IntValue.html#a163f21536fa49491aa0ae03c8091344a',1,'Hazelnp::IntValue::GetInt32()'],['../classHazelnp_1_1ListValue.html#a565c2b86fcfb3a13de29e59d95a358e7',1,'Hazelnp::ListValue::GetInt32()'],['../classHazelnp_1_1StringValue.html#ac8b53a7792ff1ed048722e2e404f3e6b',1,'Hazelnp::StringValue::GetInt32()'],['../classHazelnp_1_1Value.html#a2cb73333bdeca657dfbf6c8b2e50a5ef',1,'Hazelnp::Value::GetInt32()'],['../classHazelnp_1_1VoidValue.html#a5b7f50c390ef8f3636ba211a72a78065',1,'Hazelnp::VoidValue::GetInt32()']]], + ['getint64_21',['GetInt64',['../classHazelnp_1_1FloatValue.html#a762520d504d4564c48cf3bbefbb0f183',1,'Hazelnp::FloatValue::GetInt64()'],['../classHazelnp_1_1IntValue.html#ae0643023dfd56eafe2e3da5a4ba13080',1,'Hazelnp::IntValue::GetInt64()'],['../classHazelnp_1_1ListValue.html#a9a7a1161ddeb3e56eaafee5f10f75995',1,'Hazelnp::ListValue::GetInt64()'],['../classHazelnp_1_1StringValue.html#aabdc7d681945403d24df6a8fe27948af',1,'Hazelnp::StringValue::GetInt64()'],['../classHazelnp_1_1Value.html#a92d75905211e964cb900bdc868ed12a7',1,'Hazelnp::Value::GetInt64()'],['../classHazelnp_1_1VoidValue.html#a3806945596866f3630dc5426a6b55e58',1,'Hazelnp::VoidValue::GetInt64()']]], + ['getlist_22',['GetList',['../classHazelnp_1_1FloatValue.html#a60b2698f28f1aacac0b67b6453c89fd1',1,'Hazelnp::FloatValue::GetList()'],['../classHazelnp_1_1IntValue.html#acc74ba6070a516a4bcad10bb113d6fa2',1,'Hazelnp::IntValue::GetList()'],['../classHazelnp_1_1ListValue.html#ad578d9088c0375cd9b9c6658e5d9ba1f',1,'Hazelnp::ListValue::GetList()'],['../classHazelnp_1_1StringValue.html#a2b2810350b5eb7e58062ad095320aa69',1,'Hazelnp::StringValue::GetList()'],['../classHazelnp_1_1Value.html#a358092f951e817cd2a878225b5b1c869',1,'Hazelnp::Value::GetList()'],['../classHazelnp_1_1VoidValue.html#aba53ae37d415959b583f33f3e381be16',1,'Hazelnp::VoidValue::GetList()']]], + ['getstring_23',['GetString',['../classHazelnp_1_1FloatValue.html#afd5d078683f410cb9d450c61f12f250d',1,'Hazelnp::FloatValue::GetString()'],['../classHazelnp_1_1IntValue.html#a3631e3b16f010889e942c0c0f72d403c',1,'Hazelnp::IntValue::GetString()'],['../classHazelnp_1_1ListValue.html#aeaf80c07236045a77d72349ebcfc3b89',1,'Hazelnp::ListValue::GetString()'],['../classHazelnp_1_1StringValue.html#a7ed55493cfd25274f8571c1ea45f93e5',1,'Hazelnp::StringValue::GetString()'],['../classHazelnp_1_1Value.html#a1446705c062026f03866d0f452c39501',1,'Hazelnp::Value::GetString()'],['../classHazelnp_1_1VoidValue.html#a5af0c47a873b84226df47a90e63b2acd',1,'Hazelnp::VoidValue::GetString()']]], + ['getvalue_24',['GetValue',['../classHazelnp_1_1FloatValue.html#a2ad79d8bfe75e45120d1fce132a89b8f',1,'Hazelnp::FloatValue::GetValue()'],['../classHazelnp_1_1IntValue.html#a89967cafbdeb21362336067b772808c7',1,'Hazelnp::IntValue::GetValue()'],['../classHazelnp_1_1ListValue.html#a7907ae7433e4011157f1b31dd5339702',1,'Hazelnp::ListValue::GetValue()'],['../classHazelnp_1_1Parameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af',1,'Hazelnp::Parameter::GetValue()'],['../classHazelnp_1_1StringValue.html#a521a573887a3f31718f74e71ff01e86e',1,'Hazelnp::StringValue::GetValue()']]] ]; diff --git a/docs/search/all_5.js b/docs/search/all_5.js index 2c2a0d7..4d145e3 100644 --- a/docs/search/all_5.js +++ b/docs/search/all_5.js @@ -1,17 +1,18 @@ var searchData= [ - ['hasabbreviation_25',['HasAbbreviation',['../classHazelnupp.html#a46df7d396fb56e30351c9a7308792200',1,'Hazelnupp']]], - ['hasparam_26',['HasParam',['../classHazelnupp.html#a8b79a79d40420ae748c108c691111040',1,'Hazelnupp']]], - ['hazelnupp_27',['Hazelnupp',['../classHazelnupp.html',1,'Hazelnupp'],['../classHazelnupp.html#a20ac0ebcfd4df7f320a7bbcaeed6e54d',1,'Hazelnupp::Hazelnupp()'],['../classHazelnupp.html#a6d14c60f03b571f5f794c3549e75e435',1,'Hazelnupp::Hazelnupp(const int argc, const char *const *argv)']]], - ['hazelnupp_2ecpp_28',['Hazelnupp.cpp',['../Hazelnupp_8cpp.html',1,'']]], - ['hazelnupp_2eh_29',['Hazelnupp.h',['../Hazelnupp_8h.html',1,'']]], - ['hazelnupp_2evcxproj_2efilelistabsolute_2etxt_30',['Hazelnupp.vcxproj.FileListAbsolute.txt',['../Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)'],['../Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)']]], - ['hazelnuppconstraintexception_31',['HazelnuppConstraintException',['../classHazelnuppConstraintException.html',1,'HazelnuppConstraintException'],['../classHazelnuppConstraintException.html#ad434d9b9d78d36cc4008bad70270f844',1,'HazelnuppConstraintException::HazelnuppConstraintException()'],['../classHazelnuppConstraintException.html#a1bf58e4aa510f3e5cdebdfcbff2a1e53',1,'HazelnuppConstraintException::HazelnuppConstraintException(const std::string &msg)']]], - ['hazelnuppconstraintmissingvalue_32',['HazelnuppConstraintMissingValue',['../classHazelnuppConstraintMissingValue.html',1,'HazelnuppConstraintMissingValue'],['../classHazelnuppConstraintMissingValue.html#a022da2aca494f6853a7c013e94f5796f',1,'HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue()'],['../classHazelnuppConstraintMissingValue.html#a8d3ea192a75f993abe2845444cdb1bca',1,'HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue(const std::string &msg)']]], - ['hazelnuppconstrainttypemissmatch_33',['HazelnuppConstraintTypeMissmatch',['../classHazelnuppConstraintTypeMissmatch.html',1,'HazelnuppConstraintTypeMissmatch'],['../classHazelnuppConstraintTypeMissmatch.html#aa81de4d809dd7b00516716574e959c09',1,'HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch()'],['../classHazelnuppConstraintTypeMissmatch.html#ab8d0f32a3423239e06d8c44631098306',1,'HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch(const std::string &msg)']]], - ['hazelnuppexception_34',['HazelnuppException',['../classHazelnuppException.html',1,'HazelnuppException'],['../classHazelnuppException.html#a90d10b00ec056b721c102a70b629a779',1,'HazelnuppException::HazelnuppException()'],['../classHazelnuppException.html#a864a84c0498870ae0a76fb8c3542fa74',1,'HazelnuppException::HazelnuppException(const std::string &msg)']]], - ['hazelnuppexception_2eh_35',['HazelnuppException.h',['../HazelnuppException_8h.html',1,'']]], - ['hazelnuppinvalidkeyexception_36',['HazelnuppInvalidKeyException',['../classHazelnuppInvalidKeyException.html',1,'HazelnuppInvalidKeyException'],['../classHazelnuppInvalidKeyException.html#ac0c3a84356647817b5076f92e55874e7',1,'HazelnuppInvalidKeyException::HazelnuppInvalidKeyException()'],['../classHazelnuppInvalidKeyException.html#a5be8550858e8ba5754958055803120bc',1,'HazelnuppInvalidKeyException::HazelnuppInvalidKeyException(const std::string &msg)']]], - ['hazelnuppvaluenotconvertibleexception_37',['HazelnuppValueNotConvertibleException',['../classHazelnuppValueNotConvertibleException.html',1,'HazelnuppValueNotConvertibleException'],['../classHazelnuppValueNotConvertibleException.html#a459233c9ed4ca577f596761abb2f46e7',1,'HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException()'],['../classHazelnuppValueNotConvertibleException.html#a77dfcc974a767b77aefdaef86e9ad60c',1,'HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException(const std::string &msg)']]], - ['hazelnupp_38',['Hazelnupp',['../index.html',1,'']]] + ['hasabbreviation_25',['HasAbbreviation',['../classHazelnp_1_1Hazelnupp.html#a46df7d396fb56e30351c9a7308792200',1,'Hazelnp::Hazelnupp']]], + ['hasparam_26',['HasParam',['../classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040',1,'Hazelnp::Hazelnupp']]], + ['hazelnp_27',['Hazelnp',['../namespaceHazelnp.html',1,'']]], + ['hazelnupp_28',['Hazelnupp',['../classHazelnp_1_1Hazelnupp.html',1,'Hazelnp::Hazelnupp'],['../classHazelnp_1_1Hazelnupp.html#a20ac0ebcfd4df7f320a7bbcaeed6e54d',1,'Hazelnp::Hazelnupp::Hazelnupp()'],['../classHazelnp_1_1Hazelnupp.html#a6d14c60f03b571f5f794c3549e75e435',1,'Hazelnp::Hazelnupp::Hazelnupp(const int argc, const char *const *argv)']]], + ['hazelnupp_2ecpp_29',['Hazelnupp.cpp',['../Hazelnupp_8cpp.html',1,'']]], + ['hazelnupp_2eh_30',['Hazelnupp.h',['../Hazelnupp_8h.html',1,'']]], + ['hazelnupp_2evcxproj_2efilelistabsolute_2etxt_31',['Hazelnupp.vcxproj.FileListAbsolute.txt',['../Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)'],['../Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)']]], + ['hazelnuppconstraintexception_32',['HazelnuppConstraintException',['../classHazelnp_1_1HazelnuppConstraintException.html',1,'Hazelnp::HazelnuppConstraintException'],['../classHazelnp_1_1HazelnuppConstraintException.html#a4d08002a96bf9b3da3c6e931a51960e9',1,'Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException()'],['../classHazelnp_1_1HazelnuppConstraintException.html#a944f0e6a384e032a762c5892964e1cc0',1,'Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException(const std::string &msg)']]], + ['hazelnuppconstraintmissingvalue_33',['HazelnuppConstraintMissingValue',['../classHazelnp_1_1HazelnuppConstraintMissingValue.html',1,'Hazelnp::HazelnuppConstraintMissingValue'],['../classHazelnp_1_1HazelnuppConstraintMissingValue.html#aad4a7b5573790ddfbe1a453aef71eb10',1,'Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue()'],['../classHazelnp_1_1HazelnuppConstraintMissingValue.html#a20563650ba1ee63f23ddb973677dbdda',1,'Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue(const std::string &msg)']]], + ['hazelnuppconstrainttypemissmatch_34',['HazelnuppConstraintTypeMissmatch',['../classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html',1,'Hazelnp::HazelnuppConstraintTypeMissmatch'],['../classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html#ab7c9e9afd9d3286e563a7656785242e8',1,'Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch()'],['../classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html#a603d91c9af39e53b54e5aa288266cfe4',1,'Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch(const std::string &msg)']]], + ['hazelnuppexception_35',['HazelnuppException',['../classHazelnp_1_1HazelnuppException.html',1,'Hazelnp::HazelnuppException'],['../classHazelnp_1_1HazelnuppException.html#a0b21fd5d4f22e5e677b74eb0acd7c6ff',1,'Hazelnp::HazelnuppException::HazelnuppException()'],['../classHazelnp_1_1HazelnuppException.html#a816f823fe2ebd35076049e33b9f3c05c',1,'Hazelnp::HazelnuppException::HazelnuppException(const std::string &msg)']]], + ['hazelnuppexception_2eh_36',['HazelnuppException.h',['../HazelnuppException_8h.html',1,'']]], + ['hazelnuppinvalidkeyexception_37',['HazelnuppInvalidKeyException',['../classHazelnp_1_1HazelnuppInvalidKeyException.html',1,'Hazelnp::HazelnuppInvalidKeyException'],['../classHazelnp_1_1HazelnuppInvalidKeyException.html#ab23be8f7cb84129fa85ed1e7a0b280a0',1,'Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException()'],['../classHazelnp_1_1HazelnuppInvalidKeyException.html#a18a08dc4efe80a378216460db5769891',1,'Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException(const std::string &msg)']]], + ['hazelnuppvaluenotconvertibleexception_38',['HazelnuppValueNotConvertibleException',['../classHazelnp_1_1HazelnuppValueNotConvertibleException.html',1,'Hazelnp::HazelnuppValueNotConvertibleException'],['../classHazelnp_1_1HazelnuppValueNotConvertibleException.html#a0babee1bb5cec9fdd4abfd86995561f4',1,'Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException()'],['../classHazelnp_1_1HazelnuppValueNotConvertibleException.html#a7ba376cd7fc7edcb934ee0257d4867f2',1,'Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException(const std::string &msg)']]], + ['hazelnupp_39',['Hazelnupp',['../index.html',1,'']]] ]; diff --git a/docs/search/all_6.js b/docs/search/all_6.js index 708ddab..ba3ba14 100644 --- a/docs/search/all_6.js +++ b/docs/search/all_6.js @@ -1,9 +1,9 @@ var searchData= [ - ['index_2emd_39',['index.md',['../index_8md.html',1,'']]], - ['int_40',['INT',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba53f93baa3057821107c750323892fa92',1,'DataType.h']]], - ['intvalue_41',['IntValue',['../classIntValue.html',1,'IntValue'],['../classIntValue.html#ac1174f807ce2c085f5a24baed4e3c1ba',1,'IntValue::IntValue()']]], - ['intvalue_2ecpp_42',['IntValue.cpp',['../IntValue_8cpp.html',1,'']]], - ['intvalue_2eh_43',['IntValue.h',['../IntValue_8h.html',1,'']]], - ['isnumeric_44',['IsNumeric',['../classStringTools.html#a6cd093feaca2d978c23774cf87d86e68',1,'StringTools']]] + ['index_2emd_40',['index.md',['../index_8md.html',1,'']]], + ['int_41',['INT',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92',1,'Hazelnp']]], + ['intvalue_42',['IntValue',['../classHazelnp_1_1IntValue.html',1,'Hazelnp::IntValue'],['../classHazelnp_1_1IntValue.html#ac1174f807ce2c085f5a24baed4e3c1ba',1,'Hazelnp::IntValue::IntValue()']]], + ['intvalue_2ecpp_43',['IntValue.cpp',['../IntValue_8cpp.html',1,'']]], + ['intvalue_2eh_44',['IntValue.h',['../IntValue_8h.html',1,'']]], + ['isnumeric_45',['IsNumeric',['../classHazelnp_1_1StringTools.html#a6cd093feaca2d978c23774cf87d86e68',1,'Hazelnp::StringTools']]] ]; diff --git a/docs/search/all_7.js b/docs/search/all_7.js index 4a970ec..82ca697 100644 --- a/docs/search/all_7.js +++ b/docs/search/all_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['key_45',['Key',['../classParameter.html#a7acd68ce06eec06ab286b1a062f9c8d6',1,'Parameter::Key()'],['../structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648',1,'ParamConstraint::key()']]] + ['key_46',['Key',['../classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6',1,'Hazelnp::Parameter::Key()'],['../structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15',1,'Hazelnp::ParamConstraint::key()']]] ]; diff --git a/docs/search/all_8.js b/docs/search/all_8.js index 50897a0..cc6575d 100644 --- a/docs/search/all_8.js +++ b/docs/search/all_8.js @@ -1,7 +1,7 @@ var searchData= [ - ['list_46',['LIST',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba298cb25408234de02baf2085803a464a',1,'DataType.h']]], - ['listvalue_47',['ListValue',['../classListValue.html',1,'ListValue'],['../classListValue.html#a6082aaa506b31496720a168da8ab2708',1,'ListValue::ListValue()']]], - ['listvalue_2ecpp_48',['ListValue.cpp',['../ListValue_8cpp.html',1,'']]], - ['listvalue_2eh_49',['ListValue.h',['../ListValue_8h.html',1,'']]] + ['list_47',['LIST',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa298cb25408234de02baf2085803a464a',1,'Hazelnp']]], + ['listvalue_48',['ListValue',['../classHazelnp_1_1ListValue.html',1,'Hazelnp::ListValue'],['../classHazelnp_1_1ListValue.html#a6082aaa506b31496720a168da8ab2708',1,'Hazelnp::ListValue::ListValue()']]], + ['listvalue_2ecpp_49',['ListValue.cpp',['../ListValue_8cpp.html',1,'']]], + ['listvalue_2eh_50',['ListValue.h',['../ListValue_8h.html',1,'']]] ]; diff --git a/docs/search/all_9.js b/docs/search/all_9.js index 0ba5903..d67187f 100644 --- a/docs/search/all_9.js +++ b/docs/search/all_9.js @@ -1,6 +1,6 @@ var searchData= [ - ['main_50',['main',['../main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627',1,'main.cpp']]], - ['main_2ecpp_51',['main.cpp',['../main_8cpp.html',1,'']]], - ['message_52',['message',['../classHazelnuppException.html#a4d80f59d2732975461ee480642c4addf',1,'HazelnuppException']]] + ['main_51',['main',['../main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627',1,'main.cpp']]], + ['main_2ecpp_52',['main.cpp',['../main_8cpp.html',1,'']]], + ['message_53',['message',['../classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88',1,'Hazelnp::HazelnuppException']]] ]; diff --git a/docs/search/all_a.js b/docs/search/all_a.js index 4592a83..77cb833 100644 --- a/docs/search/all_a.js +++ b/docs/search/all_a.js @@ -1,11 +1,11 @@ var searchData= [ - ['operator_20double_53',['operator double',['../classFloatValue.html#ae02de376bbb2b76e0f9d16b1fc4de06d',1,'FloatValue']]], - ['operator_20int_54',['operator int',['../classIntValue.html#ab30a38c8f58cefd7cbf365c4aeae79bd',1,'IntValue']]], - ['operator_20long_20double_55',['operator long double',['../classFloatValue.html#ad0d4c589190fbab7e6c4d8fcc130ac1b',1,'FloatValue']]], - ['operator_20long_20long_20int_56',['operator long long int',['../classIntValue.html#a45b283dae9904ad0643035d3ee5883eb',1,'IntValue']]], - ['operator_3c_3c_57',['operator<<',['../classParameter.html#a11b3529badcbf99b46262772472495c7',1,'Parameter::operator<<()'],['../classValue.html#ad29db86c4a2dec5bc8d0006031b07211',1,'Value::operator<<()']]], - ['operator_5b_5d_58',['operator[]',['../classHazelnupp.html#a419ccdc6bad00b0fc3e17ed9b41f5dc5',1,'Hazelnupp']]], - ['string_59',['string',['../classStringValue.html#a23449775f14f828d29b115de040a696b',1,'StringValue']]], - ['vector_3c_20value_20_2a_20_3e_60',['vector< Value * >',['../classListValue.html#a5d92ff2b9a1fa92fbc303ac4d07765d0',1,'ListValue']]] + ['operator_20double_54',['operator double',['../classHazelnp_1_1FloatValue.html#ae02de376bbb2b76e0f9d16b1fc4de06d',1,'Hazelnp::FloatValue']]], + ['operator_20int_55',['operator int',['../classHazelnp_1_1IntValue.html#ab30a38c8f58cefd7cbf365c4aeae79bd',1,'Hazelnp::IntValue']]], + ['operator_20long_20double_56',['operator long double',['../classHazelnp_1_1FloatValue.html#ad0d4c589190fbab7e6c4d8fcc130ac1b',1,'Hazelnp::FloatValue']]], + ['operator_20long_20long_20int_57',['operator long long int',['../classHazelnp_1_1IntValue.html#a45b283dae9904ad0643035d3ee5883eb',1,'Hazelnp::IntValue']]], + ['operator_3c_3c_58',['operator<<',['../classHazelnp_1_1Parameter.html#a11b3529badcbf99b46262772472495c7',1,'Hazelnp::Parameter::operator<<()'],['../classHazelnp_1_1Value.html#ad29db86c4a2dec5bc8d0006031b07211',1,'Hazelnp::Value::operator<<()']]], + ['operator_5b_5d_59',['operator[]',['../classHazelnp_1_1Hazelnupp.html#a419ccdc6bad00b0fc3e17ed9b41f5dc5',1,'Hazelnp::Hazelnupp']]], + ['string_60',['string',['../classHazelnp_1_1StringValue.html#a23449775f14f828d29b115de040a696b',1,'Hazelnp::StringValue']]], + ['vector_3c_20value_20_2a_20_3e_61',['vector< Value * >',['../classHazelnp_1_1ListValue.html#a5d92ff2b9a1fa92fbc303ac4d07765d0',1,'Hazelnp::ListValue']]] ]; diff --git a/docs/search/all_b.js b/docs/search/all_b.js index a7092fa..7c8bc2e 100644 --- a/docs/search/all_b.js +++ b/docs/search/all_b.js @@ -1,10 +1,10 @@ var searchData= [ - ['paramconstraint_61',['ParamConstraint',['../structParamConstraint.html',1,'ParamConstraint'],['../structParamConstraint.html#ae0ce64f2f0928d602b6f6117ff34d155',1,'ParamConstraint::ParamConstraint()=default'],['../structParamConstraint.html#a93783114c6f374b77479a283c4aadf05',1,'ParamConstraint::ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)']]], - ['paramconstraint_2eh_62',['ParamConstraint.h',['../ParamConstraint_8h.html',1,'']]], - ['parameter_63',['Parameter',['../classParameter.html',1,'Parameter'],['../classParameter.html#a0c9faefc26cc9d8c886ef71e39e2f90c',1,'Parameter::Parameter()']]], - ['parameter_2ecpp_64',['Parameter.cpp',['../Parameter_8cpp.html',1,'']]], - ['parameter_2eh_65',['Parameter.h',['../Parameter_8h.html',1,'']]], - ['parse_66',['Parse',['../classHazelnupp.html#a1ccb88faca1a8deb77161888479c300b',1,'Hazelnupp']]], - ['parsenumber_67',['ParseNumber',['../classStringTools.html#ab661223da5bbbb75039e168409466c82',1,'StringTools']]] + ['paramconstraint_62',['ParamConstraint',['../structHazelnp_1_1ParamConstraint.html',1,'Hazelnp::ParamConstraint'],['../structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe',1,'Hazelnp::ParamConstraint::ParamConstraint()=default'],['../structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b',1,'Hazelnp::ParamConstraint::ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)']]], + ['paramconstraint_2eh_63',['ParamConstraint.h',['../ParamConstraint_8h.html',1,'']]], + ['parameter_64',['Parameter',['../classHazelnp_1_1Parameter.html',1,'Hazelnp::Parameter'],['../classHazelnp_1_1Parameter.html#a0c9faefc26cc9d8c886ef71e39e2f90c',1,'Hazelnp::Parameter::Parameter()']]], + ['parameter_2ecpp_65',['Parameter.cpp',['../Parameter_8cpp.html',1,'']]], + ['parameter_2eh_66',['Parameter.h',['../Parameter_8h.html',1,'']]], + ['parse_67',['Parse',['../classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b',1,'Hazelnp::Hazelnupp']]], + ['parsenumber_68',['ParseNumber',['../classHazelnp_1_1StringTools.html#ab661223da5bbbb75039e168409466c82',1,'Hazelnp::StringTools']]] ]; diff --git a/docs/search/all_c.js b/docs/search/all_c.js index f950545..76f59ad 100644 --- a/docs/search/all_c.js +++ b/docs/search/all_c.js @@ -1,8 +1,8 @@ var searchData= [ - ['registerabbreviation_68',['RegisterAbbreviation',['../classHazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124',1,'Hazelnupp']]], - ['registerconstraints_69',['RegisterConstraints',['../classHazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5',1,'Hazelnupp']]], - ['replace_70',['Replace',['../classStringTools.html#a0ca14c1d67833a61955a693f3e40d8b5',1,'StringTools::Replace(const std::string &str, const char find, const std::string &subst)'],['../classStringTools.html#a1658832ddf1611f83c5848e391d32806',1,'StringTools::Replace(const std::string &str, const std::string &find, const std::string &subst)']]], - ['require_71',['Require',['../structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c',1,'ParamConstraint']]], - ['required_72',['required',['../structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d',1,'ParamConstraint']]] + ['registerabbreviation_69',['RegisterAbbreviation',['../classHazelnp_1_1Hazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124',1,'Hazelnp::Hazelnupp']]], + ['registerconstraints_70',['RegisterConstraints',['../classHazelnp_1_1Hazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5',1,'Hazelnp::Hazelnupp']]], + ['replace_71',['Replace',['../classHazelnp_1_1StringTools.html#a0ca14c1d67833a61955a693f3e40d8b5',1,'Hazelnp::StringTools::Replace(const std::string &str, const char find, const std::string &subst)'],['../classHazelnp_1_1StringTools.html#a1658832ddf1611f83c5848e391d32806',1,'Hazelnp::StringTools::Replace(const std::string &str, const std::string &find, const std::string &subst)']]], + ['require_72',['Require',['../structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32',1,'Hazelnp::ParamConstraint']]], + ['required_73',['required',['../structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/all_d.js b/docs/search/all_d.js index c234d22..95fa944 100644 --- a/docs/search/all_d.js +++ b/docs/search/all_d.js @@ -1,12 +1,12 @@ var searchData= [ - ['setcrashonfail_73',['SetCrashOnFail',['../classHazelnupp.html#a17845623ca686caa51f3c8254e85551e',1,'Hazelnupp']]], - ['splitstring_74',['SplitString',['../classStringTools.html#a7cd6606ef06170fab363024e457f1f16',1,'StringTools::SplitString(const std::string &str, const char delimiter)'],['../classStringTools.html#afe626a56fa486afcb0e4c01d3c1ccb35',1,'StringTools::SplitString(const std::string &str, const std::string &delimiter)']]], - ['string_75',['STRING',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba63b588d5559f64f89a416e656880b949',1,'DataType.h']]], - ['stringtools_76',['StringTools',['../classStringTools.html',1,'']]], - ['stringtools_2ecpp_77',['StringTools.cpp',['../StringTools_8cpp.html',1,'']]], - ['stringtools_2eh_78',['StringTools.h',['../StringTools_8h.html',1,'']]], - ['stringvalue_79',['StringValue',['../classStringValue.html',1,'StringValue'],['../classStringValue.html#a24dad2deec92b51bf60a11400cc8c204',1,'StringValue::StringValue()']]], - ['stringvalue_2ecpp_80',['StringValue.cpp',['../StringValue_8cpp.html',1,'']]], - ['stringvalue_2eh_81',['StringValue.h',['../StringValue_8h.html',1,'']]] + ['setcrashonfail_74',['SetCrashOnFail',['../classHazelnp_1_1Hazelnupp.html#a17845623ca686caa51f3c8254e85551e',1,'Hazelnp::Hazelnupp']]], + ['splitstring_75',['SplitString',['../classHazelnp_1_1StringTools.html#a7cd6606ef06170fab363024e457f1f16',1,'Hazelnp::StringTools::SplitString(const std::string &str, const char delimiter)'],['../classHazelnp_1_1StringTools.html#afe626a56fa486afcb0e4c01d3c1ccb35',1,'Hazelnp::StringTools::SplitString(const std::string &str, const std::string &delimiter)']]], + ['string_76',['STRING',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa63b588d5559f64f89a416e656880b949',1,'Hazelnp']]], + ['stringtools_77',['StringTools',['../classHazelnp_1_1StringTools.html',1,'Hazelnp']]], + ['stringtools_2ecpp_78',['StringTools.cpp',['../StringTools_8cpp.html',1,'']]], + ['stringtools_2eh_79',['StringTools.h',['../StringTools_8h.html',1,'']]], + ['stringvalue_80',['StringValue',['../classHazelnp_1_1StringValue.html',1,'Hazelnp::StringValue'],['../classHazelnp_1_1StringValue.html#a24dad2deec92b51bf60a11400cc8c204',1,'Hazelnp::StringValue::StringValue()']]], + ['stringvalue_2ecpp_81',['StringValue.cpp',['../StringValue_8cpp.html',1,'']]], + ['stringvalue_2eh_82',['StringValue.h',['../StringValue_8h.html',1,'']]] ]; diff --git a/docs/search/all_e.js b/docs/search/all_e.js index d2538b5..1496af8 100644 --- a/docs/search/all_e.js +++ b/docs/search/all_e.js @@ -1,6 +1,6 @@ var searchData= [ - ['tolower_82',['ToLower',['../classStringTools.html#a67edf755685f59b51f7416d9e4f6e2bd',1,'StringTools']]], - ['type_83',['type',['../classValue.html#a1d097dc84691b48d12435c6bf97c85b4',1,'Value']]], - ['typesafety_84',['TypeSafety',['../structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5',1,'ParamConstraint']]] + ['tolower_83',['ToLower',['../classHazelnp_1_1StringTools.html#a67edf755685f59b51f7416d9e4f6e2bd',1,'Hazelnp::StringTools']]], + ['type_84',['type',['../classHazelnp_1_1Value.html#ae5760a30c237095db595c466372e3c23',1,'Hazelnp::Value']]], + ['typesafety_85',['TypeSafety',['../structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/all_f.js b/docs/search/all_f.js index e8b4af3..2293510 100644 --- a/docs/search/all_f.js +++ b/docs/search/all_f.js @@ -1,10 +1,10 @@ var searchData= [ - ['value_85',['Value',['../classValue.html',1,'Value'],['../classValue.html#a8455d65bb2d939e850d6772dfbf8bfec',1,'Value::Value()']]], - ['value_2ecpp_86',['Value.cpp',['../Value_8cpp.html',1,'']]], - ['value_2eh_87',['Value.h',['../Value_8h.html',1,'']]], - ['void_88',['VOID',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb',1,'DataType.h']]], - ['voidvalue_89',['VoidValue',['../classVoidValue.html',1,'VoidValue'],['../classVoidValue.html#a75abf334b7f55cd149d2bb1962f2d8f1',1,'VoidValue::VoidValue()']]], - ['voidvalue_2ecpp_90',['VoidValue.cpp',['../VoidValue_8cpp.html',1,'']]], - ['voidvalue_2eh_91',['VoidValue.h',['../VoidValue_8h.html',1,'']]] + ['value_86',['Value',['../classHazelnp_1_1Value.html',1,'Hazelnp::Value'],['../classHazelnp_1_1Value.html#a8455d65bb2d939e850d6772dfbf8bfec',1,'Hazelnp::Value::Value()']]], + ['value_2ecpp_87',['Value.cpp',['../Value_8cpp.html',1,'']]], + ['value_2eh_88',['Value.h',['../Value_8h.html',1,'']]], + ['void_89',['VOID',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb',1,'Hazelnp']]], + ['voidvalue_90',['VoidValue',['../classHazelnp_1_1VoidValue.html',1,'Hazelnp::VoidValue'],['../classHazelnp_1_1VoidValue.html#a75abf334b7f55cd149d2bb1962f2d8f1',1,'Hazelnp::VoidValue::VoidValue()']]], + ['voidvalue_2ecpp_91',['VoidValue.cpp',['../VoidValue_8cpp.html',1,'']]], + ['voidvalue_2eh_92',['VoidValue.h',['../VoidValue_8h.html',1,'']]] ]; diff --git a/docs/search/classes_0.js b/docs/search/classes_0.js index 73763c0..59a4420 100644 --- a/docs/search/classes_0.js +++ b/docs/search/classes_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['floatvalue_102',['FloatValue',['../classFloatValue.html',1,'']]] + ['floatvalue_103',['FloatValue',['../classHazelnp_1_1FloatValue.html',1,'Hazelnp']]] ]; diff --git a/docs/search/classes_1.js b/docs/search/classes_1.js index cae065c..fb52081 100644 --- a/docs/search/classes_1.js +++ b/docs/search/classes_1.js @@ -1,10 +1,10 @@ var searchData= [ - ['hazelnupp_103',['Hazelnupp',['../classHazelnupp.html',1,'']]], - ['hazelnuppconstraintexception_104',['HazelnuppConstraintException',['../classHazelnuppConstraintException.html',1,'']]], - ['hazelnuppconstraintmissingvalue_105',['HazelnuppConstraintMissingValue',['../classHazelnuppConstraintMissingValue.html',1,'']]], - ['hazelnuppconstrainttypemissmatch_106',['HazelnuppConstraintTypeMissmatch',['../classHazelnuppConstraintTypeMissmatch.html',1,'']]], - ['hazelnuppexception_107',['HazelnuppException',['../classHazelnuppException.html',1,'']]], - ['hazelnuppinvalidkeyexception_108',['HazelnuppInvalidKeyException',['../classHazelnuppInvalidKeyException.html',1,'']]], - ['hazelnuppvaluenotconvertibleexception_109',['HazelnuppValueNotConvertibleException',['../classHazelnuppValueNotConvertibleException.html',1,'']]] + ['hazelnupp_104',['Hazelnupp',['../classHazelnp_1_1Hazelnupp.html',1,'Hazelnp']]], + ['hazelnuppconstraintexception_105',['HazelnuppConstraintException',['../classHazelnp_1_1HazelnuppConstraintException.html',1,'Hazelnp']]], + ['hazelnuppconstraintmissingvalue_106',['HazelnuppConstraintMissingValue',['../classHazelnp_1_1HazelnuppConstraintMissingValue.html',1,'Hazelnp']]], + ['hazelnuppconstrainttypemissmatch_107',['HazelnuppConstraintTypeMissmatch',['../classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html',1,'Hazelnp']]], + ['hazelnuppexception_108',['HazelnuppException',['../classHazelnp_1_1HazelnuppException.html',1,'Hazelnp']]], + ['hazelnuppinvalidkeyexception_109',['HazelnuppInvalidKeyException',['../classHazelnp_1_1HazelnuppInvalidKeyException.html',1,'Hazelnp']]], + ['hazelnuppvaluenotconvertibleexception_110',['HazelnuppValueNotConvertibleException',['../classHazelnp_1_1HazelnuppValueNotConvertibleException.html',1,'Hazelnp']]] ]; diff --git a/docs/search/classes_2.js b/docs/search/classes_2.js index d732bd0..3a7723e 100644 --- a/docs/search/classes_2.js +++ b/docs/search/classes_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['intvalue_110',['IntValue',['../classIntValue.html',1,'']]] + ['intvalue_111',['IntValue',['../classHazelnp_1_1IntValue.html',1,'Hazelnp']]] ]; diff --git a/docs/search/classes_3.js b/docs/search/classes_3.js index e53abdf..4d410d7 100644 --- a/docs/search/classes_3.js +++ b/docs/search/classes_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['listvalue_111',['ListValue',['../classListValue.html',1,'']]] + ['listvalue_112',['ListValue',['../classHazelnp_1_1ListValue.html',1,'Hazelnp']]] ]; diff --git a/docs/search/classes_4.js b/docs/search/classes_4.js index b10e19a..121ed56 100644 --- a/docs/search/classes_4.js +++ b/docs/search/classes_4.js @@ -1,5 +1,5 @@ var searchData= [ - ['paramconstraint_112',['ParamConstraint',['../structParamConstraint.html',1,'']]], - ['parameter_113',['Parameter',['../classParameter.html',1,'']]] + ['paramconstraint_113',['ParamConstraint',['../structHazelnp_1_1ParamConstraint.html',1,'Hazelnp']]], + ['parameter_114',['Parameter',['../classHazelnp_1_1Parameter.html',1,'Hazelnp']]] ]; diff --git a/docs/search/classes_5.js b/docs/search/classes_5.js index 46b60a1..2c97bf0 100644 --- a/docs/search/classes_5.js +++ b/docs/search/classes_5.js @@ -1,5 +1,5 @@ var searchData= [ - ['stringtools_114',['StringTools',['../classStringTools.html',1,'']]], - ['stringvalue_115',['StringValue',['../classStringValue.html',1,'']]] + ['stringtools_115',['StringTools',['../classHazelnp_1_1StringTools.html',1,'Hazelnp']]], + ['stringvalue_116',['StringValue',['../classHazelnp_1_1StringValue.html',1,'Hazelnp']]] ]; diff --git a/docs/search/classes_6.js b/docs/search/classes_6.js index 870571d..ec2de70 100644 --- a/docs/search/classes_6.js +++ b/docs/search/classes_6.js @@ -1,5 +1,5 @@ var searchData= [ - ['value_116',['Value',['../classValue.html',1,'']]], - ['voidvalue_117',['VoidValue',['../classVoidValue.html',1,'']]] + ['value_117',['Value',['../classHazelnp_1_1Value.html',1,'Hazelnp']]], + ['voidvalue_118',['VoidValue',['../classHazelnp_1_1VoidValue.html',1,'Hazelnp']]] ]; diff --git a/docs/search/enums_0.js b/docs/search/enums_0.js index 8efabc7..9dcd61e 100644 --- a/docs/search/enums_0.js +++ b/docs/search/enums_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['data_5ftype_212',['DATA_TYPE',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27b',1,'DataType.h']]] + ['data_5ftype_214',['DATA_TYPE',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803f',1,'Hazelnp']]] ]; diff --git a/docs/search/enumvalues_0.js b/docs/search/enumvalues_0.js index 8673bc3..858e23a 100644 --- a/docs/search/enumvalues_0.js +++ b/docs/search/enumvalues_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['float_213',['FLOAT',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27bae738c26bf4ce1037fa81b039a915cbf6',1,'DataType.h']]] + ['float_215',['FLOAT',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fae738c26bf4ce1037fa81b039a915cbf6',1,'Hazelnp']]] ]; diff --git a/docs/search/enumvalues_1.js b/docs/search/enumvalues_1.js index 82b116f..79aac73 100644 --- a/docs/search/enumvalues_1.js +++ b/docs/search/enumvalues_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['int_214',['INT',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba53f93baa3057821107c750323892fa92',1,'DataType.h']]] + ['int_216',['INT',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa53f93baa3057821107c750323892fa92',1,'Hazelnp']]] ]; diff --git a/docs/search/enumvalues_2.js b/docs/search/enumvalues_2.js index b9d59d2..45e67e5 100644 --- a/docs/search/enumvalues_2.js +++ b/docs/search/enumvalues_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['list_215',['LIST',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba298cb25408234de02baf2085803a464a',1,'DataType.h']]] + ['list_217',['LIST',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa298cb25408234de02baf2085803a464a',1,'Hazelnp']]] ]; diff --git a/docs/search/enumvalues_3.js b/docs/search/enumvalues_3.js index 8554169..97a523a 100644 --- a/docs/search/enumvalues_3.js +++ b/docs/search/enumvalues_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['string_216',['STRING',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba63b588d5559f64f89a416e656880b949',1,'DataType.h']]] + ['string_218',['STRING',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa63b588d5559f64f89a416e656880b949',1,'Hazelnp']]] ]; diff --git a/docs/search/enumvalues_4.js b/docs/search/enumvalues_4.js index 15cb7e3..f019218 100644 --- a/docs/search/enumvalues_4.js +++ b/docs/search/enumvalues_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['void_217',['VOID',['../DataType_8h.html#aa082c000e4eff6ed512714ea0a33d27ba6d0c9fc747131795e6e5d0c5119f12cb',1,'DataType.h']]] + ['void_219',['VOID',['../namespaceHazelnp.html#a07b61ac22ce9cd97eceebdf9487f803fa6d0c9fc747131795e6e5d0c5119f12cb',1,'Hazelnp']]] ]; diff --git a/docs/search/files_0.js b/docs/search/files_0.js index d9e6534..2dc1ac5 100644 --- a/docs/search/files_0.js +++ b/docs/search/files_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['datatype_2eh_118',['DataType.h',['../DataType_8h.html',1,'']]] + ['datatype_2eh_120',['DataType.h',['../DataType_8h.html',1,'']]] ]; diff --git a/docs/search/files_1.js b/docs/search/files_1.js index 83e1858..bf64872 100644 --- a/docs/search/files_1.js +++ b/docs/search/files_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['floatvalue_2ecpp_119',['FloatValue.cpp',['../FloatValue_8cpp.html',1,'']]], - ['floatvalue_2eh_120',['FloatValue.h',['../FloatValue_8h.html',1,'']]] + ['floatvalue_2ecpp_121',['FloatValue.cpp',['../FloatValue_8cpp.html',1,'']]], + ['floatvalue_2eh_122',['FloatValue.h',['../FloatValue_8h.html',1,'']]] ]; diff --git a/docs/search/files_2.js b/docs/search/files_2.js index f0b5a16..f190153 100644 --- a/docs/search/files_2.js +++ b/docs/search/files_2.js @@ -1,7 +1,7 @@ var searchData= [ - ['hazelnupp_2ecpp_121',['Hazelnupp.cpp',['../Hazelnupp_8cpp.html',1,'']]], - ['hazelnupp_2eh_122',['Hazelnupp.h',['../Hazelnupp_8h.html',1,'']]], - ['hazelnupp_2evcxproj_2efilelistabsolute_2etxt_123',['Hazelnupp.vcxproj.FileListAbsolute.txt',['../Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)'],['../Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)']]], - ['hazelnuppexception_2eh_124',['HazelnuppException.h',['../HazelnuppException_8h.html',1,'']]] + ['hazelnupp_2ecpp_123',['Hazelnupp.cpp',['../Hazelnupp_8cpp.html',1,'']]], + ['hazelnupp_2eh_124',['Hazelnupp.h',['../Hazelnupp_8h.html',1,'']]], + ['hazelnupp_2evcxproj_2efilelistabsolute_2etxt_125',['Hazelnupp.vcxproj.FileListAbsolute.txt',['../Debug_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)'],['../Release_2Hazelnupp_8vcxproj_8FileListAbsolute_8txt.html',1,'(Global Namespace)']]], + ['hazelnuppexception_2eh_126',['HazelnuppException.h',['../HazelnuppException_8h.html',1,'']]] ]; diff --git a/docs/search/files_3.js b/docs/search/files_3.js index 772961e..cd9cee9 100644 --- a/docs/search/files_3.js +++ b/docs/search/files_3.js @@ -1,6 +1,6 @@ var searchData= [ - ['index_2emd_125',['index.md',['../index_8md.html',1,'']]], - ['intvalue_2ecpp_126',['IntValue.cpp',['../IntValue_8cpp.html',1,'']]], - ['intvalue_2eh_127',['IntValue.h',['../IntValue_8h.html',1,'']]] + ['index_2emd_127',['index.md',['../index_8md.html',1,'']]], + ['intvalue_2ecpp_128',['IntValue.cpp',['../IntValue_8cpp.html',1,'']]], + ['intvalue_2eh_129',['IntValue.h',['../IntValue_8h.html',1,'']]] ]; diff --git a/docs/search/files_4.js b/docs/search/files_4.js index e4b5a51..7e6e3ad 100644 --- a/docs/search/files_4.js +++ b/docs/search/files_4.js @@ -1,5 +1,5 @@ var searchData= [ - ['listvalue_2ecpp_128',['ListValue.cpp',['../ListValue_8cpp.html',1,'']]], - ['listvalue_2eh_129',['ListValue.h',['../ListValue_8h.html',1,'']]] + ['listvalue_2ecpp_130',['ListValue.cpp',['../ListValue_8cpp.html',1,'']]], + ['listvalue_2eh_131',['ListValue.h',['../ListValue_8h.html',1,'']]] ]; diff --git a/docs/search/files_5.js b/docs/search/files_5.js index b7d2305..9aa2de0 100644 --- a/docs/search/files_5.js +++ b/docs/search/files_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['main_2ecpp_130',['main.cpp',['../main_8cpp.html',1,'']]] + ['main_2ecpp_132',['main.cpp',['../main_8cpp.html',1,'']]] ]; diff --git a/docs/search/files_6.js b/docs/search/files_6.js index 41abf6a..a090749 100644 --- a/docs/search/files_6.js +++ b/docs/search/files_6.js @@ -1,6 +1,6 @@ var searchData= [ - ['paramconstraint_2eh_131',['ParamConstraint.h',['../ParamConstraint_8h.html',1,'']]], - ['parameter_2ecpp_132',['Parameter.cpp',['../Parameter_8cpp.html',1,'']]], - ['parameter_2eh_133',['Parameter.h',['../Parameter_8h.html',1,'']]] + ['paramconstraint_2eh_133',['ParamConstraint.h',['../ParamConstraint_8h.html',1,'']]], + ['parameter_2ecpp_134',['Parameter.cpp',['../Parameter_8cpp.html',1,'']]], + ['parameter_2eh_135',['Parameter.h',['../Parameter_8h.html',1,'']]] ]; diff --git a/docs/search/files_7.js b/docs/search/files_7.js index e5d95fb..0f4c4cd 100644 --- a/docs/search/files_7.js +++ b/docs/search/files_7.js @@ -1,7 +1,7 @@ var searchData= [ - ['stringtools_2ecpp_134',['StringTools.cpp',['../StringTools_8cpp.html',1,'']]], - ['stringtools_2eh_135',['StringTools.h',['../StringTools_8h.html',1,'']]], - ['stringvalue_2ecpp_136',['StringValue.cpp',['../StringValue_8cpp.html',1,'']]], - ['stringvalue_2eh_137',['StringValue.h',['../StringValue_8h.html',1,'']]] + ['stringtools_2ecpp_136',['StringTools.cpp',['../StringTools_8cpp.html',1,'']]], + ['stringtools_2eh_137',['StringTools.h',['../StringTools_8h.html',1,'']]], + ['stringvalue_2ecpp_138',['StringValue.cpp',['../StringValue_8cpp.html',1,'']]], + ['stringvalue_2eh_139',['StringValue.h',['../StringValue_8h.html',1,'']]] ]; diff --git a/docs/search/files_8.js b/docs/search/files_8.js index b8e27a9..76c2e7d 100644 --- a/docs/search/files_8.js +++ b/docs/search/files_8.js @@ -1,7 +1,7 @@ var searchData= [ - ['value_2ecpp_138',['Value.cpp',['../Value_8cpp.html',1,'']]], - ['value_2eh_139',['Value.h',['../Value_8h.html',1,'']]], - ['voidvalue_2ecpp_140',['VoidValue.cpp',['../VoidValue_8cpp.html',1,'']]], - ['voidvalue_2eh_141',['VoidValue.h',['../VoidValue_8h.html',1,'']]] + ['value_2ecpp_140',['Value.cpp',['../Value_8cpp.html',1,'']]], + ['value_2eh_141',['Value.h',['../Value_8h.html',1,'']]], + ['voidvalue_2ecpp_142',['VoidValue.cpp',['../VoidValue_8cpp.html',1,'']]], + ['voidvalue_2eh_143',['VoidValue.h',['../VoidValue_8h.html',1,'']]] ]; diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js index 58b93a6..f2aa016 100644 --- a/docs/search/functions_0.js +++ b/docs/search/functions_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['addvalue_142',['AddValue',['../classListValue.html#af8787d266aa353d3f96e2c76cce76c41',1,'ListValue']]] + ['addvalue_144',['AddValue',['../classHazelnp_1_1ListValue.html#af8787d266aa353d3f96e2c76cce76c41',1,'Hazelnp::ListValue']]] ]; diff --git a/docs/search/functions_1.js b/docs/search/functions_1.js index 939fd60..1b22714 100644 --- a/docs/search/functions_1.js +++ b/docs/search/functions_1.js @@ -1,6 +1,6 @@ var searchData= [ - ['clearabbreviations_143',['ClearAbbreviations',['../classHazelnupp.html#a5175869b025468324cefad487081e91d',1,'Hazelnupp']]], - ['clearconstraints_144',['ClearConstraints',['../classHazelnupp.html#a3970b74583def49c6632fe08a4499809',1,'Hazelnupp']]], - ['contains_145',['Contains',['../classStringTools.html#aec1abd8b22146c7a9ebeb6a94d6af5ee',1,'StringTools']]] + ['clearabbreviations_145',['ClearAbbreviations',['../classHazelnp_1_1Hazelnupp.html#a5175869b025468324cefad487081e91d',1,'Hazelnp::Hazelnupp']]], + ['clearconstraints_146',['ClearConstraints',['../classHazelnp_1_1Hazelnupp.html#a3970b74583def49c6632fe08a4499809',1,'Hazelnp::Hazelnupp']]], + ['contains_147',['Contains',['../classHazelnp_1_1StringTools.html#aec1abd8b22146c7a9ebeb6a94d6af5ee',1,'Hazelnp::StringTools']]] ]; diff --git a/docs/search/functions_10.js b/docs/search/functions_10.js index b2ad77e..e85cd6e 100644 --- a/docs/search/functions_10.js +++ b/docs/search/functions_10.js @@ -1,4 +1,4 @@ var searchData= [ - ['what_196',['What',['../classHazelnuppException.html#ac087d5190a9b3f6964120cc35321c3a6',1,'HazelnuppException']]] + ['what_198',['What',['../classHazelnp_1_1HazelnuppException.html#aa86c415a0f2b4ea5f11892145d1ea83e',1,'Hazelnp::HazelnuppException']]] ]; diff --git a/docs/search/functions_11.js b/docs/search/functions_11.js index 3625c00..91267d9 100644 --- a/docs/search/functions_11.js +++ b/docs/search/functions_11.js @@ -1,11 +1,11 @@ var searchData= [ - ['_7efloatvalue_197',['~FloatValue',['../classFloatValue.html#a5c6c7a2c805ac0207d325edd28a5db1c',1,'FloatValue']]], - ['_7ehazelnupp_198',['~Hazelnupp',['../classHazelnupp.html#a25f8810d24d647b6a57e2dd00ead42be',1,'Hazelnupp']]], - ['_7eintvalue_199',['~IntValue',['../classIntValue.html#a45514417be35da78376822a0dd50f488',1,'IntValue']]], - ['_7elistvalue_200',['~ListValue',['../classListValue.html#a91f1450f299d46b3301774a6b4eb6c18',1,'ListValue']]], - ['_7eparameter_201',['~Parameter',['../classParameter.html#a6e2ade42a712f1d3675653329266e42d',1,'Parameter']]], - ['_7estringvalue_202',['~StringValue',['../classStringValue.html#a829a8f064ec6b31b57d1dbebc8cd05d8',1,'StringValue']]], - ['_7evalue_203',['~Value',['../classValue.html#aceb26b90be781020c0c71ae5d16ca06f',1,'Value']]], - ['_7evoidvalue_204',['~VoidValue',['../classVoidValue.html#a8229e255a6fc31da4a4ec7aba97d4111',1,'VoidValue']]] + ['_7efloatvalue_199',['~FloatValue',['../classHazelnp_1_1FloatValue.html#a02e61e453c3e8e32d4d527799c11fd4a',1,'Hazelnp::FloatValue']]], + ['_7ehazelnupp_200',['~Hazelnupp',['../classHazelnp_1_1Hazelnupp.html#a25f8810d24d647b6a57e2dd00ead42be',1,'Hazelnp::Hazelnupp']]], + ['_7eintvalue_201',['~IntValue',['../classHazelnp_1_1IntValue.html#af69f25847b0666f9d6c1bb1fed18d917',1,'Hazelnp::IntValue']]], + ['_7elistvalue_202',['~ListValue',['../classHazelnp_1_1ListValue.html#a91f1450f299d46b3301774a6b4eb6c18',1,'Hazelnp::ListValue']]], + ['_7eparameter_203',['~Parameter',['../classHazelnp_1_1Parameter.html#a6e2ade42a712f1d3675653329266e42d',1,'Hazelnp::Parameter']]], + ['_7estringvalue_204',['~StringValue',['../classHazelnp_1_1StringValue.html#a5176062e2110d121466a6855fdc65d6d',1,'Hazelnp::StringValue']]], + ['_7evalue_205',['~Value',['../classHazelnp_1_1Value.html#a977dea61ee5b00b6c6d77ad6ad2c8d4c',1,'Hazelnp::Value']]], + ['_7evoidvalue_206',['~VoidValue',['../classHazelnp_1_1VoidValue.html#a6024b40919c3a6acea92be0439be2db0',1,'Hazelnp::VoidValue']]] ]; diff --git a/docs/search/functions_2.js b/docs/search/functions_2.js index ab3ef52..c907557 100644 --- a/docs/search/functions_2.js +++ b/docs/search/functions_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['deepcopy_146',['Deepcopy',['../classFloatValue.html#ab071916339a0d5a266d821ebbc8f12b0',1,'FloatValue::Deepcopy()'],['../classIntValue.html#aa599004242b27f8f3e246b88742b034e',1,'IntValue::Deepcopy()'],['../classListValue.html#a51c89ff315026b03d908345c6f58169d',1,'ListValue::Deepcopy()'],['../classStringValue.html#a1952487a786fb53cb0b9aefdb3367268',1,'StringValue::Deepcopy()'],['../classValue.html#a54439631b2c5b933c03baf65836838fc',1,'Value::Deepcopy()'],['../classVoidValue.html#ac36e85add840057659ec24484548165f',1,'VoidValue::Deepcopy()']]] + ['deepcopy_148',['Deepcopy',['../classHazelnp_1_1FloatValue.html#ab071916339a0d5a266d821ebbc8f12b0',1,'Hazelnp::FloatValue::Deepcopy()'],['../classHazelnp_1_1IntValue.html#aa599004242b27f8f3e246b88742b034e',1,'Hazelnp::IntValue::Deepcopy()'],['../classHazelnp_1_1ListValue.html#a51c89ff315026b03d908345c6f58169d',1,'Hazelnp::ListValue::Deepcopy()'],['../classHazelnp_1_1StringValue.html#a1952487a786fb53cb0b9aefdb3367268',1,'Hazelnp::StringValue::Deepcopy()'],['../classHazelnp_1_1Value.html#aec9bc16f1630734c79bc69e916622dc6',1,'Hazelnp::Value::Deepcopy()'],['../classHazelnp_1_1VoidValue.html#ac36e85add840057659ec24484548165f',1,'Hazelnp::VoidValue::Deepcopy()']]] ]; diff --git a/docs/search/functions_3.js b/docs/search/functions_3.js index ed157d0..a1161e0 100644 --- a/docs/search/functions_3.js +++ b/docs/search/functions_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['floatvalue_147',['FloatValue',['../classFloatValue.html#a6bb35564e3331a3feb57b08caad0df44',1,'FloatValue']]] + ['floatvalue_149',['FloatValue',['../classHazelnp_1_1FloatValue.html#a6bb35564e3331a3feb57b08caad0df44',1,'Hazelnp::FloatValue']]] ]; diff --git a/docs/search/functions_4.js b/docs/search/functions_4.js index ee911d3..25a7ac7 100644 --- a/docs/search/functions_4.js +++ b/docs/search/functions_4.js @@ -1,15 +1,15 @@ var searchData= [ - ['getabbreviation_148',['GetAbbreviation',['../classHazelnupp.html#a579e78129f19cb9f17a6075366ababe5',1,'Hazelnupp']]], - ['getasosstring_149',['GetAsOsString',['../classFloatValue.html#a6c9a4b70a7618252f56d9062c483531c',1,'FloatValue::GetAsOsString()'],['../classIntValue.html#a7d7dbda9a051084600d3eabdac96ee45',1,'IntValue::GetAsOsString()'],['../classListValue.html#a5b1f8af329e48c5469fee16634b7889c',1,'ListValue::GetAsOsString()'],['../classStringValue.html#a71869ee46b88a3cbb9571f481f0c216d',1,'StringValue::GetAsOsString()'],['../classValue.html#a37bf4df9917f2d60ebfd0cee0bde3497',1,'Value::GetAsOsString()'],['../classVoidValue.html#a44b1917d9ba41ee91e2131432e01ec90',1,'VoidValue::GetAsOsString()']]], - ['getcrashonfail_150',['GetCrashOnFail',['../classHazelnupp.html#a1b810cc7db2cf64aecaa70c686b14bb7',1,'Hazelnupp']]], - ['getdatatype_151',['GetDataType',['../classValue.html#adbb80bf6d455a316e6e5103353429993',1,'Value']]], - ['getexecutablename_152',['GetExecutableName',['../classHazelnupp.html#af6bb41fb079131f8b91fe981f63f7469',1,'Hazelnupp']]], - ['getfloat32_153',['GetFloat32',['../classFloatValue.html#a1653ab3f4fa1700cf1b618ac6552ea81',1,'FloatValue::GetFloat32()'],['../classIntValue.html#ad0734e4cf67bac0bcc58251a4b3e56c4',1,'IntValue::GetFloat32()'],['../classListValue.html#a637fec02ed7f7325554e494fc7cd4e86',1,'ListValue::GetFloat32()'],['../classStringValue.html#a31fc4d2517a7454c1e9f329df2f14be7',1,'StringValue::GetFloat32()'],['../classValue.html#ac936fa09ba401a748ef67292ad823004',1,'Value::GetFloat32()'],['../classVoidValue.html#a6d39d2983e54e1a407c66e303273aa48',1,'VoidValue::GetFloat32()']]], - ['getfloat64_154',['GetFloat64',['../classFloatValue.html#add33b370ef691ccb2f0957d0fe4ef6f9',1,'FloatValue::GetFloat64()'],['../classIntValue.html#a5ceb2030e8a2a665953fdd4f1715e6a5',1,'IntValue::GetFloat64()'],['../classListValue.html#a571178db1c9d23f6c685ea8898dbb60e',1,'ListValue::GetFloat64()'],['../classStringValue.html#a74bedb828c901a4895062f62303b9653',1,'StringValue::GetFloat64()'],['../classValue.html#ac3d3a5b3ba7bf5aee0f41d19b242b7e8',1,'Value::GetFloat64()'],['../classVoidValue.html#a18b6f0d697c5f9286372a05927e4759c',1,'VoidValue::GetFloat64()']]], - ['getint32_155',['GetInt32',['../classFloatValue.html#a565741e80cd99a4d2af861ddc3c2dc99',1,'FloatValue::GetInt32()'],['../classIntValue.html#a163f21536fa49491aa0ae03c8091344a',1,'IntValue::GetInt32()'],['../classListValue.html#a565c2b86fcfb3a13de29e59d95a358e7',1,'ListValue::GetInt32()'],['../classStringValue.html#ac8b53a7792ff1ed048722e2e404f3e6b',1,'StringValue::GetInt32()'],['../classValue.html#afcbcf8a064895b6b9d2964aecee01f22',1,'Value::GetInt32()'],['../classVoidValue.html#a5b7f50c390ef8f3636ba211a72a78065',1,'VoidValue::GetInt32()']]], - ['getint64_156',['GetInt64',['../classFloatValue.html#a762520d504d4564c48cf3bbefbb0f183',1,'FloatValue::GetInt64()'],['../classIntValue.html#ae0643023dfd56eafe2e3da5a4ba13080',1,'IntValue::GetInt64()'],['../classListValue.html#a9a7a1161ddeb3e56eaafee5f10f75995',1,'ListValue::GetInt64()'],['../classStringValue.html#aabdc7d681945403d24df6a8fe27948af',1,'StringValue::GetInt64()'],['../classValue.html#a77229fe49da12240fbfbc6657101cb27',1,'Value::GetInt64()'],['../classVoidValue.html#a3806945596866f3630dc5426a6b55e58',1,'VoidValue::GetInt64()']]], - ['getlist_157',['GetList',['../classFloatValue.html#a60b2698f28f1aacac0b67b6453c89fd1',1,'FloatValue::GetList()'],['../classIntValue.html#acc74ba6070a516a4bcad10bb113d6fa2',1,'IntValue::GetList()'],['../classListValue.html#ad578d9088c0375cd9b9c6658e5d9ba1f',1,'ListValue::GetList()'],['../classStringValue.html#a2b2810350b5eb7e58062ad095320aa69',1,'StringValue::GetList()'],['../classValue.html#a930ca504a3e52e73f736a7e72f44e5ce',1,'Value::GetList()'],['../classVoidValue.html#aba53ae37d415959b583f33f3e381be16',1,'VoidValue::GetList()']]], - ['getstring_158',['GetString',['../classFloatValue.html#afd5d078683f410cb9d450c61f12f250d',1,'FloatValue::GetString()'],['../classIntValue.html#a3631e3b16f010889e942c0c0f72d403c',1,'IntValue::GetString()'],['../classListValue.html#aeaf80c07236045a77d72349ebcfc3b89',1,'ListValue::GetString()'],['../classStringValue.html#a7ed55493cfd25274f8571c1ea45f93e5',1,'StringValue::GetString()'],['../classValue.html#a1dd7df6be1d7298e5098a48622d0b65f',1,'Value::GetString()'],['../classVoidValue.html#a5af0c47a873b84226df47a90e63b2acd',1,'VoidValue::GetString()']]], - ['getvalue_159',['GetValue',['../classFloatValue.html#a2ad79d8bfe75e45120d1fce132a89b8f',1,'FloatValue::GetValue()'],['../classIntValue.html#a89967cafbdeb21362336067b772808c7',1,'IntValue::GetValue()'],['../classListValue.html#a7907ae7433e4011157f1b31dd5339702',1,'ListValue::GetValue()'],['../classParameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af',1,'Parameter::GetValue()'],['../classStringValue.html#a521a573887a3f31718f74e71ff01e86e',1,'StringValue::GetValue()']]] + ['getabbreviation_150',['GetAbbreviation',['../classHazelnp_1_1Hazelnupp.html#a579e78129f19cb9f17a6075366ababe5',1,'Hazelnp::Hazelnupp']]], + ['getasosstring_151',['GetAsOsString',['../classHazelnp_1_1FloatValue.html#a6c9a4b70a7618252f56d9062c483531c',1,'Hazelnp::FloatValue::GetAsOsString()'],['../classHazelnp_1_1IntValue.html#a7d7dbda9a051084600d3eabdac96ee45',1,'Hazelnp::IntValue::GetAsOsString()'],['../classHazelnp_1_1ListValue.html#a5b1f8af329e48c5469fee16634b7889c',1,'Hazelnp::ListValue::GetAsOsString()'],['../classHazelnp_1_1StringValue.html#a71869ee46b88a3cbb9571f481f0c216d',1,'Hazelnp::StringValue::GetAsOsString()'],['../classHazelnp_1_1Value.html#ae1fdc694ed1c2b3080ad3929efda0a0e',1,'Hazelnp::Value::GetAsOsString()'],['../classHazelnp_1_1VoidValue.html#a44b1917d9ba41ee91e2131432e01ec90',1,'Hazelnp::VoidValue::GetAsOsString()']]], + ['getcrashonfail_152',['GetCrashOnFail',['../classHazelnp_1_1Hazelnupp.html#a1b810cc7db2cf64aecaa70c686b14bb7',1,'Hazelnp::Hazelnupp']]], + ['getdatatype_153',['GetDataType',['../classHazelnp_1_1Value.html#adbb80bf6d455a316e6e5103353429993',1,'Hazelnp::Value']]], + ['getexecutablename_154',['GetExecutableName',['../classHazelnp_1_1Hazelnupp.html#af6bb41fb079131f8b91fe981f63f7469',1,'Hazelnp::Hazelnupp']]], + ['getfloat32_155',['GetFloat32',['../classHazelnp_1_1FloatValue.html#a1653ab3f4fa1700cf1b618ac6552ea81',1,'Hazelnp::FloatValue::GetFloat32()'],['../classHazelnp_1_1IntValue.html#ad0734e4cf67bac0bcc58251a4b3e56c4',1,'Hazelnp::IntValue::GetFloat32()'],['../classHazelnp_1_1ListValue.html#a637fec02ed7f7325554e494fc7cd4e86',1,'Hazelnp::ListValue::GetFloat32()'],['../classHazelnp_1_1StringValue.html#a31fc4d2517a7454c1e9f329df2f14be7',1,'Hazelnp::StringValue::GetFloat32()'],['../classHazelnp_1_1Value.html#a64eeb2943ccea6e16ce4e6f53a6e9b6d',1,'Hazelnp::Value::GetFloat32()'],['../classHazelnp_1_1VoidValue.html#a6d39d2983e54e1a407c66e303273aa48',1,'Hazelnp::VoidValue::GetFloat32()']]], + ['getfloat64_156',['GetFloat64',['../classHazelnp_1_1FloatValue.html#add33b370ef691ccb2f0957d0fe4ef6f9',1,'Hazelnp::FloatValue::GetFloat64()'],['../classHazelnp_1_1IntValue.html#a5ceb2030e8a2a665953fdd4f1715e6a5',1,'Hazelnp::IntValue::GetFloat64()'],['../classHazelnp_1_1ListValue.html#a571178db1c9d23f6c685ea8898dbb60e',1,'Hazelnp::ListValue::GetFloat64()'],['../classHazelnp_1_1StringValue.html#a74bedb828c901a4895062f62303b9653',1,'Hazelnp::StringValue::GetFloat64()'],['../classHazelnp_1_1Value.html#af645b9d78970d102360be37fc18e9e8a',1,'Hazelnp::Value::GetFloat64()'],['../classHazelnp_1_1VoidValue.html#a18b6f0d697c5f9286372a05927e4759c',1,'Hazelnp::VoidValue::GetFloat64()']]], + ['getint32_157',['GetInt32',['../classHazelnp_1_1FloatValue.html#a565741e80cd99a4d2af861ddc3c2dc99',1,'Hazelnp::FloatValue::GetInt32()'],['../classHazelnp_1_1IntValue.html#a163f21536fa49491aa0ae03c8091344a',1,'Hazelnp::IntValue::GetInt32()'],['../classHazelnp_1_1ListValue.html#a565c2b86fcfb3a13de29e59d95a358e7',1,'Hazelnp::ListValue::GetInt32()'],['../classHazelnp_1_1StringValue.html#ac8b53a7792ff1ed048722e2e404f3e6b',1,'Hazelnp::StringValue::GetInt32()'],['../classHazelnp_1_1Value.html#a2cb73333bdeca657dfbf6c8b2e50a5ef',1,'Hazelnp::Value::GetInt32()'],['../classHazelnp_1_1VoidValue.html#a5b7f50c390ef8f3636ba211a72a78065',1,'Hazelnp::VoidValue::GetInt32()']]], + ['getint64_158',['GetInt64',['../classHazelnp_1_1FloatValue.html#a762520d504d4564c48cf3bbefbb0f183',1,'Hazelnp::FloatValue::GetInt64()'],['../classHazelnp_1_1IntValue.html#ae0643023dfd56eafe2e3da5a4ba13080',1,'Hazelnp::IntValue::GetInt64()'],['../classHazelnp_1_1ListValue.html#a9a7a1161ddeb3e56eaafee5f10f75995',1,'Hazelnp::ListValue::GetInt64()'],['../classHazelnp_1_1StringValue.html#aabdc7d681945403d24df6a8fe27948af',1,'Hazelnp::StringValue::GetInt64()'],['../classHazelnp_1_1Value.html#a92d75905211e964cb900bdc868ed12a7',1,'Hazelnp::Value::GetInt64()'],['../classHazelnp_1_1VoidValue.html#a3806945596866f3630dc5426a6b55e58',1,'Hazelnp::VoidValue::GetInt64()']]], + ['getlist_159',['GetList',['../classHazelnp_1_1FloatValue.html#a60b2698f28f1aacac0b67b6453c89fd1',1,'Hazelnp::FloatValue::GetList()'],['../classHazelnp_1_1IntValue.html#acc74ba6070a516a4bcad10bb113d6fa2',1,'Hazelnp::IntValue::GetList()'],['../classHazelnp_1_1ListValue.html#ad578d9088c0375cd9b9c6658e5d9ba1f',1,'Hazelnp::ListValue::GetList()'],['../classHazelnp_1_1StringValue.html#a2b2810350b5eb7e58062ad095320aa69',1,'Hazelnp::StringValue::GetList()'],['../classHazelnp_1_1Value.html#a358092f951e817cd2a878225b5b1c869',1,'Hazelnp::Value::GetList()'],['../classHazelnp_1_1VoidValue.html#aba53ae37d415959b583f33f3e381be16',1,'Hazelnp::VoidValue::GetList()']]], + ['getstring_160',['GetString',['../classHazelnp_1_1FloatValue.html#afd5d078683f410cb9d450c61f12f250d',1,'Hazelnp::FloatValue::GetString()'],['../classHazelnp_1_1IntValue.html#a3631e3b16f010889e942c0c0f72d403c',1,'Hazelnp::IntValue::GetString()'],['../classHazelnp_1_1ListValue.html#aeaf80c07236045a77d72349ebcfc3b89',1,'Hazelnp::ListValue::GetString()'],['../classHazelnp_1_1StringValue.html#a7ed55493cfd25274f8571c1ea45f93e5',1,'Hazelnp::StringValue::GetString()'],['../classHazelnp_1_1Value.html#a1446705c062026f03866d0f452c39501',1,'Hazelnp::Value::GetString()'],['../classHazelnp_1_1VoidValue.html#a5af0c47a873b84226df47a90e63b2acd',1,'Hazelnp::VoidValue::GetString()']]], + ['getvalue_161',['GetValue',['../classHazelnp_1_1FloatValue.html#a2ad79d8bfe75e45120d1fce132a89b8f',1,'Hazelnp::FloatValue::GetValue()'],['../classHazelnp_1_1IntValue.html#a89967cafbdeb21362336067b772808c7',1,'Hazelnp::IntValue::GetValue()'],['../classHazelnp_1_1ListValue.html#a7907ae7433e4011157f1b31dd5339702',1,'Hazelnp::ListValue::GetValue()'],['../classHazelnp_1_1Parameter.html#a4ab8ba022bde4a0175e5ceb8e3a598af',1,'Hazelnp::Parameter::GetValue()'],['../classHazelnp_1_1StringValue.html#a521a573887a3f31718f74e71ff01e86e',1,'Hazelnp::StringValue::GetValue()']]] ]; diff --git a/docs/search/functions_5.js b/docs/search/functions_5.js index 251355b..464c98d 100644 --- a/docs/search/functions_5.js +++ b/docs/search/functions_5.js @@ -1,12 +1,12 @@ var searchData= [ - ['hasabbreviation_160',['HasAbbreviation',['../classHazelnupp.html#a46df7d396fb56e30351c9a7308792200',1,'Hazelnupp']]], - ['hasparam_161',['HasParam',['../classHazelnupp.html#a8b79a79d40420ae748c108c691111040',1,'Hazelnupp']]], - ['hazelnupp_162',['Hazelnupp',['../classHazelnupp.html#a20ac0ebcfd4df7f320a7bbcaeed6e54d',1,'Hazelnupp::Hazelnupp()'],['../classHazelnupp.html#a6d14c60f03b571f5f794c3549e75e435',1,'Hazelnupp::Hazelnupp(const int argc, const char *const *argv)']]], - ['hazelnuppconstraintexception_163',['HazelnuppConstraintException',['../classHazelnuppConstraintException.html#ad434d9b9d78d36cc4008bad70270f844',1,'HazelnuppConstraintException::HazelnuppConstraintException()'],['../classHazelnuppConstraintException.html#a1bf58e4aa510f3e5cdebdfcbff2a1e53',1,'HazelnuppConstraintException::HazelnuppConstraintException(const std::string &msg)']]], - ['hazelnuppconstraintmissingvalue_164',['HazelnuppConstraintMissingValue',['../classHazelnuppConstraintMissingValue.html#a022da2aca494f6853a7c013e94f5796f',1,'HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue()'],['../classHazelnuppConstraintMissingValue.html#a8d3ea192a75f993abe2845444cdb1bca',1,'HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue(const std::string &msg)']]], - ['hazelnuppconstrainttypemissmatch_165',['HazelnuppConstraintTypeMissmatch',['../classHazelnuppConstraintTypeMissmatch.html#aa81de4d809dd7b00516716574e959c09',1,'HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch()'],['../classHazelnuppConstraintTypeMissmatch.html#ab8d0f32a3423239e06d8c44631098306',1,'HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch(const std::string &msg)']]], - ['hazelnuppexception_166',['HazelnuppException',['../classHazelnuppException.html#a90d10b00ec056b721c102a70b629a779',1,'HazelnuppException::HazelnuppException()'],['../classHazelnuppException.html#a864a84c0498870ae0a76fb8c3542fa74',1,'HazelnuppException::HazelnuppException(const std::string &msg)']]], - ['hazelnuppinvalidkeyexception_167',['HazelnuppInvalidKeyException',['../classHazelnuppInvalidKeyException.html#ac0c3a84356647817b5076f92e55874e7',1,'HazelnuppInvalidKeyException::HazelnuppInvalidKeyException()'],['../classHazelnuppInvalidKeyException.html#a5be8550858e8ba5754958055803120bc',1,'HazelnuppInvalidKeyException::HazelnuppInvalidKeyException(const std::string &msg)']]], - ['hazelnuppvaluenotconvertibleexception_168',['HazelnuppValueNotConvertibleException',['../classHazelnuppValueNotConvertibleException.html#a459233c9ed4ca577f596761abb2f46e7',1,'HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException()'],['../classHazelnuppValueNotConvertibleException.html#a77dfcc974a767b77aefdaef86e9ad60c',1,'HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException(const std::string &msg)']]] + ['hasabbreviation_162',['HasAbbreviation',['../classHazelnp_1_1Hazelnupp.html#a46df7d396fb56e30351c9a7308792200',1,'Hazelnp::Hazelnupp']]], + ['hasparam_163',['HasParam',['../classHazelnp_1_1Hazelnupp.html#a8b79a79d40420ae748c108c691111040',1,'Hazelnp::Hazelnupp']]], + ['hazelnupp_164',['Hazelnupp',['../classHazelnp_1_1Hazelnupp.html#a20ac0ebcfd4df7f320a7bbcaeed6e54d',1,'Hazelnp::Hazelnupp::Hazelnupp()'],['../classHazelnp_1_1Hazelnupp.html#a6d14c60f03b571f5f794c3549e75e435',1,'Hazelnp::Hazelnupp::Hazelnupp(const int argc, const char *const *argv)']]], + ['hazelnuppconstraintexception_165',['HazelnuppConstraintException',['../classHazelnp_1_1HazelnuppConstraintException.html#a4d08002a96bf9b3da3c6e931a51960e9',1,'Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException()'],['../classHazelnp_1_1HazelnuppConstraintException.html#a944f0e6a384e032a762c5892964e1cc0',1,'Hazelnp::HazelnuppConstraintException::HazelnuppConstraintException(const std::string &msg)']]], + ['hazelnuppconstraintmissingvalue_166',['HazelnuppConstraintMissingValue',['../classHazelnp_1_1HazelnuppConstraintMissingValue.html#aad4a7b5573790ddfbe1a453aef71eb10',1,'Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue()'],['../classHazelnp_1_1HazelnuppConstraintMissingValue.html#a20563650ba1ee63f23ddb973677dbdda',1,'Hazelnp::HazelnuppConstraintMissingValue::HazelnuppConstraintMissingValue(const std::string &msg)']]], + ['hazelnuppconstrainttypemissmatch_167',['HazelnuppConstraintTypeMissmatch',['../classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html#ab7c9e9afd9d3286e563a7656785242e8',1,'Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch()'],['../classHazelnp_1_1HazelnuppConstraintTypeMissmatch.html#a603d91c9af39e53b54e5aa288266cfe4',1,'Hazelnp::HazelnuppConstraintTypeMissmatch::HazelnuppConstraintTypeMissmatch(const std::string &msg)']]], + ['hazelnuppexception_168',['HazelnuppException',['../classHazelnp_1_1HazelnuppException.html#a0b21fd5d4f22e5e677b74eb0acd7c6ff',1,'Hazelnp::HazelnuppException::HazelnuppException()'],['../classHazelnp_1_1HazelnuppException.html#a816f823fe2ebd35076049e33b9f3c05c',1,'Hazelnp::HazelnuppException::HazelnuppException(const std::string &msg)']]], + ['hazelnuppinvalidkeyexception_169',['HazelnuppInvalidKeyException',['../classHazelnp_1_1HazelnuppInvalidKeyException.html#ab23be8f7cb84129fa85ed1e7a0b280a0',1,'Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException()'],['../classHazelnp_1_1HazelnuppInvalidKeyException.html#a18a08dc4efe80a378216460db5769891',1,'Hazelnp::HazelnuppInvalidKeyException::HazelnuppInvalidKeyException(const std::string &msg)']]], + ['hazelnuppvaluenotconvertibleexception_170',['HazelnuppValueNotConvertibleException',['../classHazelnp_1_1HazelnuppValueNotConvertibleException.html#a0babee1bb5cec9fdd4abfd86995561f4',1,'Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException()'],['../classHazelnp_1_1HazelnuppValueNotConvertibleException.html#a7ba376cd7fc7edcb934ee0257d4867f2',1,'Hazelnp::HazelnuppValueNotConvertibleException::HazelnuppValueNotConvertibleException(const std::string &msg)']]] ]; diff --git a/docs/search/functions_6.js b/docs/search/functions_6.js index af8f33a..7f6c910 100644 --- a/docs/search/functions_6.js +++ b/docs/search/functions_6.js @@ -1,5 +1,5 @@ var searchData= [ - ['intvalue_169',['IntValue',['../classIntValue.html#ac1174f807ce2c085f5a24baed4e3c1ba',1,'IntValue']]], - ['isnumeric_170',['IsNumeric',['../classStringTools.html#a6cd093feaca2d978c23774cf87d86e68',1,'StringTools']]] + ['intvalue_171',['IntValue',['../classHazelnp_1_1IntValue.html#ac1174f807ce2c085f5a24baed4e3c1ba',1,'Hazelnp::IntValue']]], + ['isnumeric_172',['IsNumeric',['../classHazelnp_1_1StringTools.html#a6cd093feaca2d978c23774cf87d86e68',1,'Hazelnp::StringTools']]] ]; diff --git a/docs/search/functions_7.js b/docs/search/functions_7.js index f4dc9af..900d26d 100644 --- a/docs/search/functions_7.js +++ b/docs/search/functions_7.js @@ -1,4 +1,4 @@ var searchData= [ - ['key_171',['Key',['../classParameter.html#a7acd68ce06eec06ab286b1a062f9c8d6',1,'Parameter']]] + ['key_173',['Key',['../classHazelnp_1_1Parameter.html#a7acd68ce06eec06ab286b1a062f9c8d6',1,'Hazelnp::Parameter']]] ]; diff --git a/docs/search/functions_8.js b/docs/search/functions_8.js index 5e5dcc8..54eb0c6 100644 --- a/docs/search/functions_8.js +++ b/docs/search/functions_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['listvalue_172',['ListValue',['../classListValue.html#a6082aaa506b31496720a168da8ab2708',1,'ListValue']]] + ['listvalue_174',['ListValue',['../classHazelnp_1_1ListValue.html#a6082aaa506b31496720a168da8ab2708',1,'Hazelnp::ListValue']]] ]; diff --git a/docs/search/functions_9.js b/docs/search/functions_9.js index 4a7c66c..4c19103 100644 --- a/docs/search/functions_9.js +++ b/docs/search/functions_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['main_173',['main',['../main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627',1,'main.cpp']]] + ['main_175',['main',['../main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627',1,'main.cpp']]] ]; diff --git a/docs/search/functions_a.js b/docs/search/functions_a.js index daf5de5..47ac738 100644 --- a/docs/search/functions_a.js +++ b/docs/search/functions_a.js @@ -1,10 +1,10 @@ var searchData= [ - ['operator_20double_174',['operator double',['../classFloatValue.html#ae02de376bbb2b76e0f9d16b1fc4de06d',1,'FloatValue']]], - ['operator_20int_175',['operator int',['../classIntValue.html#ab30a38c8f58cefd7cbf365c4aeae79bd',1,'IntValue']]], - ['operator_20long_20double_176',['operator long double',['../classFloatValue.html#ad0d4c589190fbab7e6c4d8fcc130ac1b',1,'FloatValue']]], - ['operator_20long_20long_20int_177',['operator long long int',['../classIntValue.html#a45b283dae9904ad0643035d3ee5883eb',1,'IntValue']]], - ['operator_5b_5d_178',['operator[]',['../classHazelnupp.html#a419ccdc6bad00b0fc3e17ed9b41f5dc5',1,'Hazelnupp']]], - ['string_179',['string',['../classStringValue.html#a23449775f14f828d29b115de040a696b',1,'StringValue']]], - ['vector_3c_20value_20_2a_20_3e_180',['vector< Value * >',['../classListValue.html#a5d92ff2b9a1fa92fbc303ac4d07765d0',1,'ListValue']]] + ['operator_20double_176',['operator double',['../classHazelnp_1_1FloatValue.html#ae02de376bbb2b76e0f9d16b1fc4de06d',1,'Hazelnp::FloatValue']]], + ['operator_20int_177',['operator int',['../classHazelnp_1_1IntValue.html#ab30a38c8f58cefd7cbf365c4aeae79bd',1,'Hazelnp::IntValue']]], + ['operator_20long_20double_178',['operator long double',['../classHazelnp_1_1FloatValue.html#ad0d4c589190fbab7e6c4d8fcc130ac1b',1,'Hazelnp::FloatValue']]], + ['operator_20long_20long_20int_179',['operator long long int',['../classHazelnp_1_1IntValue.html#a45b283dae9904ad0643035d3ee5883eb',1,'Hazelnp::IntValue']]], + ['operator_5b_5d_180',['operator[]',['../classHazelnp_1_1Hazelnupp.html#a419ccdc6bad00b0fc3e17ed9b41f5dc5',1,'Hazelnp::Hazelnupp']]], + ['string_181',['string',['../classHazelnp_1_1StringValue.html#a23449775f14f828d29b115de040a696b',1,'Hazelnp::StringValue']]], + ['vector_3c_20value_20_2a_20_3e_182',['vector< Value * >',['../classHazelnp_1_1ListValue.html#a5d92ff2b9a1fa92fbc303ac4d07765d0',1,'Hazelnp::ListValue']]] ]; diff --git a/docs/search/functions_b.js b/docs/search/functions_b.js index f566dba..f3663fd 100644 --- a/docs/search/functions_b.js +++ b/docs/search/functions_b.js @@ -1,7 +1,7 @@ var searchData= [ - ['paramconstraint_181',['ParamConstraint',['../structParamConstraint.html#ae0ce64f2f0928d602b6f6117ff34d155',1,'ParamConstraint::ParamConstraint()=default'],['../structParamConstraint.html#a93783114c6f374b77479a283c4aadf05',1,'ParamConstraint::ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)']]], - ['parameter_182',['Parameter',['../classParameter.html#a0c9faefc26cc9d8c886ef71e39e2f90c',1,'Parameter']]], - ['parse_183',['Parse',['../classHazelnupp.html#a1ccb88faca1a8deb77161888479c300b',1,'Hazelnupp']]], - ['parsenumber_184',['ParseNumber',['../classStringTools.html#ab661223da5bbbb75039e168409466c82',1,'StringTools']]] + ['paramconstraint_183',['ParamConstraint',['../structHazelnp_1_1ParamConstraint.html#afa9e1b4378c9fa1b4a7b5b792c062cbe',1,'Hazelnp::ParamConstraint::ParamConstraint()=default'],['../structHazelnp_1_1ParamConstraint.html#ab2a897c3044ae2d1a05952a804a3675b',1,'Hazelnp::ParamConstraint::ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)']]], + ['parameter_184',['Parameter',['../classHazelnp_1_1Parameter.html#a0c9faefc26cc9d8c886ef71e39e2f90c',1,'Hazelnp::Parameter']]], + ['parse_185',['Parse',['../classHazelnp_1_1Hazelnupp.html#a1ccb88faca1a8deb77161888479c300b',1,'Hazelnp::Hazelnupp']]], + ['parsenumber_186',['ParseNumber',['../classHazelnp_1_1StringTools.html#ab661223da5bbbb75039e168409466c82',1,'Hazelnp::StringTools']]] ]; diff --git a/docs/search/functions_c.js b/docs/search/functions_c.js index b9c2a82..7a63165 100644 --- a/docs/search/functions_c.js +++ b/docs/search/functions_c.js @@ -1,7 +1,7 @@ var searchData= [ - ['registerabbreviation_185',['RegisterAbbreviation',['../classHazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124',1,'Hazelnupp']]], - ['registerconstraints_186',['RegisterConstraints',['../classHazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5',1,'Hazelnupp']]], - ['replace_187',['Replace',['../classStringTools.html#a0ca14c1d67833a61955a693f3e40d8b5',1,'StringTools::Replace(const std::string &str, const char find, const std::string &subst)'],['../classStringTools.html#a1658832ddf1611f83c5848e391d32806',1,'StringTools::Replace(const std::string &str, const std::string &find, const std::string &subst)']]], - ['require_188',['Require',['../structParamConstraint.html#a40e47d3ad68cadbe785551c4aaad828c',1,'ParamConstraint']]] + ['registerabbreviation_187',['RegisterAbbreviation',['../classHazelnp_1_1Hazelnupp.html#abf1e0ebf0207ca2327fcde81f7372124',1,'Hazelnp::Hazelnupp']]], + ['registerconstraints_188',['RegisterConstraints',['../classHazelnp_1_1Hazelnupp.html#a8a3331836b9ea1f920e77f6d332019d5',1,'Hazelnp::Hazelnupp']]], + ['replace_189',['Replace',['../classHazelnp_1_1StringTools.html#a0ca14c1d67833a61955a693f3e40d8b5',1,'Hazelnp::StringTools::Replace(const std::string &str, const char find, const std::string &subst)'],['../classHazelnp_1_1StringTools.html#a1658832ddf1611f83c5848e391d32806',1,'Hazelnp::StringTools::Replace(const std::string &str, const std::string &find, const std::string &subst)']]], + ['require_190',['Require',['../structHazelnp_1_1ParamConstraint.html#afbcc75c428381ab3a292d3f55945eb32',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/functions_d.js b/docs/search/functions_d.js index 4ff6924..3b171ca 100644 --- a/docs/search/functions_d.js +++ b/docs/search/functions_d.js @@ -1,6 +1,6 @@ var searchData= [ - ['setcrashonfail_189',['SetCrashOnFail',['../classHazelnupp.html#a17845623ca686caa51f3c8254e85551e',1,'Hazelnupp']]], - ['splitstring_190',['SplitString',['../classStringTools.html#a7cd6606ef06170fab363024e457f1f16',1,'StringTools::SplitString(const std::string &str, const char delimiter)'],['../classStringTools.html#afe626a56fa486afcb0e4c01d3c1ccb35',1,'StringTools::SplitString(const std::string &str, const std::string &delimiter)']]], - ['stringvalue_191',['StringValue',['../classStringValue.html#a24dad2deec92b51bf60a11400cc8c204',1,'StringValue']]] + ['setcrashonfail_191',['SetCrashOnFail',['../classHazelnp_1_1Hazelnupp.html#a17845623ca686caa51f3c8254e85551e',1,'Hazelnp::Hazelnupp']]], + ['splitstring_192',['SplitString',['../classHazelnp_1_1StringTools.html#a7cd6606ef06170fab363024e457f1f16',1,'Hazelnp::StringTools::SplitString(const std::string &str, const char delimiter)'],['../classHazelnp_1_1StringTools.html#afe626a56fa486afcb0e4c01d3c1ccb35',1,'Hazelnp::StringTools::SplitString(const std::string &str, const std::string &delimiter)']]], + ['stringvalue_193',['StringValue',['../classHazelnp_1_1StringValue.html#a24dad2deec92b51bf60a11400cc8c204',1,'Hazelnp::StringValue']]] ]; diff --git a/docs/search/functions_e.js b/docs/search/functions_e.js index e32c6df..171a249 100644 --- a/docs/search/functions_e.js +++ b/docs/search/functions_e.js @@ -1,5 +1,5 @@ var searchData= [ - ['tolower_192',['ToLower',['../classStringTools.html#a67edf755685f59b51f7416d9e4f6e2bd',1,'StringTools']]], - ['typesafety_193',['TypeSafety',['../structParamConstraint.html#a3ecbccdce5be2529712e0866725c7cd5',1,'ParamConstraint']]] + ['tolower_194',['ToLower',['../classHazelnp_1_1StringTools.html#a67edf755685f59b51f7416d9e4f6e2bd',1,'Hazelnp::StringTools']]], + ['typesafety_195',['TypeSafety',['../structHazelnp_1_1ParamConstraint.html#ab85210bb37bbace962ff08fcccdafaf2',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/functions_f.js b/docs/search/functions_f.js index 3aa82da..4da3e75 100644 --- a/docs/search/functions_f.js +++ b/docs/search/functions_f.js @@ -1,5 +1,5 @@ var searchData= [ - ['value_194',['Value',['../classValue.html#a8455d65bb2d939e850d6772dfbf8bfec',1,'Value']]], - ['voidvalue_195',['VoidValue',['../classVoidValue.html#a75abf334b7f55cd149d2bb1962f2d8f1',1,'VoidValue']]] + ['value_196',['Value',['../classHazelnp_1_1Value.html#a8455d65bb2d939e850d6772dfbf8bfec',1,'Hazelnp::Value']]], + ['voidvalue_197',['VoidValue',['../classHazelnp_1_1VoidValue.html#a75abf334b7f55cd149d2bb1962f2d8f1',1,'Hazelnp::VoidValue']]] ]; diff --git a/docs/search/namespaces_0.js b/docs/search/namespaces_0.js index 64e386d..ced46a7 100644 --- a/docs/search/namespaces_0.js +++ b/docs/search/namespaces_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['testhazelnupp_127',['TestHazelnupp',['../namespaceTestHazelnupp.html',1,'']]] + ['hazelnp_119',['Hazelnp',['../namespaceHazelnp.html',1,'']]] ]; diff --git a/docs/search/pages_0.js b/docs/search/pages_0.js index aab9f33..cf3346b 100644 --- a/docs/search/pages_0.js +++ b/docs/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['hazelnupp_219',['Hazelnupp',['../index.html',1,'']]] + ['hazelnupp_221',['Hazelnupp',['../index.html',1,'']]] ]; diff --git a/docs/search/related_0.js b/docs/search/related_0.js index 5118e64..7c0444a 100644 --- a/docs/search/related_0.js +++ b/docs/search/related_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['operator_3c_3c_218',['operator<<',['../classParameter.html#a11b3529badcbf99b46262772472495c7',1,'Parameter::operator<<()'],['../classValue.html#ad29db86c4a2dec5bc8d0006031b07211',1,'Value::operator<<()']]] + ['operator_3c_3c_220',['operator<<',['../classHazelnp_1_1Parameter.html#a11b3529badcbf99b46262772472495c7',1,'Hazelnp::Parameter::operator<<()'],['../classHazelnp_1_1Value.html#ad29db86c4a2dec5bc8d0006031b07211',1,'Hazelnp::Value::operator<<()']]] ]; diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js index 8675105..ec500cc 100644 --- a/docs/search/searchdata.js +++ b/docs/search/searchdata.js @@ -2,38 +2,41 @@ var indexSectionsWithContent = { 0: "acdfghiklmoprstvw~", 1: "fhilpsv", - 2: "dfhilmpsv", - 3: "acdfghiklmoprstvw~", - 4: "cdkmrtw", - 5: "d", - 6: "filsv", - 7: "o", - 8: "h" + 2: "h", + 3: "dfhilmpsv", + 4: "acdfghiklmoprstvw~", + 5: "cdkmrtw", + 6: "d", + 7: "filsv", + 8: "o", + 9: "h" }; var indexSectionNames = { 0: "all", 1: "classes", - 2: "files", - 3: "functions", - 4: "variables", - 5: "enums", - 6: "enumvalues", - 7: "related", - 8: "pages" + 2: "namespaces", + 3: "files", + 4: "functions", + 5: "variables", + 6: "enums", + 7: "enumvalues", + 8: "related", + 9: "pages" }; var indexSectionLabels = { 0: "All", 1: "Classes", - 2: "Files", - 3: "Functions", - 4: "Variables", - 5: "Enumerations", - 6: "Enumerator", - 7: "Friends", - 8: "Pages" + 2: "Namespaces", + 3: "Files", + 4: "Functions", + 5: "Variables", + 6: "Enumerations", + 7: "Enumerator", + 8: "Friends", + 9: "Pages" }; diff --git a/docs/search/variables_0.js b/docs/search/variables_0.js index 832526a..a68932f 100644 --- a/docs/search/variables_0.js +++ b/docs/search/variables_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['constraintype_205',['constrainType',['../structParamConstraint.html#ab35444d2957439bc52c2056a829145a2',1,'ParamConstraint']]] + ['constraintype_207',['constrainType',['../structHazelnp_1_1ParamConstraint.html#a88a4a4c215723259c71853992d09acac',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/variables_1.js b/docs/search/variables_1.js index 004718a..3ca5697 100644 --- a/docs/search/variables_1.js +++ b/docs/search/variables_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['defaultvalue_206',['defaultValue',['../structParamConstraint.html#af2832fa007abaabc05784d5f978aeeff',1,'ParamConstraint']]] + ['defaultvalue_208',['defaultValue',['../structHazelnp_1_1ParamConstraint.html#a1d3a627b3a23fe0db3a368e51dbcd5a7',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/variables_2.js b/docs/search/variables_2.js index 0c425f6..ded0607 100644 --- a/docs/search/variables_2.js +++ b/docs/search/variables_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['key_207',['key',['../structParamConstraint.html#aa3bd052bbaebdc795f0922731c666648',1,'ParamConstraint']]] + ['key_209',['key',['../structHazelnp_1_1ParamConstraint.html#aac148076c5e0ab91c666f3343c30bd15',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/variables_3.js b/docs/search/variables_3.js index b4d8b0c..2c5aa7a 100644 --- a/docs/search/variables_3.js +++ b/docs/search/variables_3.js @@ -1,4 +1,4 @@ var searchData= [ - ['message_208',['message',['../classHazelnuppException.html#a4d80f59d2732975461ee480642c4addf',1,'HazelnuppException']]] + ['message_210',['message',['../classHazelnp_1_1HazelnuppException.html#aa905cabcd12f542dfc67638732737e88',1,'Hazelnp::HazelnuppException']]] ]; diff --git a/docs/search/variables_4.js b/docs/search/variables_4.js index ffd0305..780c607 100644 --- a/docs/search/variables_4.js +++ b/docs/search/variables_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['required_209',['required',['../structParamConstraint.html#a5c451d5ade6c548af7de0a978964a09d',1,'ParamConstraint']]] + ['required_211',['required',['../structHazelnp_1_1ParamConstraint.html#a8ccf3ebecc2d9d0105e181814af2943c',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/search/variables_5.js b/docs/search/variables_5.js index ad10206..129e128 100644 --- a/docs/search/variables_5.js +++ b/docs/search/variables_5.js @@ -1,4 +1,4 @@ var searchData= [ - ['type_210',['type',['../classValue.html#a1d097dc84691b48d12435c6bf97c85b4',1,'Value']]] + ['type_212',['type',['../classHazelnp_1_1Value.html#ae5760a30c237095db595c466372e3c23',1,'Hazelnp::Value']]] ]; diff --git a/docs/search/variables_6.js b/docs/search/variables_6.js index 58a7e55..818ec56 100644 --- a/docs/search/variables_6.js +++ b/docs/search/variables_6.js @@ -1,4 +1,4 @@ var searchData= [ - ['wantedtype_211',['wantedType',['../structParamConstraint.html#ae8875e054a074241f0c0bf3328a0915a',1,'ParamConstraint']]] + ['wantedtype_213',['wantedType',['../structHazelnp_1_1ParamConstraint.html#ac07a0c0555431d4b1e0bc6afdba41329',1,'Hazelnp::ParamConstraint']]] ]; diff --git a/docs/structHazelnp_1_1ParamConstraint-members.html b/docs/structHazelnp_1_1ParamConstraint-members.html new file mode 100644 index 0000000..6ad1229 --- /dev/null +++ b/docs/structHazelnp_1_1ParamConstraint-members.html @@ -0,0 +1,101 @@ + + + + + + + +Leonetienne/Hazelnupp: Member List + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
Hazelnp::ParamConstraint Member List
+
+
+ +

This is the complete list of members for Hazelnp::ParamConstraint, including all inherited members.

+ + + + + + + + + + +
constrainTypeHazelnp::ParamConstraint
defaultValueHazelnp::ParamConstraint
keyHazelnp::ParamConstraint
ParamConstraint()=defaultHazelnp::ParamConstraint
ParamConstraint(const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)Hazelnp::ParamConstraintinline
Require(const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)Hazelnp::ParamConstraintinlinestatic
requiredHazelnp::ParamConstraint
TypeSafety(const std::string &key, DATA_TYPE wantedType, bool constrainType=true)Hazelnp::ParamConstraintinlinestatic
wantedTypeHazelnp::ParamConstraint
+ + + + diff --git a/docs/structHazelnp_1_1ParamConstraint.html b/docs/structHazelnp_1_1ParamConstraint.html new file mode 100644 index 0000000..dfb7960 --- /dev/null +++ b/docs/structHazelnp_1_1ParamConstraint.html @@ -0,0 +1,459 @@ + + + + + + + +Leonetienne/Hazelnupp: Hazelnp::ParamConstraint Struct Reference + + + + + + + + + + + +
+
+ + + + + + + +
+
Leonetienne/Hazelnupp +
+
Simple, easy to use, command line parameter interface
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +Public Attributes | +List of all members
+
+
Hazelnp::ParamConstraint Struct Reference
+
+
+ +

#include <ParamConstraint.h>

+
+Collaboration diagram for Hazelnp::ParamConstraint:
+
+
Collaboration graph
+ + + + + + +
[legend]
+ + + + + + + + +

+Public Member Functions

 ParamConstraint ()=default
 Empty constructor. More...
 
 ParamConstraint (const std::string &key, bool constrainType, DATA_TYPE wantedType, const std::vector< std::string > &defaultValue, bool required)
 Whole constructor. More...
 
+ + + + + + + +

+Static Public Member Functions

static ParamConstraint Require (const std::string &key, const std::vector< std::string > &defaultValue={}, bool required=true)
 Constructs a require constraint. More...
 
static ParamConstraint TypeSafety (const std::string &key, DATA_TYPE wantedType, bool constrainType=true)
 Constructs a type-safety constraint. More...
 
+ + + + + + + + + + + + + + + + +

+Public Attributes

std::string key
 The key of the parameter to constrain. More...
 
bool constrainType = false
 Should this parameter be forced to be of a certain type?
+ Remember to set constrainTo to the wanted type. More...
 
DATA_TYPE wantedType = DATA_TYPE::VOID
 Constrain the parameter to this value. Requires constrainType to be set to true. More...
 
std::vector< std::string > defaultValue
 The default value for this parameter. More...
 
bool required = false
 If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user. More...
 
+

Detailed Description

+
+

Definition at line 8 of file ParamConstraint.h.

+

Constructor & Destructor Documentation

+ +

◆ ParamConstraint() [1/2]

+ +
+
+ + + + + +
+ + + + + + + +
Hazelnp::ParamConstraint::ParamConstraint ()
+
+default
+
+ +

Empty constructor.

+ +
+
+ +

◆ ParamConstraint() [2/2]

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Hazelnp::ParamConstraint::ParamConstraint (const std::string & key,
bool constrainType,
DATA_TYPE wantedType,
const std::vector< std::string > & defaultValue,
bool required 
)
+
+inline
+
+ +

Whole constructor.

+ +

Definition at line 38 of file ParamConstraint.h.

+
39  :
+
40  key{ key },
+ + + + +
45  {
+
46  return;
+
47  }
+
+
+
+

Member Function Documentation

+ +

◆ Require()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
static ParamConstraint Hazelnp::ParamConstraint::Require (const std::string & key,
const std::vector< std::string > & defaultValue = {},
bool required = true 
)
+
+inlinestatic
+
+ +

Constructs a require constraint.

+


+ Think of the default value like of a list ofparameters. Like {"--width", "800"}

+ +

Definition at line 16 of file ParamConstraint.h.

+
16  {}, bool required = true)
+
17  {
+
18  ParamConstraint pc;
+
19  pc.key = key;
+
20  pc.defaultValue = defaultValue;
+
21  pc.required = required;
+
22 
+
23  return pc;
+
24  }
+
+
+
+ +

◆ TypeSafety()

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
static ParamConstraint Hazelnp::ParamConstraint::TypeSafety (const std::string & key,
DATA_TYPE wantedType,
bool constrainType = true 
)
+
+inlinestatic
+
+ +

Constructs a type-safety constraint.

+ +

Definition at line 27 of file ParamConstraint.h.

+
28  {
+
29  ParamConstraint pc;
+
30  pc.key = key;
+
31  pc.constrainType = constrainType;
+
32  pc.wantedType = wantedType;
+
33 
+
34  return pc;
+
35  }
+
+
+
+

Member Data Documentation

+ +

◆ constrainType

+ +
+
+ + + + +
bool Hazelnp::ParamConstraint::constrainType = false
+
+ +

Should this parameter be forced to be of a certain type?
+ Remember to set constrainTo to the wanted type.

+ +

Definition at line 54 of file ParamConstraint.h.

+ +
+
+ +

◆ defaultValue

+ +
+
+ + + + +
std::vector<std::string> Hazelnp::ParamConstraint::defaultValue
+
+ +

The default value for this parameter.

+


+ Gets applied if this parameter was not given.
+ Think of this like a list of parameters. Like {"--width", "800"}

+ +

Definition at line 62 of file ParamConstraint.h.

+ +
+
+ +

◆ key

+ +
+
+ + + + +
std::string Hazelnp::ParamConstraint::key
+
+ +

The key of the parameter to constrain.

+ +

Definition at line 50 of file ParamConstraint.h.

+ +
+
+ +

◆ required

+ +
+
+ + + + +
bool Hazelnp::ParamConstraint::required = false
+
+ +

If set to true, and no default value set, an error will be produced if this parameter is not supplied by the user.

+ +

Definition at line 66 of file ParamConstraint.h.

+ +
+
+ +

◆ wantedType

+ +
+
+ + + + +
DATA_TYPE Hazelnp::ParamConstraint::wantedType = DATA_TYPE::VOID
+
+ +

Constrain the parameter to this value. Requires constrainType to be set to true.

+ +

Definition at line 57 of file ParamConstraint.h.

+ +
+
+
The documentation for this struct was generated from the following file: +
+
Hazelnp::ParamConstraint::wantedType
DATA_TYPE wantedType
Constrain the parameter to this value. Requires constrainType to be set to true.
Definition: ParamConstraint.h:57
+
Hazelnp::ParamConstraint::constrainType
bool constrainType
Should this parameter be forced to be of a certain type? Remember to set constrainTo to the wanted ...
Definition: ParamConstraint.h:54
+
Hazelnp::ParamConstraint::ParamConstraint
ParamConstraint()=default
Empty constructor.
+
Hazelnp::ParamConstraint::key
std::string key
The key of the parameter to constrain.
Definition: ParamConstraint.h:50
+
Hazelnp::ParamConstraint::required
bool required
If set to true, and no default value set, an error will be produced if this parameter is not supplied...
Definition: ParamConstraint.h:66
+
Hazelnp::ParamConstraint::defaultValue
std::vector< std::string > defaultValue
The default value for this parameter.
Definition: ParamConstraint.h:62
+ + + + diff --git a/docs/structHazelnp_1_1ParamConstraint__coll__graph.map b/docs/structHazelnp_1_1ParamConstraint__coll__graph.map new file mode 100644 index 0000000..6241153 --- /dev/null +++ b/docs/structHazelnp_1_1ParamConstraint__coll__graph.map @@ -0,0 +1,6 @@ + + + + + + diff --git a/docs/structHazelnp_1_1ParamConstraint__coll__graph.md5 b/docs/structHazelnp_1_1ParamConstraint__coll__graph.md5 new file mode 100644 index 0000000..3a48dee --- /dev/null +++ b/docs/structHazelnp_1_1ParamConstraint__coll__graph.md5 @@ -0,0 +1 @@ +a2a1e59b85b4bb3c2fb535eaca80bfec \ No newline at end of file diff --git a/docs/structHazelnp_1_1ParamConstraint__coll__graph.png b/docs/structHazelnp_1_1ParamConstraint__coll__graph.png new file mode 100644 index 0000000..f4b7873 Binary files /dev/null and b/docs/structHazelnp_1_1ParamConstraint__coll__graph.png differ