Data Structures
struct	BOM_bomset_create_criteria

struct	BOM_bomset_input_info

struct	BOM_bomset_output_info

Macros
#define	BOM_cmp_added(FLAGS) (((FLAGS)&(BOM_cmp_diff_add))!=0)

#define	BOM_cmp_changed(FLAGS) (((FLAGS)&(BOM_cmp_diff_chg))!=0)

#define	BOM_cmp_chg_qty(FLAGS) (((FLAGS)&(BOM_cmp_diff_qty))!=0)

#define	BOM_cmp_chg_rev(FLAGS) (((FLAGS)&(BOM_cmp_diff_rev))!=0)

#define	BOM_cmp_no_diff(FLAGS) ((FLAGS)==0)

#define	BOM_option_mode_enum PS_variant_option_mode_dynamic_comparison

#define	BOM_option_mode_int PS_variant_option_mode_unknown

#define	BOM_OVE_CONDITION_OUT_OF_SCOPE_OPTION 3

#define	BOM_OVE_MODULE_MVL_OUT_OF_SCOPE_OPTION 2

#define	BOM_OVE_PRES_OPTION_NO_PATH 1

#define	BOM_OVE_PRES_OPTION_NOT_CHILD 0

#define	BOM_variant_clause_op_add_brackets(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_add_brackets) != 0)

#define	BOM_variant_clause_op_append(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_append) != 0)

#define	BOM_variant_clause_op_delete(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_delete) != 0)

#define	BOM_variant_clause_op_details(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_details) != 0)

#define	BOM_variant_clause_op_insert(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_insert) != 0)

#define	BOM_variant_clause_op_mv_dn(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_mv_dn) != 0)

#define	BOM_variant_clause_op_mv_up(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_mv_up) != 0)

#define	BOM_variant_clause_op_replace(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_replace) != 0)

#define	BOM_variant_clause_op_rm_brackets(OP_FLAGS) (((OP_FLAGS)&BOM_vc_op_rm_brackets) != 0)

#define	BOM_variant_op_rhs_is_string PS_variant_op_rhs_is_string

#define	BOM_variant_operator_and PS_variant_operator_and

#define	BOM_variant_operator_assign PS_variant_operator_assign

#define	BOM_variant_operator_assy_uses PS_variant_operator_assy_uses

#define	BOM_variant_operator_brackets PS_variant_operator_brackets

#define	BOM_variant_operator_comment PS_variant_operator_comment

#define	BOM_variant_operator_declare PS_variant_operator_declare

#define	BOM_variant_operator_default PS_variant_operator_default

#define	BOM_variant_operator_error_if PS_variant_operator_error_if

#define	BOM_variant_operator_gt PS_variant_operator_gt

#define	BOM_variant_operator_gt_eq PS_variant_operator_gt_eq

#define	BOM_variant_operator_if PS_variant_operator_if

#define	BOM_variant_operator_is_equal PS_variant_operator_is_equal

#define	BOM_variant_operator_load_if PS_variant_operator_load_if

#define	BOM_variant_operator_lt PS_variant_operator_lt

#define	BOM_variant_operator_lt_eq PS_variant_operator_lt_eq

#define	BOM_variant_operator_meta_expr PS_variant_operator_meta_expr

#define	BOM_variant_operator_named_expr PS_variant_operator_named_expr

#define	BOM_variant_operator_not PS_variant_operator_not

#define	BOM_variant_operator_not_equal PS_variant_operator_not_equal

#define	BOM_variant_operator_nve_ref PS_variant_operator_nve_ref

#define	BOM_variant_operator_or PS_variant_operator_or

#define	BOM_variant_operator_rule_set PS_variant_operator_rule_set

#define	OPTION_DEFAULTED BOM_option_defaulted

#define	OPTION_DERIVED BOM_option_derived

#define	OPTION_SET_BY_RULE BOM_option_set_by_rule

#define	OPTION_SET_BY_USER BOM_option_set_by_user

#define	OPTION_SET_EXTERNAL BOM_option_external

#define	OPTION_UNSET BOM_option_unset

#define	OPTION_UNSET_DERIVABLE BOM_option_unset_derivable

Typedefs
typedef struct BOM_bomset_create_criteria	BOM_bomset_create_criteria_t

typedef enum BOM_bomset_criteria_e	BOM_bomset_criteria_t

typedef struct BOM_bomset_input_info	BOM_bomset_input_info_t

typedef struct BOM_bomset_output_info	BOM_bomset_output_info_t

typedef BOM_option_how_set_t	OptionHowSet_e

BOM_window_ask_state_logical() tokens
#define	BOM_WINDOW_STATE_PACK_ALL 1

#define	BOM_WINDOW_STATE_SHOW_VARIANTS 2

#define	BOM_WINDOW_STATE_SHOW_UNCONFIG 3

