SGL
require.h
1 /*
2  * File: require.h
3  * ---------------
4  *
5  * This file contains assertion functions for argument checking within the
6  * code of the SGL C++ library itself.
7  */
8 
9 
10 #ifndef _require_h
11 #define _require_h
12 
13 #include <string>
14 
18 namespace require {
19 
20 void inRange(double value, double min, double max, const string& caller = "", const string& valueName = "", const string& details = "");
21 void inRange(int value, int min, int max, const string& caller = "", const string& valueName = "", const string& details = "");
22 void inRange2D(double x, double y, double maxX, double maxY, const string& caller = "", const string& xValueName = "", const string& yValueName = "", const string& details = "");
23 void inRange2D(double x, double y, double minX, double minY, double maxX, double maxY, const string& caller = "", const string& xValueName = "", const string& yValueName = "", const string& details = "");
24 void inRange2D(int x, int y, int maxX, int maxY, const string& caller = "", const string& xValueName = "", const string& yValueName = "", const string& details = "");
25 void inRange2D(int x, int y, int minX, int minY, int maxX, int maxY, const string& caller = "", const string& xValueName = "", const string& yValueName = "", const string& details = "");
26 void nonEmpty(const string& str, const string& caller = "", const string& valueName = "", const string& details = "");
27 void nonNegative(double value, const string& caller = "", const string& valueName = "", const string& details = "");
28 void nonNegative(int value, const string& caller = "", const string& valueName = "", const string& details = "");
29 void nonNegative(long value, const string& caller = "", const string& valueName = "", const string& details = "");
30 void nonNegative2D(double x, double y, const string& caller = "", const string& xValueName = "", const string& yValueName = "", const string& details = "");
31 void nonNegative2D(int x, int y, const string& caller = "", const string& xValueName = "", const string& yValueName = "", const string& details = "");
32 void nonNull(const void* ptr, const string& caller = "", const string& valueName = "", const string& details = "");
33 void positive(double value, const string& caller = "", const string& valueName = "", const string& details = "");
34 void positive(int value, const string& caller = "", const string& valueName = "", const string& details = "");
35 void require(bool test, const string& caller = "", const string& details = "");
36 
37 } // namespace require
38 
39 #endif // _require_h
require::nonNull
void nonNull(const void *ptr, string caller, string valueName, string details)
Definition: require.cpp:99
require::inRange2D
void inRange2D(double x, double y, double maxX, double maxY, string caller, string xValueName, string yValueName, string details)
Definition: require.cpp:55
require::positive
void positive(double value, string caller, string valueName, string details)
Definition: require.cpp:103
require::nonNegative
void nonNegative(double value, string caller, string valueName, string details)
Definition: require.cpp:77
require::nonEmpty
void nonEmpty(string str, string caller, string valueName, string details)
Definition: require.cpp:73
require
Definition: require.cpp:15
require::require
void require(bool test, string caller, string details)
Definition: require.cpp:111
require::nonNegative2D
void nonNegative2D(double x, double y, string caller, string xValueName, string yValueName, string details)
Definition: require.cpp:89
require::inRange
void inRange(double value, double min, double max, string caller, string valueName, string details)
Definition: require.cpp:47
Generated by   doxygen 1.8.14