Class use to represent OptionDefinitions that need to store two values. More...
#include <configBase.h>
Public Member Functions | |
| OptionDefinitionPair (std::string name1, T val1, std::string name2, U val2, std::function< int(T &, U &, std::string)> parser) | |
| Constructor. More... | |
| OptionDefinitionPair (std::string name1, T val1, std::string name2, U val2, std::function< int(T &, U &, std::string)> parser, std::function< std::string()> ext_help) | |
| Constructor. More... | |
| OptionDefinitionPair (const OptionDefinitionPair &)=delete | |
| OptionDefinitionPair (OptionDefinitionPair &&)=default | |
| int | parse (std::string arg) override |
| Function called to parse the option. More... | |
| void | transfer (OptionDefinition *def) override |
| Function called to transfer the value(s) of a separate OptionDefinition to the current OptionDefinition. More... | |
| void | serialize (SST::Core::Serialization::serializer &ser) override |
| Function called to serialize the data in the OptionDefinition. More... | |
| void | to_string (std::vector< std::string > &out) override |
| Adds a string representation to the input vector for each of the underlying variables. More... | |
 Public Member Functions inherited from SST::OptionDefinition | |
| OptionDefinition (std::function< std::string()> ext_help) | |
Data Fields | |
| T | value1 = T() |
| std::string | name1 |
| U | value2 = U() |
| std::string | name2 |
| const std::function< int(T &, U &, std::string)> | parser |
| Data Fields inherited from SST::OptionDefinition | |
| const std::function< std::string()> | ext_help |
| bool | set_cmdline = false |
Detailed Description
template<typename T, typename U>
struct SST::OptionDefinitionPair< T, U >
Class use to represent OptionDefinitions that need to store two values.
The class is templated on the types of the stored data.
NOTE: This class should be created using the DECL_OPTION_PAIR macro, which will also create accessor functions the two underlying data types.
Constructor & Destructor Documentation
◆ OptionDefinitionPair() [1/2]
|
inline |
Constructor.
- Parameters
-
name1 Name of the first value val1 Initialzation value of value1 name2 Name of the first value val2 Initialzation value of value2 parser Function used to parese the values
◆ OptionDefinitionPair() [2/2]
|
inline |
Constructor.
- Parameters
-
name1 Name of the first value val1 Initialzation value of value1 name2 Name of the first value val2 Initialzation value of value2 parser Function used to parese the values ext_help Function called to print the extended help for the option
Member Function Documentation
◆ parse()
|
inlineoverridevirtual |
Function called to parse the option.
This generally defers to an underlying std::function that is defined when the OptionDefinition is declared (see children classes). There are standard parsers found in the StandardConfigParsers namespace, and extra parsing functions can be added to the namespace by child classes, if needed.
- Parameters
-
arg Argument passed to the option on the command line
Implements SST::OptionDefinition.
◆ serialize()
|
inlineoverridevirtual |
Function called to serialize the data in the OptionDefinition.
- See also
- Impl::option_serialize_data()
- Parameters
-
ser Serializer used to serialize the data
Implements SST::OptionDefinition.
◆ to_string()
|
inlineoverridevirtual |
Adds a string representation to the input vector for each of the underlying variables.
Format is variable = value. If there are no underlying variables, nothing will be added.
- Parameters
-
[out] out vector to put the output strings in
Implements SST::OptionDefinition.
◆ transfer()
|
inlineoverridevirtual |
Function called to transfer the value(s) of a separate OptionDefinition to the current OptionDefinition.
- Parameters
-
def OptionDefinition to copy value(s) from
Implements SST::OptionDefinition.
The documentation for this struct was generated from the following file:
- src/sst/core/configBase.h