#define	BOM_WINDOW_STATE_SHOW_ALTS 4

BOM Line Forced Configuration states
#define	BOM_LINE_FORCE_NONE 0

#define	BOM_LINE_FORCE_CONFIGURE_IN 1

#define	BOM_LINE_FORCE_CONFIGURE_OUT 2

BOM Line Variant Configuration states
#define	BOM_LINE_VARIANT_NONE 0

#define	BOM_LINE_VARIANT_LOADED 1

#define	BOM_LINE_VARIANT_SUPPRESSED 2

#define	BOM_LINE_VARIANT_UNDEFINED 3

Standard BOM Compare modes' names
Use them with BOM_compare_execute(), and don't use BOM_compare() in new code.
BOM_API const char *const	BOM_std_compare_single_level_name

BOM_API const char *const	BOM_std_compare_single_level_seq_name

BOM_API const char *const	BOM_std_compare_lowest_level_name

BOM_API const char *const	BOM_std_compare_lowest_level_seq_name

BOM_API const char *const	BOM_std_compare_var_level_name

BOM_API const char *const	BOM_std_compare_var_level_seq_name

BOM_API const char *const	BOM_std_compare_ext_var_level_name

BOM_API const char *const	BOM_std_compare_ext_var_level_seq_name

BOM_API const char *const	LBOM_std_compare_var_level_name

BOM_API const char *const	LBOM_std_compare_single_level_name

BOM_API const char *const	LBOM_std_compare_lowest_level_name

BOM_API const char *const	LBOM_std_compare_var_level_occ_name

BOM_API const char *const	LBOM_std_compare_single_level_occ_name

Numeric modes
- For accessing the standard compare modes through BOM_compare(). DO NOT USE BOM_compare() in new code: use BOM_compare_execute() with the *_names defined above. Also used as traversal modes when defining/querying new compare modes using BOM_compare_define_mode() and BOM_compare_ask_mode_info().
#define	BOM_compare_singlelevel 0

#define	BOM_compare_lowestlevel 1

#define	BOM_compare_multilevel 2

#define	BOM_compare_extmultilevel 3

#define	BOM_compare_everylevel 4

BOM Compare output destinations
These values can be added together to output to all of them
#define	BOM_compare_output_bomline 1

#define	BOM_compare_output_userexit 2

#define	BOM_compare_output_report 4

BOM Compare application flags
These flags can be used to mark compare elements for special processing. Flags 0-15 are reserved for system defined flags. Flags 16-31 can be used by customers for passing simple flags into their custom compare methods.
#define	BOM_compare_display_aggregate 0

#define	BOM_compare_stop_if_diff 1

#define	BOM_compare_dont_report_adds 2

BOM Compare differences
#define	BOM_cmp_diff_add 1

#define	BOM_cmp_diff_qty 2

#define	BOM_cmp_diff_rev 4

#define	BOM_cmp_diff_chg 8

BOM Compare quantity special cases
#define	BOM_cmp_asreq(Q) (((Q)>(-1.5))&&((Q)<(-0.5)))

#define	BOM_cmp_undef(Q) (((Q)>(-2.5))&&((Q)<(-1.5)))

BOM Compare visitor function types
typedef int(	BOM_compare_engine_visitor_t )(tag_t bomcompareengine, tag_t compareset, int depth, void *user_data)

typedef int(	BOM_compare_set_visitor_t )(tag_t compareset, int depth, void *user_data)

Variant Condition Clause List - Valid Operation Macros
#define	BOM_vc_op_details 1

#define	BOM_vc_op_append 2

#define	BOM_vc_op_insert 4

#define	BOM_vc_op_replace 8

#define	BOM_vc_op_delete 16

#define	BOM_vc_op_mv_up 32

#define	BOM_vc_op_mv_dn 64

#define	BOM_vc_op_add_brackets 128

#define	BOM_vc_op_rm_brackets 256

BOMLine load states
#define	BOM_line_loaded 0

#define	BOM_line_remote 1

#define	BOM_line_no_read_access 2

OVE stuff
#define	BOM_OVE_ENUM_VALUE 1

#define	BOM_OVE_MIN_INC_VALUE 2

#define	BOM_OVE_MAX_INC_VALUE 3

#define	BOM_OVE_MIN_VALUE 4

#define	BOM_OVE_MAX_VALUE 5

#define	BOM_OVE_RANGE_VALUE 6

#define	BOM_OVE_INFO 0

#define	BOM_OVE_WARN 1

#define	BOM_OVE_ERROR 2

#define	BOM_OVE_IGNORE_ALL 9999

How Sets
#define	BOM_OVE_DEFAULT 0

#define	BOM_OVE_USERSET 1

#define	BOM_OVE_SET 2

#define	BOM_OVE_USERFIXED 3

#define	BOM_OVE_FIXED 4

#define	BOM_OVE_EXTERNAL 5

