Answer.h

Go to the documentation of this file.

/*
 * This file is part of KnowRob, please consult
 * https://github.com/knowrob/knowrob for license details.
 */
 
#ifndef KNOWROB_ANSWER_H_
#define KNOWROB_ANSWER_H_
 
#include "Token.h"
#include "Query.h"
#include "knowrob/terms/Atom.h"
 
namespace knowrob {
    class Answer : public Token {
    public:
        Answer()
                : Token(TokenType::ANSWER_TOKEN),
                  frame_(std::make_shared<GraphSelector>()) {}
 
        Answer(const Answer &other)
                : Token(TokenType::ANSWER_TOKEN),
                  frame_(other.frame_),
                  reasonerTerm_(other.reasonerTerm_) {};
 
        auto &frame() const { return frame_; }
 
        void setFrame(const std::shared_ptr<GraphSelector> &frame);
 
        void applyFrame(const GraphSelector &frame);
 
        bool isNegative() const { return isNegative_; }
 
        bool isPositive() const { return isPositive_; }
 
        bool isUncertain() const;
 
        bool isCertain() const { return !isUncertain(); }
 
        void setIsUncertain(bool val, std::optional<double> confidence);
 
        bool isOccasionallyTrue() const;
 
        bool isAllwaysTrue() const { return !isOccasionallyTrue(); }
 
        void setIsOccasionallyTrue(bool val);
 
        void setReasonerTerm(const AtomPtr &reasonerTerm) { reasonerTerm_ = reasonerTerm; }
 
        auto &reasonerTerm() const { return reasonerTerm_; }
 
        size_t hashOfAnswer() const;
 
        std::string stringFormOfAnswer() const;
 
        std::string humanReadableForm() const;
 
    protected:
        std::shared_ptr<GraphSelector> frame_;
        AtomPtr reasonerTerm_;
        bool isPositive_ = false;
        bool isNegative_ = false;
 
        void setIsPositive(bool val) { isPositive_ = val; }
 
        void setIsNegative(bool val) { isNegative_ = val; }
    };
 
    // alias
    using AnswerPtr = std::shared_ptr<const Answer>;
 
    AnswerPtr mergeAnswers(const AnswerPtr &a, const AnswerPtr &b, bool ignoreInconsistencies);
 
    struct AnswerComparator {
        bool operator()(const AnswerPtr &v0, const AnswerPtr &v1) const;
    };
 
    using AnswerSet = std::set<AnswerPtr, AnswerComparator>;
    using AnswerHandler = std::function<void(const AnswerPtr &)>;
}
 
#endif //KNOWROB_ANSWER_H_