File generator_rlitt.h

FileList > gen-rlitt > src > generator_rlitt.h

Generator module for rlitt generator. More...

#include "generator_defs.h"
#include "notation_wptt.h"
#include "storage_defs.h"

Classes

Type	Name
struct	gen_rlitt_config_t The type definition for configuring the rlitt generation.

Public Types

Type	Name
typedef struct gen_rlitt_config_t	gen_rlitt_config_t The type definition for configuring the rlitt generation.
enum	gen_rlitt_positivity_e Type defining the \(V\_4\) label for a wptt.
typedef enum gen_rlitt_positivity_e	gen_rlitt_positivity_e Type defining the \(V\_4\) label for a wptt.

Public Functions

Type	Name
uint8_t	gen_rlitt_config (gen_rlitt_config_t * config_arg) The public configuration function.
uint8_t	gen_rlitt_generate () The public generation function. When called the module will work against the current config.

Macros

Type	Name
define	GEN_RLITT_CONFIG_IS_NULL `(0x1u << 1u)` Failed to configure the module due to issue in rootstock.
define	GEN_RLITT_CONFIG_ROOTSTOCKS_ERROR `(0x1u << 2u)` Failed to configure the module due to issue in scion.
define	GEN_RLITT_CONFIG_SCIONS_ERROR `(0x1u << 3u)` Failed to configure the module due to null config.
define	GEN_RLITT_GENERATE_ALREADY_COMPUTED `(0x1u << 5u)` Failed to configure the module due to null config.
define	GEN_RLITT_GENERATE_CFG_ERROR `(0x2u << 2u)` Failed to configure the module due to null config.
define	GEN_RLITT_GENERATE_GRAFTING `(0x1u << 3u)` Failed to configure the module due to null config.
define	GEN_RLITT_GENERATE_NEUTRALITY `(0x1u << 4u)` Failed to configure the module due to null config.
define	GEN_RLITT_GENERATE_PRINT_ERROR `(0x2u << 1u)` Failed to configure the module due to null config.
define	GEN_RLITT_GENERATE_ROOTSTOCK `(0x1u << 1u)` Failed to configure the module due to issue in rootstock.
define	GEN_RLITT_GENERATE_SCION `(0x1u << 2u)` Failed to configure the module due to issue in scion.
define	GEN_RLITT_GENERATE_SHIFT `(0x1u << 6u)` Failed to configure the module due to null config.

Detailed Description

Author:

Joe Starr

Public Types Documentation

typedef gen_rlitt_config_t

The type definition for configuring the rlitt generation.

typedef struct gen_rlitt_config_t gen_rlitt_config_t;

enum gen_rlitt_positivity_e

Type defining the \(V\_4\) label for a wptt.

enum gen_rlitt_positivity_e {
    GEN_RLITT_UNINIT,
    GEN_RLITT_POS,
    GEN_RLITT_NEG,
    GEN_RLITT_NEU
};

typedef gen_rlitt_positivity_e

Type defining the \(V\_4\) label for a wptt.

typedef enum gen_rlitt_positivity_e gen_rlitt_positivity_e;

Public Functions Documentation

function gen_rlitt_config

The public configuration function.

uint8_t gen_rlitt_config (
    gen_rlitt_config_t * config_arg
)

Parameters:

config_arg The config to set.

function gen_rlitt_generate

The public generation function. When called the module will work against the current config.

uint8_t gen_rlitt_generate ()

Returns:

uint8_t Generation status info.

Macro Definition Documentation

define GEN_RLITT_CONFIG_IS_NULL

Failed to configure the module due to issue in rootstock.

#define GEN_RLITT_CONFIG_IS_NULL `(0x1u << 1u)`

define GEN_RLITT_CONFIG_ROOTSTOCKS_ERROR

Failed to configure the module due to issue in scion.

#define GEN_RLITT_CONFIG_ROOTSTOCKS_ERROR `(0x1u << 2u)`

define GEN_RLITT_CONFIG_SCIONS_ERROR

Failed to configure the module due to null config.

#define GEN_RLITT_CONFIG_SCIONS_ERROR `(0x1u << 3u)`

define GEN_RLITT_GENERATE_ALREADY_COMPUTED

Failed to configure the module due to null config.

#define GEN_RLITT_GENERATE_ALREADY_COMPUTED `(0x1u << 5u)`

define GEN_RLITT_GENERATE_CFG_ERROR

Failed to configure the module due to null config.

#define GEN_RLITT_GENERATE_CFG_ERROR `(0x2u << 2u)`

define GEN_RLITT_GENERATE_GRAFTING

Failed to configure the module due to null config.

#define GEN_RLITT_GENERATE_GRAFTING `(0x1u << 3u)`

define GEN_RLITT_GENERATE_NEUTRALITY

Failed to configure the module due to null config.

#define GEN_RLITT_GENERATE_NEUTRALITY `(0x1u << 4u)`

define GEN_RLITT_GENERATE_PRINT_ERROR

Failed to configure the module due to null config.

#define GEN_RLITT_GENERATE_PRINT_ERROR `(0x2u << 1u)`

define GEN_RLITT_GENERATE_ROOTSTOCK

Failed to configure the module due to issue in rootstock.

#define GEN_RLITT_GENERATE_ROOTSTOCK `(0x1u << 1u)`

define GEN_RLITT_GENERATE_SCION

Failed to configure the module due to issue in scion.

#define GEN_RLITT_GENERATE_SCION `(0x1u << 2u)`

define GEN_RLITT_GENERATE_SHIFT

Failed to configure the module due to null config.

#define GEN_RLITT_GENERATE_SHIFT `(0x1u << 6u)`

The documentation for this class was generated from the following file source/gen-rlitt/src/generator_rlitt.h