knowrob::OptionList Class Reference

#include <OptionList.h>

Public Member Functions
	OptionList (const TermPtr &t)
const std::map< std::string, TermPtr > &	options () const
bool	contains (const std::string &key) const
const TermPtr &	get (const std::string &key, const TermPtr &defaultValue) const
std::string_view	getString (const std::string &key, const std::string &defaultValue) const
long	getLong (const std::string &key, long defaultValue) const
std::optional< double >	getDouble (const std::string &key) const
	OptionList (const TermPtr &t)
const std::map< std::string, TermPtr > &	options () const
bool	contains (const std::string &key) const
const TermPtr &	get (const std::string &key, const TermPtr &defaultValue) const
std::string_view	getString (const std::string &key, const std::string &defaultValue) const
long	getLong (const std::string &key, long defaultValue) const
std::optional< double >	getDouble (const std::string &key) const

Protected Member Functions
void	readOption (const TermPtr &option)
void	readOption (const TermPtr &option)

Protected Attributes
std::map< std::string, TermPtr >	options_

Detailed Description

A list of options, where each option is represented as a term.

Definition at line 18 of file OptionList.h.

Constructor & Destructor Documentation

OptionList() [1/2]

OptionList::OptionList ( const TermPtr &  t )

explicit

Constructs an option list from a term. The term may be a list of options, or a single option value. Option terms have either the form Key = Value or Key(Value).

Parameters

t	a term from which options are read.

Definition at line 13 of file OptionList.cpp.

                                       {
    bool optionsRead = false;
    if (t->isFunction()) {
        auto *fn = (Function *) t.get();
        if (*fn->functor() == *ListTerm::listFunctor()) {
            for (auto &arg: fn->arguments()) {
                readOption(arg);
            }
            optionsRead = true;
        }
    }
    if (!optionsRead) {
        readOption(t);
    }
}

OptionList() [2/2]

knowrob::OptionList::OptionList ( const TermPtr &  t )

explicit

Constructs an option list from a term. The term may be a list of options, or a single option value. Option terms have either the form Key = Value or Key(Value).

Parameters

t	a term from which options are read.

Member Function Documentation

contains() [1/2]

bool OptionList::contains

(

const std::string &

key

)

const

Parameters

key	key of option.

Returns

true is this list isMoreGeneralThan the key.

Definition at line 49 of file OptionList.cpp.

                                                    {
    return options_.count(key) > 0;
}

contains() [2/2]

bool knowrob::OptionList::contains

(

const std::string &

key

)

const

Parameters

key	key of option.

Returns

true is this list isMoreGeneralThan the key.

get() [1/2]

const TermPtr & OptionList::get	(	const std::string &	key,
		const TermPtr &	defaultValue
	)		const

Parameters

key	an option key
defaultValue	a default value

Returns

the option value, or the default value

Definition at line 53 of file OptionList.cpp.

                                                                                      {
    auto it = options_.find(key);
    if (it == options_.end()) {
        return defaultValue;
    } else {
        return it->second;
    }
}

get() [2/2]

const TermPtr& knowrob::OptionList::get	(	const std::string &	key,
		const TermPtr &	defaultValue
	)		const

Parameters

key	an option key
defaultValue	a default value

Returns

the option value, or the default value

getDouble() [1/2]

std::optional< double > OptionList::getDouble

(

const std::string &

key

)

const

Read option value as a double.

Parameters

key	an option key

Returns

the option value, or std::nullopt

Definition at line 89 of file OptionList.cpp.

                                                                    {
    auto it = options_.find(key);
    if (it == options_.end()) {
        return std::nullopt;
    } else if (it->second->isNumeric()) {
        return std::static_pointer_cast<Numeric>(it->second)->asDouble();
    }
    return std::nullopt;
}

getDouble() [2/2]

std::optional<double> knowrob::OptionList::getDouble

(

const std::string &

key

)

const

Read option value as a double.

Parameters

key	an option key

Returns

the option value, or std::nullopt

getLong() [1/2]

long OptionList::getLong	(	const std::string &	key,
		long	defaultValue
	)		const

Read option value as a long.

Parameters

key	an option key
defaultValue	a default value

Returns

the option value, or the default value

Definition at line 79 of file OptionList.cpp.

                                                                      {
    auto it = options_.find(key);
    if (it == options_.end()) {
        return defaultValue;
    } else if (it->second->isNumeric()) {
        return std::static_pointer_cast<Numeric>(it->second)->asLong();
    }
    return defaultValue;
}

getLong() [2/2]

long knowrob::OptionList::getLong	(	const std::string &	key,
		long	defaultValue
	)		const

Read option value as a long.

Parameters

key	an option key
defaultValue	a default value

Returns

the option value, or the default value

getString() [1/2]

std::string_view OptionList::getString	(	const std::string &	key,
		const std::string &	defaultValue
	)		const

Read option value as a string.

Parameters

key	an option key
defaultValue	a default value

Returns

the option value, or the default value

Definition at line 62 of file OptionList.cpp.

                                                                                              {
    auto it = options_.find(key);
    if (it == options_.end()) {
        return defaultValue;
    } else if (it->second->termType() == TermType::FUNCTION) {
        Function *fn = ((Function *) it->second.get());
        if (fn->arity() == 0) {
            return fn->functor()->stringForm();
        } else {
            return defaultValue;
        }
    } else if (it->second->isAtomic()) {
        return std::static_pointer_cast<Atomic>(it->second)->stringForm();
    }
    return defaultValue;
}

getString() [2/2]

std::string_view knowrob::OptionList::getString	(	const std::string &	key,
		const std::string &	defaultValue
	)		const

Read option value as a string.

Parameters

key	an option key
defaultValue	a default value

Returns

the option value, or the default value

options() [1/2]

const std::map<std::string, TermPtr>& knowrob::OptionList::options ( ) const

inline

Returns

the option map.

Definition at line 31 of file OptionList.h.

{ return options_; }

options() [2/2]

const std::map<std::string, TermPtr>& knowrob::OptionList::options ( ) const

inline

Returns

the option map.

Definition at line 31 of file OptionList.h.

{ return options_; }

readOption() [1/2]

void OptionList::readOption ( const TermPtr &  option )

protected

Definition at line 29 of file OptionList.cpp.

                                                 {
    static const auto a_eq = Atom::Tabled("=");
 
    if (option->termType() != TermType::FUNCTION) return;
    auto *fn = (Function *) option.get();
 
    if (fn->arity() == 2 && *fn->functor() == *a_eq) {
        // an option of the form `Key = Value`
        auto keyTerm = fn->arguments()[0];
        auto valTerm = fn->arguments()[1];
        if (keyTerm->isAtom()) {
            auto keyAtom = std::static_pointer_cast<Atom>(keyTerm);
            options_[std::string(keyAtom->stringForm())] = valTerm;
        }
    } else if (fn->arity() == 1) {
        // an option of the form `Key(Value)`
        options_[std::string(fn->functor()->stringForm())] = fn->arguments()[0];
    }
}

readOption() [2/2]

void knowrob::OptionList::readOption ( const TermPtr &  option )

protected

Member Data Documentation

options_

std::map< std::string, TermPtr > knowrob::OptionList::options_

protected

Definition at line 70 of file OptionList.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/terms/OptionList.h
• src/terms/OptionList.cpp