#define	BOM_OVE_VARIANTITEM 6

#define	BOM_OVE_LEGACY 100

Value types
#define	BOM_OVE_UNSET 0

#define	BOM_OVE_BOOL 1

#define	BOM_OVE_INT 2

#define	BOM_OVE_REAL 3

#define	BOM_OVE_STRING 4

BOM Variant Configuration
#define	BOM_VARIANT_CONFIG_REF 0

#define	BOM_VARIANT_CONFIG_COPY 1

#define	BOM_VARIANT_CONFIG_MANAGED 2

#define	BOM_VARIANT_CONFIG_DEEP 4

BOM DB SOS query operators
#define	BOM_DB_SOS_OP_LIKE 0

#define	BOM_DB_SOS_OP_NOT_LIKE 1

#define	BOM_DB_SOS_OP_EQ 2

#define	BOM_DB_SOS_OP_NE 3

#define	BOM_DB_SOS_OP_LT 4

#define	BOM_DB_SOS_OP_GT 5

#define	BOM_DB_SOS_OP_LTEQ 6

#define	BOM_DB_SOS_OP_GTEQ 7

#define	BOM_DB_SOS_OP_IN 8

#define	BOM_DB_SOS_OP_OUT 9

BOM DB SOS option types
#define	BOM_DB_SOS_UNDEFINED_OPTION 0

#define	BOM_DB_SOS_MODULAR_OPTION 1

#define	BOM_DB_SOS_LEGACY_OPTION 2

BOM DB SOS value types
#define	BOM_DB_SOS_UNDEFINED 0

#define	BOM_DB_SOS_LOGICAL 1

#define	BOM_DB_SOS_INTEGER 2

#define	BOM_DB_SOS_DOUBLE 3

#define	BOM_DB_SOS_STRING 4

BOM DB SOS how set
#define	BOM_DB_SOS_SET 0

#define	BOM_DB_SOS_FIXED 1

#define	BOM_DB_SOS_INFO 2

BOM Variant Configuration Mode
enum	BOM_var_config_mode_t { BOM_var_config_singlerule_singlevalue, BOM_var_config_singlerule_multivalue, BOM_var_config_overlay, BOM_var_multiple_rule_distinct_context }

Saved Variant Rule Action Integer Values.
Used by service operation VariantManagementImpl::getBOMVariantRules
#define	VRACTION_GET_RULE 0

#define	SVRACTION_OVERLAY_ADD_RULE 1

#define	SVRACTION_OVERLAY_REMOVE_RULE 2

#define	SVRACTION_OVERRIDE_RULE 3

#define	SVRACTION_UPDATE_RULE 4

Detailed Description

Macro Definition Documentation

#define BOM_cmp_added ( FLAGS ) (((FLAGS)&(BOM_cmp_diff_add))!=0)

This is a C macro that extracts the state of individual difference flags from the value returned by BOM_compare_list_diffs or BOM_compare_ask_difference.

Returns true if the added difference flag is set.

FLAGS - Differences between the two BOMs relating to a compare item.

Definition at line 253 of file bom_tokens.h.

#define BOM_cmp_asreq ( Q ) (((Q)>(-1.5))&&((Q)<(-0.5)))

Definition at line 279 of file bom_tokens.h.

#define BOM_cmp_changed ( FLAGS ) (((FLAGS)&(BOM_cmp_diff_chg))!=0)

Definition at line 273 of file bom_tokens.h.

#define BOM_cmp_chg_qty ( FLAGS ) (((FLAGS)&(BOM_cmp_diff_qty))!=0)

This is a C macro that extracts the state of individual difference flags from the value returned by BOM_compare_list_diffs or BOM_compare_ask_difference.

BOM_cmp_chg_qty returns true if the quantity change difference flag is set.

FLAGS - Differences between the two BOMs relating to a compare item.

Definition at line 263 of file bom_tokens.h.

#define BOM_cmp_chg_rev ( FLAGS ) (((FLAGS)&(BOM_cmp_diff_rev))!=0)

This is a C macro that extracts the state of individual difference flags from the value returned by BOM_compare_list_diffs or BOM_compare_ask_difference.

BOM_cmp_chg_rev returns true if the revision change difference flag is set.

Definition at line 271 of file bom_tokens.h.

#define BOM_cmp_diff_add 1

Definition at line 229 of file bom_tokens.h.

#define BOM_cmp_diff_chg 8

Definition at line 232 of file bom_tokens.h.

#define BOM_cmp_diff_qty 2

Definition at line 230 of file bom_tokens.h.

#define BOM_cmp_diff_rev 4

Definition at line 231 of file bom_tokens.h.

#define BOM_cmp_no_diff ( FLAGS ) ((FLAGS)==0)

This is a C macro that extracts the state of individual difference flags from the value returned by BOM_compare_list_diffs or BOM_compare_ask_difference.

