File comp_rlitt_positivity.h

FileList > comp-rlitt_positivity > src > comp_rlitt_positivity.h

A module for compute rlitt_positivity. More...

#include "notation_wptt.h"
#include "storage_defs.h"
#include "computation_defs.h"

Classes

Type	Name
struct	comp_rlitt_positivity_config_t The type definition for configuring the rlitt_positivity computation.
struct	comp_rlitt_positivity_result_t The type definition for reporting the results of rlitt_positivity computation.

Public Types

Type	Name
enum	comp_rlitt_positivity_flvrs_e Type defining the positivity states for a WPTT.
typedef enum comp_rlitt_positivity_flvrs_e	comp_rlitt_positivity_flvrs_e Type defining the positivity states for a WPTT.

Public Functions

Type	Name
uint8_t	comp_rlitt_positivity_compute () A public function, calling this executes the computation on the configured tangle.
uint8_t	comp_rlitt_positivity_config (comp_rlitt_positivity_config_t * config_arg) The public configuration function.
const comp_rlitt_positivity_result_t *	comp_rlitt_positivity_result () A public function, calling this retrieves the results of the last computation.

Macros

Type	Name
define	COMP_RLITT_POSITIVITY_COMPUTE_ALREADY_COMPUTED `(0X1U << 2U)` Failed to configure the module due to config already having been processed.
define	COMP_RLITT_POSITIVITY_COMPUTE_CFG_ERROR `(0X1U << 1U)` Failed to configure the module due to config error.
define	COMP_RLITT_POSITIVITY_CONFIG_IS_NULL `(0X1U << 3U)` Failed to configure the module due to null config.
define	COMP_RLITT_POSITIVITY_CONFIG_NULLTREE `(0X1U << 1U)` Failed to configure the module due to issue in rootstock.
define	COMP_RLITT_POSITIVITY_CONFIG_SCION `(0X1U << 2U)` Failed to configure the module due to issue in scion.

Detailed Description

Author:

Joe Starr

Public Types Documentation

enum comp_rlitt_positivity_flvrs_e

Type defining the positivity states for a WPTT.

enum comp_rlitt_positivity_flvrs_e {
    COMP_RLITT_POSITIVITY_FLVR_UNINIT,
    COMP_RLITT_POSITIVITY_FLVR_POS,
    COMP_RLITT_POSITIVITY_FLVR_NEG,
    COMP_RLITT_POSITIVITY_FLVR_NEU,
    COMP_RLITT_POSITIVITY_FLVR_UND
};

typedef comp_rlitt_positivity_flvrs_e

Type defining the positivity states for a WPTT.

typedef enum comp_rlitt_positivity_flvrs_e comp_rlitt_positivity_flvrs_e;

Public Functions Documentation

function comp_rlitt_positivity_compute

A public function, calling this executes the computation on the configured tangle.

uint8_t comp_rlitt_positivity_compute ()

Returns:

uint8_t Generation status info.

function comp_rlitt_positivity_config

The public configuration function.

uint8_t comp_rlitt_positivity_config (
    comp_rlitt_positivity_config_t * config_arg
)

Parameters:

config_arg The config to set.

function comp_rlitt_positivity_result

A public function, calling this retrieves the results of the last computation.

const comp_rlitt_positivity_result_t * comp_rlitt_positivity_result ()

Returns:

comp_rlitt_positivity_result_t Computation results.

Macro Definition Documentation

define COMP_RLITT_POSITIVITY_COMPUTE_ALREADY_COMPUTED

Failed to configure the module due to config already having been processed.

#define COMP_RLITT_POSITIVITY_COMPUTE_ALREADY_COMPUTED `(0X1U << 2U)`

define COMP_RLITT_POSITIVITY_COMPUTE_CFG_ERROR

Failed to configure the module due to config error.

#define COMP_RLITT_POSITIVITY_COMPUTE_CFG_ERROR `(0X1U << 1U)`

define COMP_RLITT_POSITIVITY_CONFIG_IS_NULL

Failed to configure the module due to null config.

#define COMP_RLITT_POSITIVITY_CONFIG_IS_NULL `(0X1U << 3U)`

define COMP_RLITT_POSITIVITY_CONFIG_NULLTREE

Failed to configure the module due to issue in rootstock.

#define COMP_RLITT_POSITIVITY_CONFIG_NULLTREE `(0X1U << 1U)`

define COMP_RLITT_POSITIVITY_CONFIG_SCION

Failed to configure the module due to issue in scion.

#define COMP_RLITT_POSITIVITY_CONFIG_SCION `(0X1U << 2U)`

The documentation for this class was generated from the following file source/comp-rlitt_positivity/src/comp_rlitt_positivity.h