File generator_montesinos.h
FileList > gen-montesinos > src > generator_montesinos.h
Go to the source code of this file
A module for generating montesinos tangles. More...
#include "generator_defs.h"#include "storage_defs.h"#include "notation_att.h"#include "stdbool.h"#include "stdlib.h"#include "string.h"
Classes
| Type | Name |
|---|---|
| struct | gen_montesinos_config_t The type definition for configuring the montesinos generation. |
Public Functions
| Type | Name |
|---|---|
| uint8_t | gen_montesinos_config (gen_montesinos_config_t * config_arg) The public configuration function. |
| uint8_t | gen_montesinos_generate () The public generation function. When called the module will work against the current config. |
Macros
| Type | Name |
|---|---|
| define | GEN_MONTESINOS_CONFIG_BUFFER (0x1u << 2u)Failed to configure the module due to issue in buffer. |
| define | GEN_MONTESINOS_CONFIG_IS_NULL (0x1u << 1u)Failed to configure the module due to null config. |
| define | GEN_MONTESINOS_CONFIG_STR_BUFFER (0x1u << 3u)Failed to configure the module due to issue in string buffer. |
| define | GEN_MONTESINOS_STORAGE_UKEY ("GEN\_MONTESINOS")The key for. |
Detailed Description
Author:
Isabel Darcy
Author:
Zachary Bryhtan
Author:
Joe Starr
Public Functions Documentation
function gen_montesinos_config
The public configuration function.
uint8_t gen_montesinos_config (
gen_montesinos_config_t * config_arg
)
Parameters:
config_argThe config to set.
function gen_montesinos_generate
The public generation function. When called the module will work against the current config.
uint8_t gen_montesinos_generate ()
Returns:
uint8_t Generation status info.
Macro Definition Documentation
define GEN_MONTESINOS_CONFIG_BUFFER
Failed to configure the module due to issue in buffer.
#define GEN_MONTESINOS_CONFIG_BUFFER `(0x1u << 2u)`
define GEN_MONTESINOS_CONFIG_IS_NULL
Failed to configure the module due to null config.
#define GEN_MONTESINOS_CONFIG_IS_NULL `(0x1u << 1u)`
define GEN_MONTESINOS_CONFIG_STR_BUFFER
Failed to configure the module due to issue in string buffer.
#define GEN_MONTESINOS_CONFIG_STR_BUFFER `(0x1u << 3u)`
define GEN_MONTESINOS_STORAGE_UKEY
The key for.
#define GEN_MONTESINOS_STORAGE_UKEY `("GEN_MONTESINOS")`
The documentation for this class was generated from the following file source/gen-montesinos/src/generator_montesinos.h