hpp-core  6.0.0
Implement basic classes for canonical path planning for kinematic chains.
hpp::core::ConfigValidation Class Referenceabstract

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

Inheritance diagram for hpp::core::ConfigValidation:

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
configthe config to check for validity,
Return values
validationReportreport 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::JointBoundValidation, hpp::core::ConfigValidations, and hpp::core::CollisionValidation.


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