GCC Code Coverage Report


Directory: ./
File: include/hpp/core/joint-bound-validation.hh
Date: 2024-12-13 16:14:03
Exec Total Coverage
Lines: 0 16 0.0%
Branches: 0 2 0.0%

Line Branch Exec Source
1 //
2 // Copyright (c) 2014 CNRS
3 // Authors: Florent Lamiraux
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_JOINT_BOUND_VALIDATION_HH
31 #define HPP_CORE_JOINT_BOUND_VALIDATION_HH
32
33 #include <hpp/core/config-validation.hh>
34 #include <hpp/pinocchio/joint.hh>
35
36 namespace hpp {
37 namespace core {
38 /// \addtogroup validation
39 /// \{
40
41 /// report returned when a configuration is not within the bounds
42 class HPP_CORE_DLLAPI JointBoundValidationReport : public ValidationReport {
43 public:
44 JointBoundValidationReport(const JointConstPtr_t& joint, size_type rank,
45 value_type lowerBound, value_type upperBound,
46 value_type value)
47 : ValidationReport(),
48 joint_(joint),
49 rank_(rank),
50 lowerBound_(lowerBound),
51 upperBound_(upperBound),
52 value_(value) {}
53 /// Print report in a stream
54 virtual std::ostream& print(std::ostream& os) const {
55 if (joint_) {
56 os << "Joint " << joint_->name() << ", rank: " << rank_
57 << ", value out of range: " << value_ << " not in [" << lowerBound_
58 << ", " << upperBound_ << "]";
59 } else {
60 os << "Extra config space at rank: " << rank_
61 << ", value out of range: " << value_ << " not in [" << lowerBound_
62 << ", " << upperBound_ << "]";
63 }
64 return os;
65 }
66
67 /// Joint the configuration value is out of bounds
68 JointConstPtr_t joint_;
69 /// degree of freedom in the joint (usually 0)
70 size_type rank_;
71 /// lower bound
72 value_type lowerBound_;
73 /// upper bound
74 value_type upperBound_;
75 /// configuration value
76 value_type value_;
77 };
78
79 /// Validate a configuration with respect to joint bounds
80 ///
81 class HPP_CORE_DLLAPI JointBoundValidation : public ConfigValidation {
82 public:
83 static JointBoundValidationPtr_t create(const DevicePtr_t& robot);
84
85 /// Compute whether the configuration is valid
86 ///
87 /// \param config the config to check for validity,
88 /// \retval validationReport report on validation. If non valid,
89 /// a validation report will be allocated and returned via this
90 /// shared pointer.
91 /// \return whether the whole config is valid.
92 bool validate(const Configuration_t& config,
93 ValidationReportPtr_t& validationReport);
94
95 protected:
96 JointBoundValidation(const DevicePtr_t& robot);
97
98 private:
99 DevicePtr_t robot_;
100 }; // class ConfigValidation
101 /// \}
102 } // namespace core
103 } // namespace hpp
104
105 #endif // HPP_CORE_JOINT_BOUND_VALIDATION_HH
106