ITK Function Reference

(V10000.1.0.60_20160308.00)
Macros

Macros

#define BMF_FND_new_persistent_id_msg   "BMF_FND_new_persistent_id"
 
#define PS_bvr_create_occs_msg   "PS_bvr_create_occs"
 
#define PS_bvr_create_occs_with_occ_type_msg   "PS_bvr_create_occs_with_occ_type"
 
#define PS_bvr_import_new_occ_msg   "PS_bvr_import_new_occ"
 
#define PUBLISHLINK_create_msg   "PS_create_publishlink"
 
#define PUBLISHLINK_publish_data_msg   "PS_publishlink_publish_data"
 

Detailed Description

Macro Definition Documentation

#define BMF_FND_new_persistent_id_msg   "BMF_FND_new_persistent_id"

Generates a unique ID, which is to be used as a persistent ID. A persistent ID is a key that uniquely identifies the boolean content of a Variant Expression. The same identifier will be assigned to logically equivalent expressions. The generated ID is consumed while authoring expression on Line of Usages.

Parameters
[out]generatedpersistent id

Definition at line 108 of file ps_msg.h.

#define PS_bvr_create_occs_msg   "PS_bvr_create_occs"

This message is dispatched when new PS occurrences (Product Structure Occurrences) are created for a BVR (BOMViewRevision), e.g. when the ITK PS_create_occurrences is called (with which this message shares its parameter list).

Parameters
[in]tag_tparent_bvr Tag to parent BVR
[in]tag_tchild_item Tag for either the child item or the source occurrence thread that is copied from one parent to another
[in]tag_tchild_bom_view Tag for child BOM view or for occurrence thread (which must be parent BVR for the source occurrence mentioned in the "child_item" parameter)
[in]intn_occurrences Number of occurrences
[out]tag_t**occ_thread_tags Tag to occurrence thread.

Definition at line 48 of file ps_msg.h.

#define PS_bvr_create_occs_with_occ_type_msg   "PS_bvr_create_occs_with_occ_type"

This message supports creating an occurrence based on the specific Occurrence Type.

Parameters
[in]tag_tparent_bvr Tag to parent BVR (BOM View Revision)
[in]tag_tchild_item Tag for either the child item or the source occurrence thread that is copied from one parent to another
[in]tag_tchild_bom_view Tag for child BOM view or for occurrence thread (which must be parent BVR for the source occurrence mentioned in the "child_item" parameter)
[in]intn_occurrences Number of occurrences
[out]tag_t**occ_thread_tags Tag to occurrence thread.
[in]tag_tocc_type Tag to occurrence type.

Definition at line 73 of file ps_msg.h.

#define PS_bvr_import_new_occ_msg   "PS_bvr_import_new_occ"

This message is dispatched when an occurrence is being imported in GMS (Global Multisite)

Parameters
[in]tag_tparent_bvr Tag to parent BVR (BOM View Revision)
[in]tag_tchild_item Tag to child item
[in]tag_tchild_bom_view Tag to childBomview
[in]tag_texisting_occ_thread Tag to existing occurrence thread.
[out]tag_t*occurrence Tag to imported occurrence.

Definition at line 83 of file ps_msg.h.

#define PUBLISHLINK_create_msg   "PS_create_publishlink"

This message allows a Publish Link to be created from a source object to a target object. Publish Links are used to connect absolute occurrences.

Parameters
[in]char*name Name of the Publish Link to be created
[in]char*type Type of the Publish Link
[in]intdataFlags Integer representing which data is being published. It can be either Transform (0x1) or Shape (0x2)
[in]tag_t*source MEAppearancePathNode as a source of Publish Link
[in]inttarget_count Number of target MEAppearancePathNode
[in]tag_t*target List of target MEAppearancePathNode(s)
[out]tag_t*publishlink New Publish Link object

Definition at line 62 of file ps_msg.h.

#define PUBLISHLINK_publish_data_msg   "PS_publishlink_publish_data"

This message supports copying data (transform or shape) from source BOM Line to target BOM Line(s). If Publish Link exists for the given source BOM Lines, all input target BOM Line(s) should belong to that Publish Link. If none exist, the new object is created.

Parameters
[in]tag_tsource_bl_tag BOM Line as source of the Publish Link
[in]intn_targets Number of target BOM Line(s)
[in]tag_t*target_bl_tags List of target BOM Line(s)
[in]char*publishLinkName Name of the Publish Link (used while creating a new Publish Link)
[in]char*publishLinkTypeName Type of the Publish Link
[in]intdataFlags Integer representing which data is being published. It can be either Transform (0x1) or Shape (0x2)
[out]tag_t*publishlink New Publish Link object

Definition at line 98 of file ps_msg.h.