Returns true if none of the difference flags are set.

FLAGS - Differences between the two BOMs relating to a compare item.

Definition at line 243 of file bom_tokens.h.

#define BOM_cmp_undef ( Q ) (((Q)>(-2.5))&&((Q)<(-1.5)))

Definition at line 280 of file bom_tokens.h.

#define BOM_compare_display_aggregate 0

Force BOM Compare to treat aggregate element as a display element when generating multi-level report output.

Definition at line 208 of file bom_tokens.h.

#define BOM_compare_dont_report_adds 2

By default, display elements report adds in the form "()->XYZ" (where XYZ is the value from the added object). However, this is undesirable in some elements. Setting this flag on an element will force it to report adds in the form "XYZ". Genuine changes in value will still be reported in the form "ABC->XYZ".

Definition at line 221 of file bom_tokens.h.

#define BOM_compare_everylevel 4

This traversal mode compares every single line in a BOM.

Definition at line 179 of file bom_tokens.h.

#define BOM_compare_extmultilevel 3

The following is a traversal mode only, there is no extended multi level compare mode. This traversal mode continues traversing through minor changes (ie. aggregate compare elements).

Definition at line 175 of file bom_tokens.h.

#define BOM_compare_lowestlevel 1

Definition at line 168 of file bom_tokens.h.

#define BOM_compare_multilevel 2

Definition at line 169 of file bom_tokens.h.

#define BOM_compare_output_bomline 1

Definition at line 189 of file bom_tokens.h.

#define BOM_compare_output_report 4

Definition at line 191 of file bom_tokens.h.

#define BOM_compare_output_userexit 2

Definition at line 190 of file bom_tokens.h.

#define BOM_compare_singlelevel 0

Definition at line 167 of file bom_tokens.h.

#define BOM_compare_stop_if_diff 1

Stop extended multi-level traversal if aggregate element is different. Normally used on Item Id element on Occurrence based compares.

Definition at line 213 of file bom_tokens.h.

#define BOM_DB_SOS_DOUBLE 3

Definition at line 598 of file bom_tokens.h.

#define BOM_DB_SOS_FIXED 1

Definition at line 607 of file bom_tokens.h.

#define BOM_DB_SOS_INFO 2

Definition at line 608 of file bom_tokens.h.

#define BOM_DB_SOS_INTEGER 2

Definition at line 597 of file bom_tokens.h.

#define BOM_DB_SOS_LEGACY_OPTION 2

Definition at line 588 of file bom_tokens.h.

#define BOM_DB_SOS_LOGICAL 1

Definition at line 596 of file bom_tokens.h.

#define BOM_DB_SOS_MODULAR_OPTION 1

Definition at line 587 of file bom_tokens.h.

#define BOM_DB_SOS_OP_EQ 2

Definition at line 572 of file bom_tokens.h.

#define BOM_DB_SOS_OP_GT 5

Definition at line 575 of file bom_tokens.h.

#define BOM_DB_SOS_OP_GTEQ 7

Definition at line 577 of file bom_tokens.h.

#define BOM_DB_SOS_OP_IN 8

Definition at line 578 of file bom_tokens.h.

#define BOM_DB_SOS_OP_LIKE 0

Definition at line 570 of file bom_tokens.h.

#define BOM_DB_SOS_OP_LT 4

Definition at line 574 of file bom_tokens.h.

#define BOM_DB_SOS_OP_LTEQ 6

Definition at line 576 of file bom_tokens.h.

#define BOM_DB_SOS_OP_NE 3

Definition at line 573 of file bom_tokens.h.

#define BOM_DB_SOS_OP_NOT_LIKE 1

Definition at line 571 of file bom_tokens.h.

#define BOM_DB_SOS_OP_OUT 9

Definition at line 579 of file bom_tokens.h.

#define BOM_DB_SOS_SET 0

Definition at line 606 of file bom_tokens.h.

#define BOM_DB_SOS_STRING 4

Definition at line 599 of file bom_tokens.h.

#define BOM_DB_SOS_UNDEFINED 0

Definition at line 595 of file bom_tokens.h.

#define BOM_DB_SOS_UNDEFINED_OPTION 0

Definition at line 586 of file bom_tokens.h.

#define BOM_LINE_FORCE_CONFIGURE_IN 1

Definition at line 118 of file bom_tokens.h.

#define BOM_LINE_FORCE_CONFIGURE_OUT 2

Definition at line 119 of file bom_tokens.h.

#define BOM_LINE_FORCE_NONE 0

Definition at line 117 of file bom_tokens.h.

#define BOM_line_loaded 0

Definition at line 466 of file bom_tokens.h.

#define BOM_line_no_read_access 2

Definition at line 468 of file bom_tokens.h.

#define BOM_line_remote 1

Definition at line 467 of file bom_tokens.h.

#define BOM_LINE_VARIANT_LOADED 1

