datatools::configuration::variant_parameter_set_type Struct Reference

A triplet of character strings representing a variant parameter set directive. More...

#include <bayeux/datatools/configuration/utils.h>

Public Member Functions
	variant_parameter_set_type ()
void	reset ()
command::returned_info	parse (const std::string &variant_set_)

Public Attributes
std::string	registry_key
	The registration key of the variant registry the parameter belongs to. More...
std::string	param_key
	The full path of the variant parameter of which the value should be modify. More...
std::string	param_value_str
	The string to be parsed into the new value of the variant parameter. More...

Detailed Description

A triplet of character strings representing a variant parameter set directive.

Typical format is:

"{registry-name}:{path/to/the/variant/parameter}={value expression}"

The datatools kernel accept special command line options that automatically set the values of some variant parameters. Example:

myapp \
  --datatools::variant-config="myapp/variance.conf" \
  --datatools::variant-set="myapp:foo=1" \
  --datatools::variant-set="myapp:foo/small_value/algo=rk4" \
  --datatools::variant-set="myapp:foo/small_value/epsilon=0.01 mm"
  ...

Constructor & Destructor Documentation

variant_parameter_set_type()

datatools::configuration::variant_parameter_set_type::variant_parameter_set_type

(

)

Member Function Documentation

parse()

command::returned_info datatools::configuration::variant_parameter_set_type::parse

(

const std::string &

variant_set_

)

reset()

void datatools::configuration::variant_parameter_set_type::reset

(

)

Member Data Documentation

param_key

std::string datatools::configuration::variant_parameter_set_type::param_key

The full path of the variant parameter of which the value should be modify.

param_value_str

std::string datatools::configuration::variant_parameter_set_type::param_value_str

The string to be parsed into the new value of the variant parameter.

registry_key

std::string datatools::configuration::variant_parameter_set_type::registry_key

The registration key of the variant registry the parameter belongs to.

---

The documentation for this struct was generated from the following file:

• bayeux/datatools/configuration/utils.h