The type that options are passed around as. Contains YAML node data and an Context.
More...
#include <Options.hpp>
|
const Context & | context () const |
|
void | append_context (const std::string &context) |
| Append a line to the contained context.
|
|
template<typename T , typename Metavariables = NoSuchType> |
T | parse_as () const |
| Convert to an object of type T .
|
|
| Option (YAML::Node node, Context context={}) |
|
| Option (Context context) |
|
const YAML::Node & | node () const |
|
void | set_node (YAML::Node node) |
| Sets the node and updates the context's mark to correspond to it. More...
|
|
The type that options are passed around as. Contains YAML node data and an Context.
- Note
- To use any methods on this class in a concrete function you must include ParseOptions.hpp, but you do not need to include that header to use this in an uninstantiated
create_from_yaml::create
function.
◆ Option() [1/2]
Options::Option::Option |
( |
YAML::Node |
node, |
|
|
Context |
context = {} |
|
) |
| |
|
inlineexplicit |
- Note
- This constructor overwrites the mark data in the supplied context with the one from the node.
- Warning
- This method is for internal use of the option parser.
◆ Option() [2/2]
Options::Option::Option |
( |
Context |
context | ) |
|
|
inlineexplicit |
- Warning
- This method is for internal use of the option parser.
◆ node()
const YAML::Node & Options::Option::node |
( |
| ) |
const |
|
inline |
- Warning
- This method is for internal use of the option parser.
◆ set_node()
void Options::Option::set_node |
( |
YAML::Node |
node | ) |
|
|
inline |
Sets the node and updates the context's mark to correspond to it.
- Warning
- This method is for internal use of the option parser.
The documentation for this class was generated from the following files:
- src/Options/Options.hpp
- src/Options/ParseOptions.hpp