ITK Function Reference

(V10000.1.0.60_20160308.00)
Macros | Enumerations

Macros

#define PS_copyable   (1 << 0)
 
#define PS_default_view_type_name   "view"
 
#define PS_effectivity_operator_applicability   (PS_effectivity_operator_offset + PS_variant_operator_applicability)
 
#define PS_effectivity_operator_condition   (PS_effectivity_operator_offset + PS_variant_operator_condition)
 
#define PS_effectivity_operator_constraint_error   (PS_effectivity_operator_offset + PS_variant_operator_constraint_error)
 
#define PS_effectivity_operator_constraint_inform   (PS_effectivity_operator_offset + PS_variant_operator_constraint_inform)
 
#define PS_effectivity_operator_constraint_warn   (PS_effectivity_operator_offset + PS_variant_operator_constraint_warn)
 
#define PS_effectivity_operator_criteria_set   (PS_effectivity_operator_offset + PS_variant_operator_criteria_set)
 
#define PS_effectivity_operator_declare   (PS_effectivity_operator_offset + PS_variant_operator_declare)
 
#define PS_effectivity_operator_derived_default_rule   (PS_effectivity_operator_offset + PS_variant_operator_derived_default_rule)
 
#define PS_effectivity_operator_error_if   (PS_effectivity_operator_offset + PS_variant_operator_error_if)
 
#define PS_effectivity_operator_exclusive_constraint   (PS_effectivity_operator_offset + PS_variant_operator_exclusive_constraint)
 
#define PS_effectivity_operator_filter_condition   (PS_effectivity_operator_offset + PS_variant_operator_filter_condition)
 
#define PS_effectivity_operator_fixed_default_rule   (PS_effectivity_operator_offset + PS_variant_operator_fixed_default_rule)
 
#define PS_effectivity_operator_inclusive_constraint   (PS_effectivity_operator_offset + PS_variant_operator_inclusive_constraint)
 
#define PS_effectivity_operator_load_if   (PS_effectivity_operator_offset + PS_variant_operator_load_if)
 
#define PS_effectivity_operator_offset   500
 
#define PS_effectivity_operator_product_family_condition   (PS_effectivity_operator_offset + PS_variant_operator_product_family_condition)
 
#define PS_effectivity_operator_use_dependent   (PS_effectivity_operator_offset + PS_variant_operator_use_dependent)
 
#define PS_effectivity_operator_used_value   (PS_effectivity_operator_offset + PS_variant_operator_assy_uses)
 
#define PS_effectivity_operator_value_range   (PS_effectivity_operator_offset + PS_variant_operator_value_range)
 
#define PS_manage   (1 << 1)
 
#define PS_max_note_length   160
 
#define PS_mono_override   (1 << 1)
 
#define PS_product_line_variant_expression   43
 
#define PS_qty_as_required   (1 << 0)
 
#define PS_valid_props   (PS_copyable | PS_manage)
 
#define PS_variant_op_rhs_is_string   1000
 
#define PS_variant_operator_and   10
 
#define PS_variant_operator_applicability   23
 
#define PS_variant_operator_assign   3
 
#define PS_variant_operator_assy_uses   2
 
#define PS_variant_operator_brackets   17
 
#define PS_variant_operator_comment   8
 
#define PS_variant_operator_condition   25
 
#define PS_variant_operator_constraint_error   30
 
#define PS_variant_operator_constraint_inform   31
 
#define PS_variant_operator_constraint_warn   32
 
#define PS_variant_operator_criteria_set   26
 
#define PS_variant_operator_ct   40
 
#define PS_variant_operator_declare   1
 
#define PS_variant_operator_default   4
 
#define PS_variant_operator_derived_default_rule   37
 
#define PS_variant_operator_enforced_condition   42
 
#define PS_variant_operator_error_if   7
 
#define PS_variant_operator_exclusive_constraint   29
 
#define PS_variant_operator_feasibility_constraint   41
 
#define PS_variant_operator_filter_condition   36
 
