hpp-core: hpp::core::ConfigValidation Class Reference

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

Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
hpp::core::ConfigValidation Class Referenceabstract
Validation of configurations and paths

`#include <hpp/core/config-validation.hh>`

Inheritance diagram for hpp::core::ConfigValidation:
[legend]

## Public Member Functions
virtual bool | validate (const Configuration_t &config, ValidationReportPtr_t &validationReport)=0
virtual | ~ConfigValidation ()=default

## Protected Member Functions
| ConfigValidation ()=default

## Detailed Description

Abstraction of configuration validation

Instances of this class validate configurations with respect to some criteria

## Constructor & Destructor Documentation

## ◆ ~ConfigValidation()

virtual hpp::core::ConfigValidation::~ConfigValidation | ( |  | ) |
| virtualdefault

## ◆ ConfigValidation()

hpp::core::ConfigValidation::ConfigValidation | ( |  | ) |
| protecteddefault

## Member Function Documentation

## ◆ validate()

virtual bool hpp::core::ConfigValidation::validate | ( | const Configuration_t & | config,
|  | ValidationReportPtr_t & | validationReport
| ) |  |
| pure virtual

Compute whether the configuration is valid

Parameters

  config | the config to check for validity,

Return values

  validationReport | report on validation. If non valid, a validation report will be allocated and returned via this shared pointer.

Returns
  whether the whole config is valid.

Implemented in hpp::core::CollisionValidation, hpp::core::ConfigValidations, and hpp::core::JointBoundValidation.

The documentation for this class was generated from the following file:

- include/hpp/core/config-validation.hh