hpp-manipulation  6.0.0
Classes for manipulation planning.
hpp::manipulation::graph::Validation Class Reference

#include <hpp/manipulation/graph/validation.hh>

Public Types

typedef std::vector< std::string > Collision
 
typedef std::vector< CollisionCollisionList
 
typedef std::map< std::string, CollisionListCollisionMap
 

Public Member Functions

 Validation (const core::ProblemPtr_t &problem)
 
void clear ()
 
bool hasWarnings () const
 
bool hasErrors () const
 
virtual std::ostream & print (std::ostream &os) const
 
bool validate (const GraphComponentPtr_t &comp)
 
bool validateState (const StatePtr_t &state)
 
bool validateEdge (const EdgePtr_t &edge)
 
bool validateGraph (const GraphPtr_t &graph)
 
CollisionList getCollisionsForNode (const std::string &nodeName)
 

Detailed Description

Check that graph components are valid.

A stringified validation report can be obtained via Validation::print or operator<< (std::ostream&, const Validation&).

Member Typedef Documentation

◆ Collision

typedef std::vector<std::string> hpp::manipulation::graph::Validation::Collision

◆ CollisionList

◆ CollisionMap

Constructor & Destructor Documentation

◆ Validation()

hpp::manipulation::graph::Validation::Validation ( const core::ProblemPtr_t &  problem)
inline

Member Function Documentation

◆ clear()

void hpp::manipulation::graph::Validation::clear ( )
inline

◆ getCollisionsForNode()

CollisionList hpp::manipulation::graph::Validation::getCollisionsForNode ( const std::string &  nodeName)
inline

◆ hasErrors()

bool hpp::manipulation::graph::Validation::hasErrors ( ) const
inline

◆ hasWarnings()

bool hpp::manipulation::graph::Validation::hasWarnings ( ) const
inline

◆ print()

virtual std::ostream& hpp::manipulation::graph::Validation::print ( std::ostream &  os) const
virtual

◆ validate()

bool hpp::manipulation::graph::Validation::validate ( const GraphComponentPtr_t comp)

Validate a graph component. It dynamically casts in order to call the right function among the validation method below.

Returns
true if the component could not be proven infeasible.
Note
Even if true is returned, the report can contain warnings.

◆ validateEdge()

bool hpp::manipulation::graph::Validation::validateEdge ( const EdgePtr_t edge)

Validate an edge

Returns
true if the edge could not be proven infeasible.
Note
Even if true is returned, the report can contain warnings.

◆ validateGraph()

bool hpp::manipulation::graph::Validation::validateGraph ( const GraphPtr_t graph)

Validate an graph

Returns
true if no component of the graph could not be proven infeasible.
Note
Even if true is returned, the report can contain warnings.

◆ validateState()

bool hpp::manipulation::graph::Validation::validateState ( const StatePtr_t state)

Validate a state

Returns
true if the state could not be proven infeasible.
Note
Even if true is returned, the report can contain warnings.

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