Definition at line 127 of file bom_tokens.h.

#define BOM_LINE_VARIANT_NONE 0

Definition at line 126 of file bom_tokens.h.

#define BOM_LINE_VARIANT_SUPPRESSED 2

Definition at line 128 of file bom_tokens.h.

#define BOM_LINE_VARIANT_UNDEFINED 3

Definition at line 129 of file bom_tokens.h.

#define BOM_option_mode_enum PS_variant_option_mode_dynamic_comparison

Has a set of defined string values

Definition at line 41 of file bom_tokens.h.

#define BOM_option_mode_int PS_variant_option_mode_unknown

May take any integer value

Definition at line 38 of file bom_tokens.h.

#define BOM_OVE_BOOL 1

Definition at line 529 of file bom_tokens.h.

#define BOM_OVE_CONDITION_OUT_OF_SCOPE_OPTION 3

Seen within this module, and therefore will have no effect

Definition at line 553 of file bom_tokens.h.

#define BOM_OVE_DEFAULT 0

Definition at line 514 of file bom_tokens.h.

#define BOM_OVE_ENUM_VALUE 1

Enum - single value

Definition at line 477 of file bom_tokens.h.

#define BOM_OVE_ERROR 2

Definition at line 506 of file bom_tokens.h.

#define BOM_OVE_EXTERNAL 5

Definition at line 519 of file bom_tokens.h.

#define BOM_OVE_FIXED 4

Definition at line 518 of file bom_tokens.h.

#define BOM_OVE_IGNORE_ALL 9999

Definition at line 507 of file bom_tokens.h.

#define BOM_OVE_INFO 0

Definition at line 504 of file bom_tokens.h.

#define BOM_OVE_INT 2

Definition at line 530 of file bom_tokens.h.

#define BOM_OVE_LEGACY 100

Definition at line 521 of file bom_tokens.h.

#define BOM_OVE_MAX_INC_VALUE 3

MaxInc - maximum (inclusive) value (min will be undefined )

Definition at line 487 of file bom_tokens.h.

#define BOM_OVE_MAX_VALUE 5

Max - maximum (exclusive) value (min will be undefined )

Definition at line 497 of file bom_tokens.h.

#define BOM_OVE_MIN_INC_VALUE 2

MinInc - minimum (inclusive) value (max will be undefined )

Definition at line 482 of file bom_tokens.h.

#define BOM_OVE_MIN_VALUE 4

Min - minimum (exclusive) value (max will be undefined )

Definition at line 492 of file bom_tokens.h.

#define BOM_OVE_MODULE_MVL_OUT_OF_SCOPE_OPTION 2

The MVL on a module or node gets or sets a option that cannot be

Definition at line 548 of file bom_tokens.h.

#define BOM_OVE_PRES_OPTION_NO_PATH 1

The path to the option being presented does not lead to a child module and will have no effect

Definition at line 543 of file bom_tokens.h.

#define BOM_OVE_PRES_OPTION_NOT_CHILD 0

The option being presented option is not from a direct child module and will have no effect

Definition at line 538 of file bom_tokens.h.

#define BOM_OVE_RANGE_VALUE 6

Range - inclusive range from min to max

Definition at line 502 of file bom_tokens.h.

#define BOM_OVE_REAL 3

Definition at line 531 of file bom_tokens.h.

#define BOM_OVE_SET 2

Definition at line 516 of file bom_tokens.h.

#define BOM_OVE_STRING 4

Definition at line 532 of file bom_tokens.h.

#define BOM_OVE_UNSET 0

Definition at line 528 of file bom_tokens.h.

#define BOM_OVE_USERFIXED 3

Definition at line 517 of file bom_tokens.h.

#define BOM_OVE_USERSET 1

Definition at line 515 of file bom_tokens.h.

#define BOM_OVE_VARIANTITEM 6

Definition at line 520 of file bom_tokens.h.

#define BOM_OVE_WARN 1

Definition at line 505 of file bom_tokens.h.

#define BOM_variant_clause_op_add_brackets ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_add_brackets) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_toggle_brackets.

Note: There are separate entries for checking the validity of adding and removing brackets although they are implemented via the same toggle brackets operation. This allows a user interface to implement a tri-state bracketing button (indented if able to add, not indented if able to remove, disabled if neither).

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Toggle Brackets operation.
false - Selection is not valid for the Toggle Brackets operation.

Definition at line 430 of file bom_tokens.h.

#define BOM_variant_clause_op_append ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_append) != 0)

Definition at line 335 of file bom_tokens.h.

#define BOM_variant_clause_op_delete ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_delete) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_delete.

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Delete operation.
false - Selection is not valid for the Delete operation.

Definition at line 380 of file bom_tokens.h.

#define BOM_variant_clause_op_details ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_details) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_details.

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Details operation.
false - Selection is not valid for the Details operation.

