knowrob::Answer Class Reference

#include <Answer.h>

Inheritance diagram for knowrob::Answer:

Collaboration diagram for knowrob::Answer:

Public Member Functions
	Answer ()
	Answer (const Answer &other)
auto &	frame () const
void	setFrame (const std::shared_ptr< GraphSelector > &frame)
void	applyFrame (const GraphSelector &frame)
bool	isNegative () const
bool	isPositive () const
bool	isUncertain () const
bool	isCertain () const
void	setIsUncertain (bool val, std::optional< double > confidence)
bool	isOccasionallyTrue () const
bool	isAllwaysTrue () const
void	setIsOccasionallyTrue (bool val)
void	setReasonerTerm (const AtomPtr &reasonerTerm)
auto &	reasonerTerm () const
size_t	hashOfAnswer () const
std::string	stringFormOfAnswer () const
std::string	humanReadableForm () const
	Answer ()
	Answer (const Answer &other)
auto &	frame () const
void	setFrame (const std::shared_ptr< GraphSelector > &frame)
void	applyFrame (const GraphSelector &frame)
bool	isNegative () const
bool	isPositive () const
bool	isUncertain () const
bool	isCertain () const
void	setIsUncertain (bool val, std::optional< double > confidence)
bool	isOccasionallyTrue () const
bool	isAllwaysTrue () const
void	setIsOccasionallyTrue (bool val)
void	setReasonerTerm (const AtomPtr &reasonerTerm)
auto &	reasonerTerm () const
size_t	hashOfAnswer () const
std::string	stringFormOfAnswer () const
std::string	humanReadableForm () const
Public Member Functions inherited from knowrob::Token
	Token (TokenType tokenType)
virtual	~Token ()=default
TokenType	tokenType () const
size_t	hash () const
std::string	stringForm () const
bool	isControlToken () const
bool	isAnswerToken () const
bool	indicatesEndOfEvaluation () const
void	write (std::ostream &os) const override
	Token (TokenType tokenType)
virtual	~Token ()=default
TokenType	tokenType () const
size_t	hash () const
std::string	stringForm () const
bool	isControlToken () const
bool	isAnswerToken () const
bool	indicatesEndOfEvaluation () const
void	write (std::ostream &os) const override
Public Member Functions inherited from knowrob::Printable
virtual	~Printable ()=default
virtual std::string	format () const
virtual	~Printable ()=default
virtual std::string	format () const

Protected Member Functions
void	setIsPositive (bool val)
void	setIsNegative (bool val)
void	setIsPositive (bool val)
void	setIsNegative (bool val)

Protected Attributes
std::shared_ptr< GraphSelector >	frame_
AtomPtr	reasonerTerm_
bool	isPositive_ = false
bool	isNegative_ = false
Protected Attributes inherited from knowrob::Token
TokenType	tokenType_
bool	isTerminalToken_ = false

Detailed Description

The answer to a (sub)-query. It can be positive, negative or neither.

Definition at line 17 of file Answer.h.

Constructor & Destructor Documentation

Answer() [1/4]

knowrob::Answer::Answer ( )

inline

Definition at line 19 of file Answer.h.

                : Token(TokenType::ANSWER_TOKEN),
                  frame_(std::make_shared<GraphSelector>()) {}

Answer() [2/4]

knowrob::Answer::Answer ( const Answer &  other )

inline

Definition at line 23 of file Answer.h.

                : Token(TokenType::ANSWER_TOKEN),
                  frame_(other.frame_),
                  reasonerTerm_(other.reasonerTerm_) {};

Answer() [3/4]

knowrob::Answer::Answer ( )

inline

Definition at line 19 of file Answer.h.

                : Token(TokenType::ANSWER_TOKEN),
                  frame_(std::make_shared<GraphSelector>()) {}

Answer() [4/4]

knowrob::Answer::Answer ( const Answer &  other )

inline

Definition at line 23 of file Answer.h.

                : Token(TokenType::ANSWER_TOKEN),
                  frame_(other.frame_),
                  reasonerTerm_(other.reasonerTerm_) {};

Member Function Documentation

applyFrame() [1/2]

void Answer::applyFrame

(

const GraphSelector &

frame

)

Apply a frame to this answer.

Parameters

frame

a graph selector.

Definition at line 25 of file Answer.cpp.

                                                  {
    frame_->graph = frame.graph;
    frame_->perspective = frame.perspective;
    frame_->confidence = std::nullopt;
    frame_->begin = frame.begin;
    frame_->end = frame.end;
    frame_->uncertain = frame.uncertain;
    frame_->occasional = frame.occasional;
}

applyFrame() [2/2]

void knowrob::Answer::applyFrame

(

const GraphSelector &

frame

)

Apply a frame to this answer.

Parameters

frame

a graph selector.

frame() [1/2]

auto& knowrob::Answer::frame ( ) const

inline

