Base class for constraint outcomes. More...

#include <aikido/constraint/TestableOutcome.hpp>

Inheritance diagram for aikido::constraint::TestableOutcome:

Public Member Functions
virtual	~TestableOutcome ()=default
	Destructor. More...

virtual bool	isSatisfied () const =0
	Returns true if isSatisfied call this outcome object was passed to returned true. More...

virtual std::string	toString () const =0
	String representation of the outcome. More...

Detailed Description

Base class for constraint outcomes.

At a high level, each constraint can have a corresponding derivative of TestableOutcome that is passed as an optional parameter to its isSatisfied method. This allow programmatic access to data on why the constraint was (or was not) satisfied.

Constructor & Destructor Documentation

◆ ~TestableOutcome()

virtual aikido::constraint::TestableOutcome::~TestableOutcome ( )

virtualdefault

Destructor.

Member Function Documentation

◆ isSatisfied()

virtual bool aikido::constraint::TestableOutcome::isSatisfied ( ) const

pure virtual

Returns true if isSatisfied call this outcome object was passed to returned true.

False otherwise.

Implemented in aikido::constraint::dart::CollisionFreeOutcome, and aikido::constraint::DefaultTestableOutcome.

◆ toString()

virtual std::string aikido::constraint::TestableOutcome::toString ( ) const