Aikido
aikido::constraint::DefaultTestableOutcome Class Reference

Simple default TestableOutcome derivative class. More...

#include <aikido/constraint/DefaultTestableOutcome.hpp>

Inheritance diagram for aikido::constraint::DefaultTestableOutcome:
aikido::constraint::TestableOutcome

Public Member Functions

bool isSatisfied () const override
 Returns whether the isSatisfied method this object was passed to returned true or false. More...
 
std::string toString () const override
 String representation of isSatisfied return value. More...
 
void setSatisfiedFlag (bool satisfiedFlag)
 Used by the isSatisfied this outcome object is passed to set whether the constraint was satisifed or not. More...
 
- Public Member Functions inherited from aikido::constraint::TestableOutcome
virtual ~TestableOutcome ()=default
 Destructor. More...
 

Protected Attributes

bool mSatisfiedFlag
 

Detailed Description

Simple default TestableOutcome derivative class.

An instance of this class is returned when createOutcome() is called on an instance of a class that inherits Testable, but has no corresponding TestableOutcome derivative implemented.

Member Function Documentation

◆ isSatisfied()

bool aikido::constraint::DefaultTestableOutcome::isSatisfied ( ) const
overridevirtual

Returns whether the isSatisfied method this object was passed to returned true or false.

Implements aikido::constraint::TestableOutcome.

◆ setSatisfiedFlag()

void aikido::constraint::DefaultTestableOutcome::setSatisfiedFlag ( bool  satisfiedFlag)

Used by the isSatisfied this outcome object is passed to set whether the constraint was satisifed or not.

Parameters
[in]satisfiedFlagwhether the constraint was satisfied or not.

◆ toString()

std::string aikido::constraint::DefaultTestableOutcome::toString ( ) const
overridevirtual

String representation of isSatisfied return value.

Implements aikido::constraint::TestableOutcome.

Member Data Documentation

◆ mSatisfiedFlag

bool aikido::constraint::DefaultTestableOutcome::mSatisfiedFlag
protected