The answer is framed in the context of a graph selector which determines the set of graphs in which the answer is valid. This can be used to e.g. address graphs that represent the world state from the perspective of a specific agent, or a specific point in time.

Returns

a graph selector.

Definition at line 35 of file Answer.h.

{ return frame_; }

frame() [2/2]

auto& knowrob::Answer::frame ( ) const

inline

The answer is framed in the context of a graph selector which determines the set of graphs in which the answer is valid. This can be used to e.g. address graphs that represent the world state from the perspective of a specific agent, or a specific point in time.

Returns

a graph selector.

Definition at line 35 of file Answer.h.

{ return frame_; }

hashOfAnswer() [1/2]

size_t Answer::hashOfAnswer

(

)

const

Returns

the hash of this answer.

Definition at line 64 of file Answer.cpp.

                                  {
    size_t val = 0;
    hashCombine(val, uint8_t(tokenType()));
    if (isNegative()) {
        hashCombine(val, 0);
    } else if (isPositive()) {
        hashCombine(val, 1);
    } else {
        hashCombine(val, 2);
    }
    if (reasonerTerm()) {
        hashCombine(val, reasonerTerm()->hash());
    } else {
        hashCombine(val, 0);
    }
    if (frame()) {
        hashCombine(val, frame()->hash());
    } else {
        hashCombine(val, 0);
    }
    if (isPositive()) {
        auto &bindings = ((AnswerYes *) this)->substitution();
        hashCombine(val, bindings->hash());
    }
    return val;
}

hashOfAnswer() [2/2]

size_t knowrob::Answer::hashOfAnswer

(

)

const

Returns

the hash of this answer.

humanReadableForm() [1/2]

std::string Answer::humanReadableForm

(

)

const

Returns

a human readable string representation of this answer.

Definition at line 101 of file Answer.cpp.

                                          {
    if (isNegative()) {
        return ((AnswerNo *) this)->humanReadableFormOfNo();
    } else if (isPositive()) {
        return ((AnswerYes *) this)->humanReadableFormOfYes();
    } else {
        return ((AnswerDontKnow *) this)->humanReadableFormOfDontKnow();
    }
}

humanReadableForm() [2/2]

std::string knowrob::Answer::humanReadableForm

(

)

const

Returns

a human readable string representation of this answer.

isAllwaysTrue() [1/2]

bool knowrob::Answer::isAllwaysTrue ( ) const

inline

Returns

true if truth of this answer is certain.

Definition at line 84 of file Answer.h.

{ return !isOccasionallyTrue(); }

isAllwaysTrue() [2/2]

bool knowrob::Answer::isAllwaysTrue ( ) const

inline

Returns

true if truth of this answer is certain.

Definition at line 84 of file Answer.h.

{ return !isOccasionallyTrue(); }

isCertain() [1/2]

bool knowrob::Answer::isCertain ( ) const

inline

Returns

true if truth of this answer is certain.

Definition at line 67 of file Answer.h.

{ return !isUncertain(); }

isCertain() [2/2]

bool knowrob::Answer::isCertain ( ) const

inline

Returns

true if truth of this answer is certain.

Definition at line 67 of file Answer.h.

{ return !isUncertain(); }

isNegative() [1/2]

bool knowrob::Answer::isNegative ( ) const

inline

Returns

true if this answer is negative.

Definition at line 52 of file Answer.h.

{ return isNegative_; }

isNegative() [2/2]

bool knowrob::Answer::isNegative ( ) const

inline

Returns

true if this answer is negative.

Definition at line 52 of file Answer.h.

{ return isNegative_; }

isOccasionallyTrue() [1/2]

bool Answer::isOccasionallyTrue

(

)

const

Returns

true if truth of this answer is uncertain.

Definition at line 45 of file Answer.cpp.

                                      {
    return frame_->occasional;
}

isOccasionallyTrue() [2/2]

bool knowrob::Answer::isOccasionallyTrue

(

)

const

Returns

true if truth of this answer is uncertain.

isPositive() [1/2]

bool knowrob::Answer::isPositive ( ) const

inline

Returns

true if this answer is positive.

Definition at line 57 of file Answer.h.

{ return isPositive_; }

isPositive() [2/2]

bool knowrob::Answer::isPositive ( ) const

inline

Returns

true if this answer is positive.

Definition at line 57 of file Answer.h.

{ return isPositive_; }

isUncertain() [1/2]

bool Answer::isUncertain

(

)

const

Returns

true if truth of this answer is uncertain.

Definition at line 35 of file Answer.cpp.

                               {
    if (frame_->confidence.has_value()) {
        if (frame_->confidence.value() < 1.0) return true;
    }
    if (frame_->uncertain) {
        return true;
    }
    return false;
}

isUncertain() [2/2]

bool knowrob::Answer::isUncertain

(

)

const

Returns

true if truth of this answer is uncertain.

reasonerTerm() [1/2]

auto& knowrob::Answer::reasonerTerm ( ) const

inline

Returns