#define PS_variant_operator_fixed_default_rule   38
 
#define PS_variant_operator_gt   13
 
#define PS_variant_operator_gt_eq   15
 
#define PS_variant_operator_if   12
 
#define PS_variant_operator_inclusive_constraint   28
 
#define PS_variant_operator_is_equal   5
 
#define PS_variant_operator_load_if   9
 
#define PS_variant_operator_lt   14
 
#define PS_variant_operator_lt_eq   16
 
#define PS_variant_operator_meta_expr   20
 
#define PS_variant_operator_named_expr   19
 
#define PS_variant_operator_not   22
 
#define PS_variant_operator_not_equal   6
 
#define PS_variant_operator_nve_ref   21
 
#define PS_variant_operator_or   11
 
#define PS_variant_operator_persistent_id   35
 
#define PS_variant_operator_product_family_condition   33
 
#define PS_variant_operator_rule_set   18
 
#define PS_variant_operator_transient_criteria_set   27
 
#define PS_variant_operator_tt   39
 
#define PS_variant_operator_use_dependent   24
 
#define PS_variant_operator_value_range   34
 
#define PS_variant_option_mode_date_comparison   (1 << 4)
 
#define PS_variant_option_mode_discretionary   (1 << 5)
 
#define PS_variant_option_mode_dynamic_comparison   (1 << 0)
 
#define PS_variant_option_mode_free_form   (1 << 8)
 
#define PS_variant_option_mode_integer_comparison   (1 << 3)
 
#define PS_variant_option_mode_lexicographic_comparison   (1 << 1)
 
#define PS_variant_option_mode_logical_comparison   (1 << 7)
 
#define PS_variant_option_mode_model_designator_option   (1 << 6)
 
#define PS_variant_option_mode_multi_select   (1 << 9)
 
#define PS_variant_option_mode_numeric_comparison   (1 << 2)
 
#define PS_variant_option_mode_product_line   (1 << 10)
 
#define PS_variant_option_mode_unknown   0
 
#define PS_where_used_all_levels   -1
 

Enumerations

enum  PS_legacy_transform_format_t { PS_transform_format_in_legacy, PS_transform_format_written_by_ug, PS_transform_format_unknown }
 

Class tokens

Used to identify PS classes with client data functions.

#define PS_min_class_token   1001
 
#define PS_view_type   1001
 
#define PS_bom_view   1002
 
#define PS_bom_view_revision   1003
 
#define PS_occurrence   1004
 
#define PS_max_class_token   1004
 

Detailed Description

Macro Definition Documentation

#define PS_bom_view   1002

Definition at line 340 of file ps_tokens.h.

#define PS_bom_view_revision   1003

Definition at line 341 of file ps_tokens.h.

#define PS_copyable   (1 << 0)

When the instance is copied, the client data gets copied with it.

Definition at line 349 of file ps_tokens.h.

#define PS_default_view_type_name   "view"

All BOMViews created via the user interface are of this type.

Definition at line 380 of file ps_tokens.h.

#define PS_effectivity_operator_applicability   (PS_effectivity_operator_offset + PS_variant_operator_applicability)

Defines the maximum range of validity up to which a PS_effectivity_operator_load_if condition can be expanded

Definition at line 303 of file ps_tokens.h.

#define PS_effectivity_operator_condition   (PS_effectivity_operator_offset + PS_variant_operator_condition)

Expressions with this operator code define the applicability condition used in a filter expression that that qualifies the parent effectivity expression

Definition at line 312 of file ps_tokens.h.

#define PS_effectivity_operator_constraint_error   (PS_effectivity_operator_offset + PS_variant_operator_constraint_error)

The left operand defines a filter expression that qualifies a configuration validation criteria ERROR severity specified by the right operand

Definition at line 321 of file ps_tokens.h.

#define PS_effectivity_operator_constraint_inform   (PS_effectivity_operator_offset + PS_variant_operator_constraint_inform)

The left operand defines a filter expression that qualifies a configuration validation criteria INFORM severity specified by the right operand

