File comp_rlitt_pure_vignette.h
FileList > comp-rlitt_pure_vignette > src > comp_rlitt_pure_vignette.h
Go to the source code of this file
A module for compute rlitt_pure_vignette. More...
#include "notation_wptt.h"#include "stdlib.h"#include "storage_defs.h"#include "computation_defs.h"
Classes
| Type | Name |
|---|---|
| struct | comp_rlitt_pure_vignette_config_t The type definition for configuring the rlitt_pure_vignette computation. |
| struct | comp_rlitt_pure_vignette_result_t The type definition for reporting the results of rlitt_pure_vignette computation. |
Public Functions
| Type | Name |
|---|---|
| uint8_t | comp_rlitt_pure_vignette_compute () A public function, calling this executes the computation on the configured tangle. |
| uint8_t | comp_rlitt_pure_vignette_config (comp_rlitt_pure_vignette_config_t * config_arg) The public configuration function. |
| const comp_rlitt_pure_vignette_result_t * | comp_rlitt_pure_vignette_result () A public function, calling this retrieves the results of the last computation. |
Macros
| Type | Name |
|---|---|
| define | COMP_RLITT_PURE_VIGNETTE_COMPUTE_ALREADY_COMPUTED (0X1U << 2U)Failed to configure the module due to config already having been processed. |
| define | COMP_RLITT_PURE_VIGNETTE_COMPUTE_CFG_ERROR (0X1U << 1U)Failed to configure the module due to config error. |
| define | COMP_RLITT_PURE_VIGNETTE_COMPUTE_STACK_OVRFLW (0X1U << 4U)Failed to configure the module due to issue in scion. |
| define | COMP_RLITT_PURE_VIGNETTE_COMPUTE_STR_BUFFER (0X1U << 3U)Failed to configure the module due to issue in scion. |
| define | COMP_RLITT_PURE_VIGNETTE_CONFIG_IS_NULL (0X1U << 3U)Failed to configure the module due to null config. |
| define | COMP_RLITT_PURE_VIGNETTE_CONFIG_NULLTREE (0X1U << 1U)Failed to configure the module due to issue in rootstock. |
Detailed Description
Author:
Joe Starr
Public Functions Documentation
function comp_rlitt_pure_vignette_compute
A public function, calling this executes the computation on the configured tangle.
uint8_t comp_rlitt_pure_vignette_compute ()
Returns:
uint8_t Generation status info.
function comp_rlitt_pure_vignette_config
The public configuration function.
uint8_t comp_rlitt_pure_vignette_config (
comp_rlitt_pure_vignette_config_t * config_arg
)
Parameters:
config_argThe config to set.
function comp_rlitt_pure_vignette_result
A public function, calling this retrieves the results of the last computation.
const comp_rlitt_pure_vignette_result_t * comp_rlitt_pure_vignette_result ()
Returns:
comp_rlitt_pure_vignette_result_t Computation results.
Macro Definition Documentation
define COMP_RLITT_PURE_VIGNETTE_COMPUTE_ALREADY_COMPUTED
Failed to configure the module due to config already having been processed.
#define COMP_RLITT_PURE_VIGNETTE_COMPUTE_ALREADY_COMPUTED `(0X1U << 2U)`
define COMP_RLITT_PURE_VIGNETTE_COMPUTE_CFG_ERROR
Failed to configure the module due to config error.
#define COMP_RLITT_PURE_VIGNETTE_COMPUTE_CFG_ERROR `(0X1U << 1U)`
define COMP_RLITT_PURE_VIGNETTE_COMPUTE_STACK_OVRFLW
Failed to configure the module due to issue in scion.
#define COMP_RLITT_PURE_VIGNETTE_COMPUTE_STACK_OVRFLW `(0X1U << 4U)`
define COMP_RLITT_PURE_VIGNETTE_COMPUTE_STR_BUFFER
Failed to configure the module due to issue in scion.
#define COMP_RLITT_PURE_VIGNETTE_COMPUTE_STR_BUFFER `(0X1U << 3U)`
define COMP_RLITT_PURE_VIGNETTE_CONFIG_IS_NULL
Failed to configure the module due to null config.
#define COMP_RLITT_PURE_VIGNETTE_CONFIG_IS_NULL `(0X1U << 3U)`
define COMP_RLITT_PURE_VIGNETTE_CONFIG_NULLTREE
Failed to configure the module due to issue in rootstock.
#define COMP_RLITT_PURE_VIGNETTE_CONFIG_NULLTREE `(0X1U << 1U)`
The documentation for this class was generated from the following file source/comp-rlitt_pure_vignette/src/comp_rlitt_pure_vignette.h