Definition at line 332 of file bom_tokens.h.

#define BOM_variant_clause_op_insert ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_insert) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_insert.

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Insert operation.
false - Selection is not valid for the Insert operation.

Definition at line 350 of file bom_tokens.h.

#define BOM_variant_clause_op_mv_dn ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_mv_dn) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_move_down.

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Move Down operation.
false - Selection is not valid for the Move Down operation.

Definition at line 410 of file bom_tokens.h.

#define BOM_variant_clause_op_mv_up ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_mv_up) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_move_up.

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Move Up operation.
false - Selection is not valid for the Move Up operation.

Definition at line 395 of file bom_tokens.h.

#define BOM_variant_clause_op_replace ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_replace) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_replace.

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Replace operation.
false - Selection is not valid for the Replace operation.

Definition at line 365 of file bom_tokens.h.

#define BOM_variant_clause_op_rm_brackets ( OP_FLAGS ) (((OP_FLAGS)&BOM_vc_op_rm_brackets) != 0)

Returns true if the clause selection passed into BOM_variant_clause_valid_ops is valid for passing to BOM_variant_clause_toggle_brackets.

Note: There are separate entries for checking the validity of adding and removing brackets although they are implemented via the same toggle brackets operation. This allows a user interface to implement a tri-state bracketing button (indented if able to add, not indented if able to remove, disabled if neither).

Arguments

OP_FLAGS - The bit encoded integer returned by BOM_variant_clause_valid_ops.

Return Values

true - Selection is valid for the Toggle Brackets operation.
false - Selection is not valid for the Toggle Brackets operation.

Definition at line 450 of file bom_tokens.h.

#define BOM_VARIANT_CONFIG_COPY 1

Definition at line 561 of file bom_tokens.h.

#define BOM_VARIANT_CONFIG_DEEP 4

Definition at line 563 of file bom_tokens.h.

#define BOM_VARIANT_CONFIG_MANAGED 2

Definition at line 562 of file bom_tokens.h.

#define BOM_VARIANT_CONFIG_REF 0

Definition at line 560 of file bom_tokens.h.

#define BOM_variant_op_rhs_is_string PS_variant_op_rhs_is_string

Definition at line 42 of file bom_tokens.h.

#define BOM_variant_operator_and PS_variant_operator_and

Definition at line 52 of file bom_tokens.h.

#define BOM_variant_operator_assign PS_variant_operator_assign

Definition at line 45 of file bom_tokens.h.

#define BOM_variant_operator_assy_uses PS_variant_operator_assy_uses

Definition at line 44 of file bom_tokens.h.

#define BOM_variant_operator_brackets PS_variant_operator_brackets

Definition at line 68 of file bom_tokens.h.

#define BOM_variant_operator_comment PS_variant_operator_comment

Definition at line 50 of file bom_tokens.h.

#define BOM_variant_operator_declare PS_variant_operator_declare

Definition at line 43 of file bom_tokens.h.

#define BOM_variant_operator_default PS_variant_operator_default

Definition at line 46 of file bom_tokens.h.

#define BOM_variant_operator_error_if PS_variant_operator_error_if

Definition at line 49 of file bom_tokens.h.

#define BOM_variant_operator_gt PS_variant_operator_gt

Greater than

Definition at line 57 of file bom_tokens.h.

#define BOM_variant_operator_gt_eq PS_variant_operator_gt_eq

Greater than or equal

Definition at line 63 of file bom_tokens.h.

#define BOM_variant_operator_if PS_variant_operator_if

Definition at line 54 of file bom_tokens.h.

#define BOM_variant_operator_is_equal PS_variant_operator_is_equal

Definition at line 47 of file bom_tokens.h.

#define BOM_variant_operator_load_if PS_variant_operator_load_if

Definition at line 51 of file bom_tokens.h.

#define BOM_variant_operator_lt PS_variant_operator_lt

Less than

Definition at line 60 of file bom_tokens.h.

#define BOM_variant_operator_lt_eq PS_variant_operator_lt_eq

Less than or equal

Definition at line 66 of file bom_tokens.h.

#define BOM_variant_operator_meta_expr PS_variant_operator_meta_expr

NVE Meta-expression

Definition at line 77 of file bom_tokens.h.

#define BOM_variant_operator_named_expr PS_variant_operator_named_expr

Named Variant Expression

Definition at line 74 of file bom_tokens.h.

#define BOM_variant_operator_not PS_variant_operator_not

Not - ONLY SUPPORTED IN META-EXPRESSIONS

Definition at line 83 of file bom_tokens.h.

#define BOM_variant_operator_not_equal PS_variant_operator_not_equal

Definition at line 48 of file bom_tokens.h.

#define BOM_variant_operator_nve_ref PS_variant_operator_nve_ref

NVE Reference

Definition at line 80 of file bom_tokens.h.

#define BOM_variant_operator_or PS_variant_operator_or