Definition at line 324 of file ps_tokens.h.

#define PS_effectivity_operator_constraint_warn   (PS_effectivity_operator_offset + PS_variant_operator_constraint_warn)

The left operand defines a filter expression that qualifies a configuration validation criteria WARN severity specified by the right operand

Definition at line 327 of file ps_tokens.h.

#define PS_effectivity_operator_criteria_set   (PS_effectivity_operator_offset + PS_variant_operator_criteria_set)

Defines configuration criteria which may become active under certain conditions

Definition at line 300 of file ps_tokens.h.

#define PS_effectivity_operator_declare   (PS_effectivity_operator_offset + PS_variant_operator_declare)

The left operand selects one VariantRevision for effectivity options from all that reference the same parent Variant (VariantRevision.parent_variant). The expression may optionally restrict the domain of values for this Variant.

Definition at line 279 of file ps_tokens.h.

#define PS_effectivity_operator_derived_default_rule   (PS_effectivity_operator_offset + PS_variant_operator_derived_default_rule)

The left operand defines a filter expression that qualifies the effectivity default assignment given in the right operand

Definition at line 330 of file ps_tokens.h.

#define PS_effectivity_operator_error_if   (PS_effectivity_operator_offset + PS_variant_operator_error_if)

The left operand specifies the condition of a Rule Check under which the error message given in the right operand should be displayed

Definition at line 291 of file ps_tokens.h.

#define PS_effectivity_operator_exclusive_constraint   (PS_effectivity_operator_offset + PS_variant_operator_exclusive_constraint)

Expressions with this operator code represent effectivity configuration validation criteria which all configuration rules should not meet in order to be considered valid

Definition at line 318 of file ps_tokens.h.

#define PS_effectivity_operator_filter_condition   (PS_effectivity_operator_offset + PS_variant_operator_filter_condition)

Combines the left operand defining a "product family" effectivity condition with the right operand defining an effectivity applicability condition using the operator AND

Definition at line 306 of file ps_tokens.h.

#define PS_effectivity_operator_fixed_default_rule   (PS_effectivity_operator_offset + PS_variant_operator_fixed_default_rule)

The right operand defines a fixed value index for the Variant specified in the left operand

Definition at line 288 of file ps_tokens.h.

#define PS_effectivity_operator_inclusive_constraint   (PS_effectivity_operator_offset + PS_variant_operator_inclusive_constraint)

Expressions with this operator code represent configuration validation criteria which all configuration rules should pass in order to be considered valid

Definition at line 315 of file ps_tokens.h.

#define PS_effectivity_operator_load_if   (PS_effectivity_operator_offset + PS_variant_operator_load_if)

The right operand defines the effectivity scope for an EffectivityConfigurable object

Definition at line 294 of file ps_tokens.h.

#define PS_effectivity_operator_offset   500

Offset indicating that this operator is effectivty related

Definition at line 274 of file ps_tokens.h.

#define PS_effectivity_operator_product_family_condition   (PS_effectivity_operator_offset + PS_variant_operator_product_family_condition)

Expressions with this operator code define effectivity criteria all products of a given "model" or "product family" have in common

Definition at line 309 of file ps_tokens.h.

#define PS_effectivity_operator_use_dependent   (PS_effectivity_operator_offset + PS_variant_operator_use_dependent)

Defines how a dependent effectivity variable maps to its a master variable when substituting dependent variables, e.g. how "Vacation" maps to "Date"

Definition at line 297 of file ps_tokens.h.

#define PS_effectivity_operator_used_value   (PS_effectivity_operator_offset + PS_variant_operator_assy_uses)

The right operand records the use of a specific value index for the Variant specified in the left operand

Definition at line 282 of file ps_tokens.h.

#define PS_effectivity_operator_value_range   (PS_effectivity_operator_offset + PS_variant_operator_value_range)

Expressions with this operator code record the use of an effectivity value range for the Variant specified in the left operand

Definition at line 285 of file ps_tokens.h.

