Struct DeckKeyReport
Defined in File TrackedDeck.hpp
Struct Documentation
-
struct DeckKeyReport
One key of an input deck that was never used, or was deliberately ignored.
Returned by TrackedDeck::unused() and TrackedDeck::ignored(). Which of hint_ and reason_ is filled in depends on which of the two lists the report came from – see each’s own comment.
Public Members
-
std::string path_
Canonical dotted path of the key, e.g. “output.n_trial”
-
std::uint32_t line_ = 0
1-based line of the key in the deck it was parsed from, or 0 if unknown (e.g. a deck built in code rather than parsed)
-
std::uint32_t column_ = 0
1-based column of the key, or 0 if unknown
-
std::string hint_
For an unused key: a suggestion of what was probably meant, or empty if there is none
-
std::string reason_
For an ignored key: why it was not read, e.g. “nebular.compute_neb is false”
-
std::string path_