Fauna::invalid_option Class Reference

Exception that a string parameter does not match possible options. More...

#include <insfile_reader.h>

Inheritance diagram for Fauna::invalid_option:

Public Member Functions
	invalid_option (const std::string &key, const std::string &value, const std::set< std::string > &valid_options)
	Constructor for global parameter. More...
	invalid_option (const Hft &hft, const std::string &key, const std::string &value, const std::set< std::string > &valid_options)
	Constructor for HFT parameter. More...

Private Member Functions
std::string	construct_message (const std::string &key, const std::string &value, const std::set< std::string > &valid_options)

Detailed Description

Exception that a string parameter does not match possible options.

Constructor & Destructor Documentation

invalid_option() [1/2]

Fauna::invalid_option::invalid_option ( const std::string &  key, const std::string &  value, const std::set< std::string > &  valid_options  )

inline

Constructor for global parameter.

Parameters

key	The fully qualified TOML key.
value	The given (invalid) value.
valid_options	Possible valid values.

Exceptions

std::logic_error

If valid_options is empty.

invalid_option() [2/2]

Fauna::invalid_option::invalid_option ( const Hft &  hft, const std::string &  key, const std::string &  value, const std::set< std::string > &  valid_options  )

inline

Constructor for HFT parameter.

Parameters

hft	Reference to the HFT.
key	The fully qualified TOML key.
value	The given (invalid) value.
valid_options	Possible valid values.

Exceptions

std::logic_error

If valid_options is empty.

Member Function Documentation

construct_message()

std::string invalid_option::construct_message ( const std::string &  key, const std::string &  value, const std::set< std::string > &  valid_options  )

private

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/modular-megafauna-model/checkouts/latest/src/Fauna/insfile_reader.h
• /home/docs/checkouts/readthedocs.org/user_builds/modular-megafauna-model/checkouts/latest/src/Fauna/insfile_reader.cpp