#define PS_manage   (1 << 1)

All op's (create/unload/save/refresh/delete) are handled for the user. Therefore they only ask/set the values within their client data instance. The instance will be of the class used for typing.

Definition at line 356 of file ps_tokens.h.

#define PS_max_class_token   1004

Definition at line 343 of file ps_tokens.h.

#define PS_max_note_length   160

Definition at line 375 of file ps_tokens.h.

#define PS_min_class_token   1001

Definition at line 338 of file ps_tokens.h.

#define PS_mono_override   (1 << 1)

Represents the EndItem of the occurrence

Definition at line 368 of file ps_tokens.h.

#define PS_occurrence   1004

Definition at line 342 of file ps_tokens.h.

#define PS_product_line_variant_expression   43

Defines a variant expression which is a combined representation of package e.g. Package P1 has member A1, B1 and C1 Expression will A1 & B1 & C1

Definition at line 271 of file ps_tokens.h.

#define PS_qty_as_required   (1 << 0)

Occurrence flags.

Definition at line 363 of file ps_tokens.h.

#define PS_valid_props   (PS_copyable | PS_manage)

Definition at line 358 of file ps_tokens.h.

#define PS_variant_op_rhs_is_string   1000

An opcode offset that indicates that the right operand is provided as string and not as tag

Definition at line 34 of file ps_tokens.h.

#define PS_variant_operator_and   10

Combines the left and the right operand with the And operator.

Definition at line 119 of file ps_tokens.h.

#define PS_variant_operator_applicability   23

Defines the maximum range of validity up to which a PS_variant_operator_load_if condition can be expanded.

Definition at line 176 of file ps_tokens.h.

#define PS_variant_operator_assign   3

The right operand assigns a specific value index for the Variant specified in the left operand in a derived default.

Definition at line 90 of file ps_tokens.h.

#define PS_variant_operator_assy_uses   2

The right operand records the use of a specific value index for the Variant specified in the left operand.

Definition at line 85 of file ps_tokens.h.

#define PS_variant_operator_brackets   17

Encloses the right operand in brackets and ignores the left operand.

Definition at line 150 of file ps_tokens.h.

#define PS_variant_operator_comment   8

Specifies a comment that does not impact Boolean evaluation.

Definition at line 113 of file ps_tokens.h.

#define PS_variant_operator_condition   25

A VariantExpression with this operator code defines the applicability condition used in a filter expression that qualifies the parent expression.

Definition at line 186 of file ps_tokens.h.

#define PS_variant_operator_constraint_error   30

The left operand defines a filter expression that qualifies a configuration validation criterion with ERROR severity specified by the right operand.

Definition at line 210 of file ps_tokens.h.

#define PS_variant_operator_constraint_inform   31

The left operand defines a filter expression that qualifies a configuration validation criterion with INFORM severity specified by the right operand.

Definition at line 215 of file ps_tokens.h.

#define PS_variant_operator_constraint_warn   32

The left operand defines a filter expression that qualifies a configuration validation criterion with WARN severity specified by the right operand.

Definition at line 220 of file ps_tokens.h.

#define PS_variant_operator_criteria_set   26

Defines configuration criteria which may become active under certain conditions.

Definition at line 189 of file ps_tokens.h.

#define PS_variant_operator_ct   40

Defines a "contradiction" (CT) expression that always evaluates to false. No operands.

Definition at line 254 of file ps_tokens.h.

#define PS_variant_operator_declare   1

Operator codes The left operand selects one VariantRevision from all those that reference the same parent Variant (VariantRevision.parent_variant). The expression may optionally restrict the domain of values for this Variant.

Definition at line 80 of file ps_tokens.h.

#define PS_variant_operator_default   4

The right operand defines a fixed default value index for the Variant specified in the left operand.

Definition at line 95 of file ps_tokens.h.

#define PS_variant_operator_derived_default_rule   37

The left operand defines a filter expression that qualifies a Default Assignment specified by the right operand.

