hpp-core: include/hpp/core/path-validation-report.hh Source File

hpp-core 9.0.2 Implement basic classes for canonical path planning for kinematic chains.

Loading...
Searching...
No Matches
path-validation-report.hh
Go to the documentation of this file.
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_PATH_VALIDATION_REPORT_HH
31#define HPP_CORE_PATH_VALIDATION_REPORT_HH
32
33#include <hpp/core/validation-report.hh>
34#include <hpp/util/indent.hh>
35
36namespace hpp {
37namespace core {
40
45 struct HPP_CORE_DLLAPI PathValidationReport : public ValidationReport {
46 PathValidationReport() : ValidationReport(), configurationReport() {}
47 PathValidationReport(const value_type& param,
48 const ValidationReportPtr_t& report)
49 : parameter(param), configurationReport(report) {}
50
51 virtual ~PathValidationReport() {};
52
53 virtual std::ostream& print(std::ostream& os) const {
54 os << "Invalid configuration at parameter " << parameter << iendl
55 << incindent;
56 if (!configurationReport)
57 os << "No ValidationReport";
58 else
59 os << *configurationReport;
60 return os << decindent;
61 }
62
63 value_type getParameter() { return parameter; }
64
65 void setParameter(value_type p) { parameter = p; }
66
68 value_type parameter;
69 ValidationReportPtr_t configurationReport;
70}; // class PathValidationReport
72} // namespace core
73} // namespace hpp
74
75#endif // HPP_CORE_PATH_VALIDATION_REPORT_HH
hpp::core::ValidationReport
Definition validation-report.hh:47
HPP_CORE_DLLAPI
#define HPP_CORE_DLLAPI
Definition config.hh:88
indent.hh
hpp
hpp::core::value_type
pinocchio::value_type value_type
Definition fwd.hh:174
hpp::core::ValidationReportPtr_t
shared_ptr< ValidationReport > ValidationReportPtr_t
Definition fwd.hh:225
hpp::incindent
HPP_UTIL_DLLAPI std::ostream & incindent(std::ostream &o)
hpp::iendl
HPP_UTIL_DLLAPI std::ostream & iendl(std::ostream &o)
hpp::decindent
HPP_UTIL_DLLAPI std::ostream & decindent(std::ostream &o)
hpp::core::PathValidationReport
Definition path-validation-report.hh:45
hpp::core::PathValidationReport::PathValidationReport
PathValidationReport(const value_type &param, const ValidationReportPtr_t &report)
Definition path-validation-report.hh:47
hpp::core::PathValidationReport::PathValidationReport
PathValidationReport()
Definition path-validation-report.hh:46
hpp::core::PathValidationReport::getParameter
value_type getParameter()
Definition path-validation-report.hh:63
hpp::core::PathValidationReport::parameter
value_type parameter
Parameter of the path where a invalid configuration has been found.
Definition path-validation-report.hh:68
hpp::core::PathValidationReport::print
virtual std::ostream & print(std::ostream &os) const
Write report in a stream.
Definition path-validation-report.hh:53
hpp::core::PathValidationReport::setParameter
void setParameter(value_type p)
Definition path-validation-report.hh:65
hpp::core::PathValidationReport::~PathValidationReport
virtual ~PathValidationReport()
Definition path-validation-report.hh:51
hpp::core::PathValidationReport::configurationReport
ValidationReportPtr_t configurationReport
Definition path-validation-report.hh:69
validation-report.hh