Rules Based Framework

Modules

RBF Errors

Data Structures

struct RBF_value
struct RBF_name_value

RBF Enumerations

enum AEPRuleType_e { DecisionTableType }
enum RBFDataType_e {
StringType, DateType, DoubleType, FloatType,
IntegerType, LogicalType, BusinessObjectType
}
enum RBFInput_e { InPrimitive, InBusinessObject }
enum RBFOutput_e { OutPrimitive }
enum RBFColumn_e { Input, Output }
enum RBFExpressionType_e {
EqualTo, NotEqualTo, GreaterThan, GreaterThanOrEqualTo,
LessThan, LessThanOrEqualTo, Between
}
typedef enum AEPRuleType_e AEPRuleType_t
typedef enum RBFDataType_e RBFDataType_t
typedef enum RBFInput_e RBFInput_t
typedef enum RBFOutput_e RBFOutput_t
typedef enum RBFColumn_e RBFColumn_t
typedef enum RBFExpressionType_e RBFExpressionType_t

Maximum RBF sizes

#define RBF_BUSINESS_ELEMENT_NAME_size_c 128
#define RBF_CATEGORY_size_c 240
#define RBF_COLUMN_NAME_size_c 128
#define RBF_ID_size_c 240
#define RBF_OPERAND_size_c 240
#define RBF_PROPERTY_NAME_size_c 128
#define RBF_TYPE_NAME_size_c 128

RBF Preferences

#define RBF_ENABLE_DEBUG_PREF "RBF_ENABLE_DEBUG"

rbf_value dataTypes

#define RBF_VALUE_DATATYPE_STRING "STRING"
#define RBF_VALUE_DATATYPE_BOOLEAN "BOOLEAN"
#define RBF_VALUE_DATATYPE_INTEGER "INTEGER"
#define RBF_VALUE_DATATYPE_DOUBLE "DOUBLE"
#define RBF_VALUE_DATATYPE_FLOAT "FLOAT"
#define RBF_VALUE_DATATYPE_DATE "DATE"
#define RBF_VALUE_DATATYPE_TAG "TAG"

Defines

#define RBF_DATE_FORMAT "%Y%m%d"
#define RBF_DATE_NULL "00000000"
#define RBF_FALSE_STRING "false"
#define RBF_TRUE_STRING "true"

Functions

RBF_API int RBF_build_name_value_pairs (const char *nvp_name, const char *nvp_data_type, const char *nvp_value, int *count, RBF_name_value **values)
RBF_API void RBF_free_name_value (int count, RBF_name_value **values)
RBF_API int RBF_execute (const char *id, int in_count, RBF_name_value *in_values, int *result_count, RBF_name_value **result_values)

Define Documentation

#define RBF_BUSINESS_ELEMENT_NAME_size_c 128

Definition at line 31 of file rbf.h.

#define RBF_CATEGORY_size_c 240

Definition at line 32 of file rbf.h.

#define RBF_COLUMN_NAME_size_c 128

Definition at line 33 of file rbf.h.

#define RBF_DATE_FORMAT "%Y%m%d"

Definition at line 40 of file rbf.h.

#define RBF_DATE_NULL "00000000"

Definition at line 41 of file rbf.h.

#define RBF_ENABLE_DEBUG_PREF "RBF_ENABLE_DEBUG"

Definition at line 49 of file rbf.h.

#define RBF_FALSE_STRING "false"

Definition at line 42 of file rbf.h.

#define RBF_ID_size_c 240

Definition at line 34 of file rbf.h.

#define RBF_OPERAND_size_c 240

Definition at line 35 of file rbf.h.

#define RBF_PROPERTY_NAME_size_c 128

Definition at line 36 of file rbf.h.

#define RBF_TRUE_STRING "true"

Definition at line 43 of file rbf.h.

#define RBF_TYPE_NAME_size_c 128

Definition at line 37 of file rbf.h.

#define RBF_VALUE_DATATYPE_BOOLEAN "BOOLEAN"

Definition at line 106 of file rbf.h.

#define RBF_VALUE_DATATYPE_DATE "DATE"

Definition at line 110 of file rbf.h.

#define RBF_VALUE_DATATYPE_DOUBLE "DOUBLE"

Definition at line 108 of file rbf.h.

#define RBF_VALUE_DATATYPE_FLOAT "FLOAT"

Definition at line 109 of file rbf.h.

#define RBF_VALUE_DATATYPE_INTEGER "INTEGER"

Definition at line 107 of file rbf.h.

#define RBF_VALUE_DATATYPE_STRING "STRING"

Definition at line 105 of file rbf.h.

#define RBF_VALUE_DATATYPE_TAG "TAG"

Definition at line 111 of file rbf.h.

Typedef Documentation

typedef enum AEPRuleType_e AEPRuleType_t

typedef enum RBFColumn_e RBFColumn_t

typedef enum RBFDataType_e RBFDataType_t

typedef enum RBFExpressionType_e RBFExpressionType_t

typedef enum RBFInput_e RBFInput_t

typedef enum RBFOutput_e RBFOutput_t

Enumeration Type Documentation

enum AEPRuleType_e

Enumerator:

DecisionTableType

Definition at line 56 of file rbf.h.

enum RBFColumn_e

Enumerator:

Input
Output

Definition at line 83 of file rbf.h.

enum RBFDataType_e

Enumerator:

StringType
DateType
DoubleType
FloatType
IntegerType
LogicalType
BusinessObjectType

Definition at line 61 of file rbf.h.

enum RBFExpressionType_e

Enumerator:

EqualTo
NotEqualTo
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo
Between

Definition at line 89 of file rbf.h.

enum RBFInput_e

Enumerator:

InPrimitive
InBusinessObject

Definition at line 72 of file rbf.h.

enum RBFOutput_e

Enumerator:

OutPrimitive

Definition at line 78 of file rbf.h.

Function Documentation

RBF_API int RBF_build_name_value_pairs	(	const char *	nvp_name,
		const char *	nvp_data_type,
		const char *	nvp_value,
		int *	count,
		RBF_name_value **	values
	)

Builds the array of name/value pair structures.

If the values parameter is NULL, then count and values will be initialized with a new parameter.
If the values parameter is not NULL (already populated), then the count will be incremented and values will be reallocated and a new parameter added.

Parameters:

nvp_name	(I)
nvp_data_type	(I)
nvp_value	(I)
count	(I/O)
values	(I/O) RBF_free_name_value

RBF_API int RBF_execute	(	const char *	id,
		int	in_count,
		RBF_name_value *	in_values,
		int *	result_count,
		RBF_name_value **	result_values
	)

Execute the rules engine.

Parameters:

id	(I)
in_count	(I)
in_values	(I)
result_count	(O)
result_values	(OF) RBF_free_name_value

RBF_API void RBF_free_name_value	(	int	count,
		RBF_name_value **	values
	)

Free the name/value pair array of structures (allocated by RBF_build_name_value_pairs).

Parameters:

count	(I)
values	(I/O)