ITK Function Reference
(V10000.1.0.60_20160308.00)
Data Structures | Macros | Typedefs | Enumerations
bom_tokens.h File Reference
#include <unidefs.h>
#include <ps/ps_tokens.h>
#include <bom/libbom_exports.h>
#include <bom/libbom_undef.h>

Go to the source code of this file.

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
 
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
 
Numeric modes
#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)))
 
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
 
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
 

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 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)
 

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 }
 
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 }
 

Variables

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
 

Detailed Description

Defines tokens used by the BOM ITK interface.

Definition in file bom_tokens.h.