Definition at line 53 of file bom_tokens.h.

#define BOM_variant_operator_rule_set PS_variant_operator_rule_set

Saved variant rule

Definition at line 71 of file bom_tokens.h.

#define BOM_vc_op_add_brackets 128

Definition at line 314 of file bom_tokens.h.

#define BOM_vc_op_append 2

Definition at line 308 of file bom_tokens.h.

#define BOM_vc_op_delete 16

Definition at line 311 of file bom_tokens.h.

#define BOM_vc_op_details 1

Definition at line 307 of file bom_tokens.h.

#define BOM_vc_op_insert 4

Definition at line 309 of file bom_tokens.h.

#define BOM_vc_op_mv_dn 64

Definition at line 313 of file bom_tokens.h.

#define BOM_vc_op_mv_up 32

Definition at line 312 of file bom_tokens.h.

#define BOM_vc_op_replace 8

Definition at line 310 of file bom_tokens.h.

#define BOM_vc_op_rm_brackets 256

Definition at line 315 of file bom_tokens.h.

#define BOM_WINDOW_STATE_PACK_ALL 1

Definition at line 31 of file bom_tokens.h.

#define BOM_WINDOW_STATE_SHOW_ALTS 4

Definition at line 34 of file bom_tokens.h.

#define BOM_WINDOW_STATE_SHOW_UNCONFIG 3

Definition at line 33 of file bom_tokens.h.

#define BOM_WINDOW_STATE_SHOW_VARIANTS 2

Definition at line 32 of file bom_tokens.h.

#define OPTION_DEFAULTED BOM_option_defaulted

Definition at line 108 of file bom_tokens.h.

#define OPTION_DERIVED BOM_option_derived

Definition at line 107 of file bom_tokens.h.

#define OPTION_SET_BY_RULE BOM_option_set_by_rule

Definition at line 110 of file bom_tokens.h.

#define OPTION_SET_BY_USER BOM_option_set_by_user

Definition at line 109 of file bom_tokens.h.

#define OPTION_SET_EXTERNAL BOM_option_external

Definition at line 111 of file bom_tokens.h.

#define OPTION_UNSET BOM_option_unset

Definition at line 105 of file bom_tokens.h.

#define OPTION_UNSET_DERIVABLE BOM_option_unset_derivable

Definition at line 106 of file bom_tokens.h.

#define SVRACTION_OVERLAY_ADD_RULE 1

Value to be used in order to apply or add a new Saved Variant Rule in case of BOM_var_config_overlay

Definition at line 692 of file bom_tokens.h.

#define SVRACTION_OVERLAY_REMOVE_RULE 2

Value to be used in order to remove existing Saved Variant Rule in case of BOM_var_config_overlay

Definition at line 695 of file bom_tokens.h.

#define SVRACTION_OVERRIDE_RULE 3

Value to be used in order to override existing BOM window Variant Rule by Saved Variant Rule in case of BOM_var_config_singlerule_singlevalue and BOM_var_config_singlerule_multivalue

Definition at line 698 of file bom_tokens.h.

#define SVRACTION_UPDATE_RULE 4

Value to be used in order to update existing BOM window Variant Rule by Saved Variant Rule in case of BOM_var_config_singlerule_singlevalue and BOM_var_config_singlerule_multivalue

Definition at line 701 of file bom_tokens.h.

#define VRACTION_GET_RULE 0

Value to be used in order to retrieve the variant rule from the window.

Definition at line 689 of file bom_tokens.h.

Typedef Documentation

typedef struct BOM_bomset_create_criteria BOM_bomset_create_criteria_t

Used by BOM_create_bomsetlines_for_input_lines Members : criteria_type - BomSet creation criteria as value/combination of values in BOM_bomset_output_info_t max_lines_in_bomset - maximum no. of lines a BomSet can have. Populte when criteria_type = BOMSET_max_lines percentage_struct_size_bomset - maximum BomSet size as % of total structure size. Populte when criteria_type = BOMSET_percent_struct_size

typedef enum BOM_bomset_criteria_e BOM_bomset_criteria_t

Used by BOM_create_bomsetlines_for_input_lines Members : BOMSET_avl_sys_memory_limit - avaialble system memory BOMSET_max_lines - maximum size a BomSet can have BOMSET_percent_struct_size - maximum BomSet size as % of total structure size

typedef struct BOM_bomset_input_info BOM_bomset_input_info_t

Used by BOM_create_bomsetlines_for_input_lines Members : tag_t** bomset_lines_chain - multiple chains of bomlines as parent->lineToBeExpanded int** bomset_line_chain_count - array of size counts of all chains int** bomset_rollup_numbers - array of child roll up counts of lineToBeExpanded int* num_bomset_chains - total number of chains

typedef struct BOM_bomset_output_info BOM_bomset_output_info_t

