GCC Code Coverage Report


Directory: ./
File: include/hpp/core/path-validations.hh
Date: 2024-12-13 16:14:03
Exec Total Coverage
Lines: 0 1 0.0%
Branches: 0 0 -%

Line Branch Exec Source
1 //
2 // Copyright (c) 2017 CNRS
3 // Authors: Diane Bury
4 //
5
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions are
8 // met:
9 //
10 // 1. Redistributions of source code must retain the above copyright
11 // notice, this list of conditions and the following disclaimer.
12 //
13 // 2. Redistributions in binary form must reproduce the above copyright
14 // notice, this list of conditions and the following disclaimer in the
15 // documentation and/or other materials provided with the distribution.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
28 // DAMAGE.
29
30 #ifndef HPP_CORE_PATH_VALIDATIONS_HH
31 #define HPP_CORE_PATH_VALIDATIONS_HH
32
33 #include <hpp/core/obstacle-user.hh>
34 #include <hpp/core/path-validation.hh>
35
36 namespace hpp {
37 namespace core {
38 /// \addtogroup validation
39 /// \{
40
41 /// Validation of a path with multiple path validation methods
42 ///
43 /// Apply several path validation methods to the path parameter
44 class HPP_CORE_DLLAPI PathValidations
45 : public PathValidation,
46 public ObstacleUserVector<PathValidationPtr_t> {
47 public:
48 static PathValidationsPtr_t create();
49
50 /// Compute the largest valid interval starting from the path beginning
51 ///
52 /// \param path the path to check for validity,
53 /// \param reverse if true check from the end,
54 /// \retval the extracted valid part of the path, pointer to path if
55 /// path is valid.
56 /// \retval report information about the validation process. A report
57 /// is allocated if the path is not valid.
58 /// \return whether the whole path is valid.
59 virtual bool validate(const PathPtr_t& path, bool reverse,
60 PathPtr_t& validPart,
61 PathValidationReportPtr_t& report);
62
63 /// Validate a single configuration
64 /// \param q input configuration,
65 /// \retval report validation report.
66 /// The default implementation builds a straight path of length 0
67 /// with the input configuration and validates the path.
68 virtual bool validate(ConfigurationIn_t q, ValidationReportPtr_t& report);
69
70 /// Add a path validation object
71 virtual void addPathValidation(const PathValidationPtr_t& pathValidation);
72
73 virtual ~PathValidations() {};
74
75 protected:
76 PathValidations();
77 }; // class PathValidations
78 /// \}
79 } // namespace core
80 } // namespace hpp
81
82 #endif // HPP_CORE_PATH_VALIDATIONS_HH
83