the name of the reasoner that was used to generate this answer.

Definition at line 100 of file Answer.h.

{ return reasonerTerm_; }

reasonerTerm() [2/2]

auto& knowrob::Answer::reasonerTerm ( ) const

inline

Returns

the name of the reasoner that was used to generate this answer.

Definition at line 100 of file Answer.h.

{ return reasonerTerm_; }

setFrame() [1/2]

void Answer::setFrame

(

const std::shared_ptr< GraphSelector > &

frame

)

Assign a graph selector to this answer.

Parameters

frame

a graph selector.

Definition at line 17 of file Answer.cpp.

                                                               {
    if (frame != nullptr) {
        frame_ = frame;
    } else {
        throw std::invalid_argument("frame must not be null");
    }
}

setFrame() [2/2]

void knowrob::Answer::setFrame

(

const std::shared_ptr< GraphSelector > &

frame

)

Assign a graph selector to this answer.

Parameters

frame

a graph selector.

setIsNegative() [1/2]

void knowrob::Answer::setIsNegative ( bool  val )

inlineprotected

Definition at line 125 of file Answer.h.

{ isNegative_ = val; }

setIsNegative() [2/2]

void knowrob::Answer::setIsNegative ( bool  val )

inlineprotected

Definition at line 125 of file Answer.h.

{ isNegative_ = val; }

setIsOccasionallyTrue() [1/2]

void Answer::setIsOccasionallyTrue

(

bool

val

)

Mark this answer as occasionally true.

Parameters

val	true if the answer is occasionally true.

Definition at line 60 of file Answer.cpp.

                                           {
    frame_->occasional = val;
}

setIsOccasionallyTrue() [2/2]

void knowrob::Answer::setIsOccasionallyTrue

(

bool

val

)

Mark this answer as occasionally true.

Parameters

val	true if the answer is occasionally true.

setIsPositive() [1/2]

void knowrob::Answer::setIsPositive ( bool  val )

inlineprotected

Definition at line 123 of file Answer.h.

{ isPositive_ = val; }

setIsPositive() [2/2]

void knowrob::Answer::setIsPositive ( bool  val )

inlineprotected

Definition at line 123 of file Answer.h.

{ isPositive_ = val; }

setIsUncertain() [1/2]

void Answer::setIsUncertain	(	bool	val,
		std::optional< double >	confidence
	)

Mark this answer as uncertain by modification of the associated frame.

Parameters

val	true if the answer is uncertain.
confidence	the confidence value.

Definition at line 49 of file Answer.cpp.

                                                                    {
    frame_->uncertain = val;
    if (val) {
        if (confidence.has_value()) {
            frame_->confidence = confidence;
        }
    } else {
        frame_->confidence = 1.0;
    }
}

setIsUncertain() [2/2]

void knowrob::Answer::setIsUncertain	(	bool	val,
		std::optional< double >	confidence
	)

Mark this answer as uncertain by modification of the associated frame.

Parameters

val	true if the answer is uncertain.
confidence	the confidence value.

setReasonerTerm() [1/2]

void knowrob::Answer::setReasonerTerm ( const AtomPtr &  reasonerTerm )

inline

Returns

the name of the reasoner that was used to generate this answer.

Definition at line 95 of file Answer.h.

{ reasonerTerm_ = reasonerTerm; }

setReasonerTerm() [2/2]

void knowrob::Answer::setReasonerTerm ( const AtomPtr &  reasonerTerm )

inline

Returns

the name of the reasoner that was used to generate this answer.

Definition at line 95 of file Answer.h.

{ reasonerTerm_ = reasonerTerm; }

stringFormOfAnswer() [1/2]

std::string Answer::stringFormOfAnswer

(

)

const

Returns

a string representation of this answer.

Definition at line 91 of file Answer.cpp.

                                           {
    if (isNegative()) {
        return ((AnswerNo *) this)->stringFormOfNo();
    } else if (isPositive()) {
        return ((AnswerYes *) this)->stringFormOfYes();
    } else {
        return ((AnswerDontKnow *) this)->stringFormOfDontKnow();
    }
}

stringFormOfAnswer() [2/2]

std::string knowrob::Answer::stringFormOfAnswer

(

)

const

Returns

a string representation of this answer.

Member Data Documentation

frame_

std::shared_ptr< GraphSelector > knowrob::Answer::frame_

protected

Definition at line 118 of file Answer.h.

isNegative_

bool knowrob::Answer::isNegative_ = false

protected

Definition at line 121 of file Answer.h.

isPositive_

bool knowrob::Answer::isPositive_ = false

protected

Definition at line 120 of file Answer.h.

reasonerTerm_

AtomPtr knowrob::Answer::reasonerTerm_

protected

Definition at line 119 of file Answer.h.

---

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

• build/_CPack_Packages/Linux/DEB/knowrob-2.1.0-Linux/usr/include/knowrob/queries/Answer.h
• src/queries/Answer.cpp