vrule.h File Reference

#include <unidefs.h>
#include <ps/libps_exports.h>
#include <ps/libps_undef.h>

Go to the source code of this file.

Macros
#define	VRULE_vrule_class_name_c   "VariantRule"

Functions
PS_API int	VRULE_ask_rule_text (tag_t vrule, tag_t bom_window, int *n_entries, char ***items, char ***options, char ***descriptions, char ***values)
PS_API int	VRULE_create (const char *name, const char *description, tag_t *vrule)
PS_API int	VRULE_create_from_bom (const char *name, const char *description, tag_t bom_window, int n_options, const tag_t *options, tag_t *vrule)
PS_API int	VRULE_create_from_variant_rule (const char *name, const char *description, tag_t bomvariantrule, int n_options, const tag_t *options, tag_t *vrule)
PS_API int	VRULE_set_from_bom (tag_t vrule, tag_t bom_window, logical update_only, int n_options, const tag_t *options)
PS_API int	VRULE_set_from_variant_rule (tag_t vrule, tag_t bomvariantrule, logical update_only, int n_options, const tag_t *options)

Detailed Description

Function prototypes for saving Variant Rules.

These functions provide basic functionality for creating Variant Rules and populating them based on a configured BOM Window.

Variant Rules can be applied to a BOM Window using the BOM ITK functions BOM_window_apply_full_vrule and BOM_window_apply_partial_vrule.

The Variant Rule stores the options and values as Variant Expressions using the RULE_SET operator. These variant expressions can be accessed by retrieving the "expression_block" property from the Variant Rule, and using the Variant ITK on the returned Variant Expression Block.

Definition in file vrule.h.