Definition at line 245 of file ps_tokens.h.

#define PS_variant_operator_enforced_condition   42

Defines an enforced condition for a rule. e.g. Exclude Rule : ~model | ~applicability | model & applicability & ~restriction Include Rule : ~model | ~applicability | model & applicability & restriction

Definition at line 265 of file ps_tokens.h.

#define PS_variant_operator_error_if   7

The left operand specifies the condition of a Rule Check under which the error message given in the right operand should be displayed.

Definition at line 110 of file ps_tokens.h.

#define PS_variant_operator_exclusive_constraint   29

A VariantExpression with this operator code represents a configuration validation criterion which must evaluate to false in order for a configuration rule to be considered valid.

Definition at line 205 of file ps_tokens.h.

#define PS_variant_operator_feasibility_constraint   41

A VariantExpression with this operator code represents a configuration validation criterion which must evaluate to true in order for a configuration rule to be considered valid.

Definition at line 259 of file ps_tokens.h.

#define PS_variant_operator_filter_condition   36

Combines the left operand defining a "product family" condition with the right operand defining an applicability condition using the operator AND.

Definition at line 240 of file ps_tokens.h.

#define PS_variant_operator_fixed_default_rule   38

The right operand specifies an unconditional Default Assignment.

Definition at line 248 of file ps_tokens.h.

#define PS_variant_operator_gt   13

The right operand specifies the value text to which the Variant specified in the left operand is compared using the Greater Than comparator.

Definition at line 132 of file ps_tokens.h.

#define PS_variant_operator_gt_eq   15

The right operand specifies the value text to which the Variant specified in the left operand is compared using the Greater Than Or Equal comparator.

Definition at line 142 of file ps_tokens.h.

#define PS_variant_operator_if   12

The left operand defines the default assignment to be applied in a Derived Default if the right operand's condition is met.

Definition at line 127 of file ps_tokens.h.

#define PS_variant_operator_inclusive_constraint   28

A VariantExpression with this operator code represents a configuration validation criterion which must evaluate to true in order for a configuration rule to be considered valid.

Definition at line 200 of file ps_tokens.h.

#define PS_variant_operator_is_equal   5

The right operand specifies the value index to which the Variant specified in the left operand is compared using the Equal comparator.

Definition at line 100 of file ps_tokens.h.

#define PS_variant_operator_load_if   9

The right operand defines the variant scope for a BOMLine.

Definition at line 116 of file ps_tokens.h.

#define PS_variant_operator_lt   14

The right operand specifies the value text to which the Variant specified in the left operand is compared using the Less Than comparator.

Definition at line 137 of file ps_tokens.h.

#define PS_variant_operator_lt_eq   16

The right operand specifies the value text to which the Variant specified in the left operand is compared using the Less Than Or Equal comparator.

Definition at line 147 of file ps_tokens.h.

#define PS_variant_operator_meta_expr   20

The right operand defines the logical tree of an expression that forms a Named Variant Expression Meta-expression.

Definition at line 163 of file ps_tokens.h.

#define PS_variant_operator_named_expr   19

The left operand defines the condition enclosed in a Named Variant Expression.

Definition at line 158 of file ps_tokens.h.

#define PS_variant_operator_not   22

Negates the right operand and ignores the left - ONLY SUPPORTED IN META-EXPRESSIONS.

Definition at line 171 of file ps_tokens.h.

#define PS_variant_operator_not_equal   6

The right operand specifies the value index to which the Variant specified in the left operand is compared using the Not Equal comparator.

Definition at line 105 of file ps_tokens.h.

#define PS_variant_operator_nve_ref   21

The left operand references the Named Variant Expression identified by the text given in the right operand.

Definition at line 168 of file ps_tokens.h.

#define PS_variant_operator_or   11

Combines the left and the right operand with the Or operator.

Definition at line 122 of file ps_tokens.h.

#define PS_variant_operator_persistent_id   35

Defines a "persistentID" operator

Definition at line 235 of file ps_tokens.h.

