amoc_config_verification (amoc v4.1.1)

View Source

This module is responsible for processing scenario configuration. It applies the verification function provided in the required_variable parameter to the respective value

See also: amoc_config.

Summary

Types

error/0
error_type/0
maybe_update_fun/0
maybe_verification_fun/0
module_configuration/0
module_parameter/0
name/0
reason/0
scope/0
settings/0
update_fun/0
value/0
verification_fun/0

Functions

process_scenario_config(Config, Settings)

Applies the processing as provided by the required_variable list to the provided scenario config

Types

error/0

-type error() :: {error, error_type(), reason()}.

error_type/0

-type error_type() :: atom().

maybe_update_fun/0

-type maybe_update_fun() :: update_fun() | fun((_, _) -> any()).

maybe_verification_fun/0

-type maybe_verification_fun() :: verification_fun() | fun((_) -> any()).

module_configuration/0

-type module_configuration() :: [module_parameter()].

module_parameter/0

-type module_parameter() ::
          #module_parameter{name :: name(),
                            mod :: module(),
                            value :: value(),
                            description :: unicode:chardata(),
                            scope :: scope(),
                            verification_fn :: maybe_verification_fun(),
                            update_fn :: maybe_update_fun() | read_only}.

name/0

-type name() :: atom().

reason/0

-type reason() :: any().

scope/0

-type scope() :: local | global.

settings/0

-type settings() :: [{name(), value()}].

update_fun/0

-type update_fun() :: fun((ParamName :: name(), NewValue :: value()) -> any()).

value/0

-type value() :: any().

verification_fun/0

-type verification_fun() ::
          fun((Value :: value()) -> boolean() | {true, NewValue :: value()} | {false, reason()}).

Functions

process_scenario_config(Config, Settings)

-spec process_scenario_config(module_configuration(), settings()) ->
                                 {ok, module_configuration()} | error().

Applies the processing as provided by the required_variable list to the provided scenario config