Used by BOM_expand_bomset_lines Members : tag_t* bomset_expanded_lines - Tag array of lines expanded int* bomset_expanded_line_count - size of above array

typedef int( BOM_compare_engine_visitor_t)(tag_t bomcompareengine, tag_t compareset, int depth, void *user_data)

Definition at line 288 of file bom_tokens.h.

typedef int( BOM_compare_set_visitor_t)(tag_t compareset, int depth, void *user_data)

Definition at line 295 of file bom_tokens.h.

typedef BOM_option_how_set_t OptionHowSet_e

Definition at line 104 of file bom_tokens.h.

Enumeration Type Documentation

enum BOM_bomset_criteria_e

Used by BOM_create_bomsetlines_for_input_lines Members : BOMSET_avl_sys_memory_limit - avaialble system memory BOMSET_max_lines - maximum size a BomSet can have BOMSET_percent_struct_size - maximum BomSet size as % of total structure size

Enumerator
BOMSET_avl_sys_memory_limit
BOMSET_max_lines
BOMSET_percent_struct_size

Definition at line 633 of file bom_tokens.h.

enum BOM_option_how_set_t

Enumerator
BOM_option_unset
BOM_option_unset_derivable
BOM_option_derived	OVESelOptionSet::Set
BOM_option_defaulted	OVESelOptionSet::Default
BOM_option_set_by_user	OVESelOptionSet::UserSet
BOM_option_set_by_rule
BOM_option_fixed
BOM_option_fixed_by_user
BOM_option_variant_item
BOM_option_external

Definition at line 90 of file bom_tokens.h.

enum BOM_var_config_mode_t

Used by BOM_window_set_varconfig_mode and BOM_window_ask_varconfig_mode. A BOMWindow can have one of three variant configuration modes.

Enumerator
BOM_var_config_singlerule_singlevalue	Window can have a single Variant Rule allowing one value per option
BOM_var_config_singlerule_multivalue	Window can have a single Variant Rule allowing one or more values per option
BOM_var_config_overlay	Window can have multiple Variant Rules allowing one or more values per option
BOM_var_multiple_rule_distinct_context	Support for multiple rules evaluation. If we have, we need to evaluate each rule individually except evaluation against variant condition (opcode 9). For all other scenarios the evalute will be done

Definition at line 672 of file bom_tokens.h.

enum BOM_variant_rule_copy_action_t

BOM Variant Rule - Cross-BOMWindow Copy Actions

Enumerator
BOM_variant_rule_src
BOM_variant_rule_src_and_dest
BOM_variant_rule_dest

Definition at line 455 of file bom_tokens.h.

Variable Documentation

BOM_API const char* const BOM_std_compare_ext_var_level_name

BOM_API const char* const BOM_std_compare_ext_var_level_seq_name

BOM_API const char* const BOM_std_compare_lowest_level_name

BOM_API const char* const BOM_std_compare_lowest_level_seq_name

BOM_API const char* const BOM_std_compare_single_level_name

BOM_API const char* const BOM_std_compare_single_level_seq_name

BOM_API const char* const BOM_std_compare_var_level_name

BOM_API const char* const BOM_std_compare_var_level_seq_name

BOM_API const char* const LBOM_std_compare_lowest_level_name

BOM_API const char* const LBOM_std_compare_single_level_name

BOM_API const char* const LBOM_std_compare_single_level_occ_name

BOM_API const char* const LBOM_std_compare_var_level_name

BOM_API const char* const LBOM_std_compare_var_level_occ_name

Enumerations
enum	BOM_bomset_criteria_e { BOMSET_avl_sys_memory_limit = 1, BOMSET_max_lines = 2, BOMSET_percent_struct_size = 4 }

enum	BOM_option_how_set_t { BOM_option_unset, BOM_option_unset_derivable, BOM_option_derived, BOM_option_defaulted, BOM_option_set_by_user, BOM_option_set_by_rule, BOM_option_fixed, BOM_option_fixed_by_user, BOM_option_variant_item, BOM_option_external }

enum	BOM_variant_rule_copy_action_t { BOM_variant_rule_src, BOM_variant_rule_src_and_dest, BOM_variant_rule_dest }

Data Structures

Macros

Typedefs

Enumerations

BOM_window_ask_state_logical() tokens

BOM Line Forced Configuration states

BOM Line Variant Configuration states

Standard BOM Compare modes' names

Numeric modes

BOM Compare output destinations

BOM Compare application flags

BOM Compare differences

BOM Compare quantity special cases

BOM Compare visitor function types

Variant Condition Clause List - Valid Operation Macros

BOMLine load states

OVE stuff

How Sets

Value types

BOM Variant Configuration

BOM DB SOS query operators

BOM DB SOS option types

BOM DB SOS value types

BOM DB SOS how set

BOM Variant Configuration Mode

Saved Variant Rule Action Integer Values.

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Variable Documentation