Ocean
testgeometry/TestGeometry.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Meta Platforms, Inc. and affiliates.
3  *
4  * This source code is licensed under the MIT license found in the
5  * LICENSE file in the root directory of this source tree.
6  */
7 
8 #ifndef META_OCEAN_TEST_TESTGEOMETRY_TESTGEOMETRY_H
9 #define META_OCEAN_TEST_TESTGEOMETRY_TESTGEOMETRY_H
10 
11 #include "ocean/test/Test.h"
12 
14 
15 #include "ocean/base/Worker.h"
16 
17 namespace Ocean
18 {
19 
20 namespace Test
21 {
22 
23 namespace TestGeometry
24 {
25 
26 /**
27  * @ingroup test
28  * @defgroup testgeometry Ocean Test Geometry Library
29  * @{
30  * The Ocean Test Geometry Library provides several function to test the performance and validation of geometry functions.
31  * The library is platform independent.
32  * @}
33  */
34 
35 /**
36  * @namespace Ocean::Test::TestGeometry Namespace of the Geometry Test library.<p>
37  * The Namespace Ocean::Test::TestGeometry is used in the entire Ocean Geometry Test Library.
38  */
39 
40 // Defines OCEAN_TEST_GEOMETRY_EXPORT for dll export and import.
41 #if defined(_WINDOWS) && defined(OCEAN_RUNTIME_SHARED)
42  #ifdef USE_OCEAN_TEST_GEOMETRY_EXPORT
43  #define OCEAN_TEST_GEOMETRY_EXPORT __declspec(dllexport)
44  #else
45  #define OCEAN_TEST_GEOMETRY_EXPORT __declspec(dllimport)
46  #endif
47 #else
48  #define OCEAN_TEST_GEOMETRY_EXPORT
49 #endif
50 
51 /**
52  * Tests the entire Geometry library.
53  * @param testDuration Number of seconds for each test
54  * @param worker The worker object to distribute some computation on as many CPU cores as defined in the worker object.
55  * @param testFunctions Optional name of the functions to be tested
56  * @return True, if the entire test succeeded
57  * @ingroup testgeometry
58  */
59 OCEAN_TEST_GEOMETRY_EXPORT bool testGeometry(const double testDuration, Worker& worker, const std::string& testFunctions = std::string());
60 
61 /**
62  * Tests the entire Geometry library.
63  * This function returns directly as the actual test is invoked in an own thread.<br>
64  * Use this function in intendet for non-console applications like e.g., mobile devices.
65  * @param testDuration Number of seconds for each test, with range (0, infinity)
66  * @param testFunctions Optional name of the functions to be tested
67  * @ingroup testgeometry
68  */
69 OCEAN_TEST_GEOMETRY_EXPORT void testGeometryAsynchron(const double testDuration, const std::string& testFunctions = std::string());
70 
71 }
72 
73 }
74 
75 }
76 
77 #endif // META_OCEAN_TEST_TESTGEOMETRY_TESTGEOMETRY_H
This class implements a worker able to distribute function calls over different threads.
Definition: Worker.h:33
OCEAN_TEST_GEOMETRY_EXPORT void testGeometryAsynchron(const double testDuration, const std::string &testFunctions=std::string())
Tests the entire Geometry library.
OCEAN_TEST_GEOMETRY_EXPORT bool testGeometry(const double testDuration, Worker &worker, const std::string &testFunctions=std::string())
Tests the entire Geometry library.
The namespace covering the entire Ocean framework.
Definition: Accessor.h:15