File comp_rlitt_grafting.h
FileList > comp-rlitt_grafting > src > comp_rlitt_grafting.h
Go to the source code of this file
A module for compute rlitt_grafting. More...
#include "computation_defs.h"#include "storage_defs.h"#include "notation_wptt.h"#include "stdbool.h"#include "stdlib.h"#include "string.h"
Classes
| Type | Name |
|---|---|
| struct | comp_rlitt_grafting_config_t The type definition for configuring the rlitt_grafting computation. |
| struct | comp_rlitt_grafting_result_t The type definition for the result reporting of the rlitt_grafting computation. |
Public Functions
| Type | Name |
|---|---|
| uint8_t | comp_rlitt_grafting_compute () A public function, calling this executes the computation on the configured tangle. |
| uint8_t | comp_rlitt_grafting_config (comp_rlitt_grafting_config_t * config_arg) The public configuration function. |
| const comp_rlitt_grafting_result_t * | comp_rlitt_grafting_result () A public function, calling this retrieves the results of the last computation. |
Macros
| Type | Name |
|---|---|
| define | COMP_RLITT_GRAFTING_COMPUTE_ALREADY_COMPUTED (0x1u << 5u)Failed to configure the module due to config having previously been processed. |
| define | COMP_RLITT_GRAFTING_COMPUTE_CFG_ERROR (0x1u << 3u)Failed to configure the module due to config error. |
| define | COMP_RLITT_GRAFTING_COMPUTE_COPYERROR (0x1u << 4u)Failed to configure the module due to error in copying. |
| define | COMP_RLITT_GRAFTING_COMPUTE_GRAFTING_RLITT (0x1u << 2u)Failed to configure the module due to issue in the grafting operation. |
| define | COMP_RLITT_GRAFTING_COMPUTE_ROOTSTOCK (0x1u << 1u)Failed to configure the module due to issue in rootstock. |
| define | COMP_RLITT_GRAFTING_CONFIG_BUFFER (0x1u << 4u)Failed to configure the module due to error in config buffer. |
| define | COMP_RLITT_GRAFTING_CONFIG_IS_NULL (0x1u << 3u)Failed to configure the module due to null config. |
| define | COMP_RLITT_GRAFTING_CONFIG_ROOTSTOCK (0x1u << 1u)Failed to configure the module due to issue in rootstock. |
| define | COMP_RLITT_GRAFTING_CONFIG_SCION (0x1u << 2u)Failed to configure the module due to issue in scion. |
Detailed Description
Author:
Joe Starr
Public Functions Documentation
function comp_rlitt_grafting_compute
A public function, calling this executes the computation on the configured tangle.
uint8_t comp_rlitt_grafting_compute ()
Returns:
uint8_t computation status info.
function comp_rlitt_grafting_config
The public configuration function.
uint8_t comp_rlitt_grafting_config (
comp_rlitt_grafting_config_t * config_arg
)
Parameters:
config_argThe config to set.
function comp_rlitt_grafting_result
A public function, calling this retrieves the results of the last computation.
const comp_rlitt_grafting_result_t * comp_rlitt_grafting_result ()
Returns:
comp_rlitt_grafting_result_t Computation results.
Macro Definition Documentation
define COMP_RLITT_GRAFTING_COMPUTE_ALREADY_COMPUTED
Failed to configure the module due to config having previously been processed.
#define COMP_RLITT_GRAFTING_COMPUTE_ALREADY_COMPUTED `(0x1u << 5u)`
define COMP_RLITT_GRAFTING_COMPUTE_CFG_ERROR
Failed to configure the module due to config error.
#define COMP_RLITT_GRAFTING_COMPUTE_CFG_ERROR `(0x1u << 3u)`
define COMP_RLITT_GRAFTING_COMPUTE_COPYERROR
Failed to configure the module due to error in copying.
#define COMP_RLITT_GRAFTING_COMPUTE_COPYERROR `(0x1u << 4u)`
define COMP_RLITT_GRAFTING_COMPUTE_GRAFTING_RLITT
Failed to configure the module due to issue in the grafting operation.
#define COMP_RLITT_GRAFTING_COMPUTE_GRAFTING_RLITT `(0x1u << 2u)`
define COMP_RLITT_GRAFTING_COMPUTE_ROOTSTOCK
Failed to configure the module due to issue in rootstock.
#define COMP_RLITT_GRAFTING_COMPUTE_ROOTSTOCK `(0x1u << 1u)`
define COMP_RLITT_GRAFTING_CONFIG_BUFFER
Failed to configure the module due to error in config buffer.
#define COMP_RLITT_GRAFTING_CONFIG_BUFFER `(0x1u << 4u)`
define COMP_RLITT_GRAFTING_CONFIG_IS_NULL
Failed to configure the module due to null config.
#define COMP_RLITT_GRAFTING_CONFIG_IS_NULL `(0x1u << 3u)`
define COMP_RLITT_GRAFTING_CONFIG_ROOTSTOCK
Failed to configure the module due to issue in rootstock.
#define COMP_RLITT_GRAFTING_CONFIG_ROOTSTOCK `(0x1u << 1u)`
define COMP_RLITT_GRAFTING_CONFIG_SCION
Failed to configure the module due to issue in scion.
#define COMP_RLITT_GRAFTING_CONFIG_SCION `(0x1u << 2u)`
The documentation for this class was generated from the following file source/comp-rlitt_grafting/src/comp_rlitt_grafting.h