#define PS_variant_operator_product_family_condition   33

VariantExpressions with this operator code define criteria that all products of a given "model" or "product family" have in common.

Definition at line 225 of file ps_tokens.h.

#define PS_variant_operator_rule_set   18

The right operand specifies the value index to use for the Variant specified in the left operand in a Saved Variant Rule.

Definition at line 155 of file ps_tokens.h.

#define PS_variant_operator_transient_criteria_set   27

Defines configuration criteria for a transient variant rule. The right operand references the POM user tag for which the transient criteria was created. The string attribute specifies the POM session that created this expression.

Definition at line 195 of file ps_tokens.h.

#define PS_variant_operator_tt   39

Defines a "tautology" (TT) expression that always evaluates to true. No operands.

Definition at line 251 of file ps_tokens.h.

#define PS_variant_operator_use_dependent   24

Defines how a dependent variant variable maps to its a master variable when substituting dependent variables, e.g. how "Risk" maps to "Size".

Definition at line 181 of file ps_tokens.h.

#define PS_variant_operator_value_range   34

A VariantExpression with this operator code records the use of a value range for the Variant specified in the left operand.

Definition at line 230 of file ps_tokens.h.

#define PS_variant_option_mode_date_comparison   (1 << 4)

Indicate that the variant option will be considered as Date value convert values to UTC dates using DATE_convert_iso_date_to_date_t() (tc_date.h) before comparing

Definition at line 53 of file ps_tokens.h.

#define PS_variant_option_mode_discretionary   (1 << 5)

Indicate that the variant option will be considered as discretionary value UNSET means "none of" else it means "any of"

Definition at line 57 of file ps_tokens.h.

#define PS_variant_option_mode_dynamic_comparison   (1 << 0)

Equivalent to what was previously known as BOM_option_mode_enum "2" < "10" but "2E0" > "1E1"

Definition at line 38 of file ps_tokens.h.

#define PS_variant_option_mode_free_form   (1 << 8)

Indicate the option will support free form values

Definition at line 66 of file ps_tokens.h.

#define PS_variant_option_mode_integer_comparison   (1 << 3)

Indicate that the variant option will be considered as integer value

Definition at line 49 of file ps_tokens.h.

#define PS_variant_option_mode_lexicographic_comparison   (1 << 1)

Indicate that the variant option will be considered as lexicohgraphic value "2" > "10" and "2E0" > "1E1"

Definition at line 42 of file ps_tokens.h.

#define PS_variant_option_mode_logical_comparison   (1 << 7)

Indicate that the option will be considered as logical value with only two states, e.g. On/Off, True/False, or present/absent

Definition at line 63 of file ps_tokens.h.

#define PS_variant_option_mode_model_designator_option   (1 << 6)

Indicate that the variant option will be considered as designator value

Definition at line 60 of file ps_tokens.h.

#define PS_variant_option_mode_multi_select   (1 << 9)

Indicate the option will support multiple selection

Definition at line 69 of file ps_tokens.h.

#define PS_variant_option_mode_numeric_comparison   (1 << 2)

Indicate that the variant option will be considered as numeric value "2" < "10" and "2E0" < "1E1"

Definition at line 46 of file ps_tokens.h.

#define PS_variant_option_mode_product_line   (1 << 10)

Indicate the option will be considered a Product Line

Definition at line 72 of file ps_tokens.h.

#define PS_variant_option_mode_unknown   0

Equivalent to what was previously known as BOM_option_mode_int

Definition at line 31 of file ps_tokens.h.

#define PS_view_type   1001

Definition at line 339 of file ps_tokens.h.

#define PS_where_used_all_levels   -1

Do where used for any number of levels until you reach assemblies with no parent assemblies.

Definition at line 373 of file ps_tokens.h.

Enumeration Type Documentation

Preference values for legacy transform format

Enumerator
PS_transform_format_in_legacy 
PS_transform_format_written_by_ug 
PS_transform_format_unknown 

Definition at line 385 of file ps_tokens.h.