Unit Description

classDiagram
    generator *-- gen_config_t
    class generator {
        <<interface>>
        - gen_config_t config
        - bool executed
        + int gen_config(gen_config_t config)
        + int gen_generate()
    }

    class gen_config_t {
        <<struct>>
        + int storage_write(key, index, value)
    }

Functionality

Public Structures

Generator Configuration Structure

The generator config structure defines the collection of data the component needs for a single run. Setting a config should be considered equivalent to instantiating a class in a high-level language. However, in this case, there is only ever a single active instance of the class.

Public Functions

Configuration Function

The function will take a configuration as input and set the local config instance to that input. The function returns a flag indicating if the function was successful. This function can be considered analogous to the init function of a class in a high-level language.

Generate Function

When this function is invoked, the generation process begins. The actual internal functionality is specific to the specific generator. The function returns a flag indicating if the function was successful.

The flow for a generator is modeled by the following state machine:

```mermaid} stateDiagram-v2 state "Get data" as gd state "Generate new data" as wod state "Report new data" as rv state if_done <>

[*] --> gd
gd  -->  wod
wod --> rv
rv --> if_done
if_done --> [*]: Operations are complete
if_done --> wod: Operations are not complete

```