| 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_CONFIG_VALIDATION_HH |
| 31 |
|
|
#define HPP_CORE_CONFIG_VALIDATION_HH |
| 32 |
|
|
|
| 33 |
|
|
#include <hpp/core/deprecated.hh> |
| 34 |
|
|
#include <hpp/core/relative-motion.hh> |
| 35 |
|
|
#include <hpp/core/validation-report.hh> |
| 36 |
|
|
|
| 37 |
|
|
namespace hpp { |
| 38 |
|
|
namespace core { |
| 39 |
|
|
/// \addtogroup validation |
| 40 |
|
|
/// \{ |
| 41 |
|
|
|
| 42 |
|
|
/// Abstraction of configuration validation |
| 43 |
|
|
/// |
| 44 |
|
|
/// Instances of this class validate configurations with respect to some |
| 45 |
|
|
/// criteria |
| 46 |
|
|
class HPP_CORE_DLLAPI ConfigValidation { |
| 47 |
|
|
public: |
| 48 |
|
|
/// Compute whether the configuration is valid |
| 49 |
|
|
/// |
| 50 |
|
|
/// \param config the config to check for validity, |
| 51 |
|
|
/// \retval validationReport report on validation. If non valid, |
| 52 |
|
|
/// a validation report will be allocated and returned via this |
| 53 |
|
|
/// shared pointer. |
| 54 |
|
|
/// \return whether the whole config is valid. |
| 55 |
|
|
virtual bool validate(const Configuration_t& config, |
| 56 |
|
|
ValidationReportPtr_t& validationReport) = 0; |
| 57 |
|
|
|
| 58 |
|
316 |
virtual ~ConfigValidation() = default; |
| 59 |
|
|
|
| 60 |
|
|
protected: |
| 61 |
|
194 |
ConfigValidation() = default; |
| 62 |
|
|
}; // class ConfigValidation |
| 63 |
|
|
/// \} |
| 64 |
|
|
} // namespace core |
| 65 |
|
|
} // namespace hpp |
| 66 |
|
|
|
| 67 |
|
|
#endif // HPP_CORE_CONFIG_VALIDATION_HH |
| 68 |
|
|
|