ITK Function Reference
(V10000.1.0.60_20160308.00)
Macros | Typedefs | Enumerations | Functions
Absolute Occurences
Product Structure

Macros

#define ABSOCC_max_attribute_name_length   60
 
#define ME_appearance_group_class_name_c   "AppearanceGroup"
 
#define ME_meappearancepathnode_class_name_c   "MEAppearancePathNode"
 
#define ME_meappearancepathroot_class_name_c   "MEAppearancePathRoot"
 

Typedefs

typedef enum ABSOCC_dataTypes ABSOCC_dataTypes_t
 

Enumerations

enum  ABSOCC_dataTypes {
  ABSOCC_childItem, ABSOCC_flags, ABSOCC_gdeobject, ABSOCC_grm,
  ABSOCC_instanceNo, ABSOCC_name, ABSOCC_note, ABSOCC_quantity,
  ABSOCC_seqNo, ABSOCC_type, ABSOCC_variantCondition, ABSOCC_xform,
  ABSOCC_posRef, ABSOCC_archRef, ABSOCC_source, ABSOCC_UoM,
  ABSOCC_isDesInPlace, ABSOCC_reqPosDesign, ABSOCC_NUM_TYPES
}
 

Functions

PS_API int ME_create_meapprpathnode (tag_t path_root, tag_t parent, tag_t occ_thread, tag_t *new_apprpathnode)
 
PS_API int ME_create_meapprpathnode_from_appearance (tag_t comp, tag_t *new_apprpathnode)
 
PS_API int ME_create_meapprpathnode_from_bomline (tag_t lineTag, tag_t *new_apprpathnode)
 
PS_API int ME_create_meapprpathnode_with_root_line (tag_t line_tag, tag_t root_line, tag_t *new_apprpathnode)
 
PS_API int ME_create_meapprpathroot (tag_t tracked_item, tag_t tracked_bv, tag_t *new_apprpathroot)
 
PS_API int ME_create_meapprpathroot_from_apprroot (tag_t apprRoot, tag_t *new_apprpathroot)
 
PS_API int ME_create_meapprpathroot_from_window (tag_t bom_window, tag_t *new_apprpathroot, tag_t *top_pathnode)
 
PS_API int ME_get_appr_path_node_parent_hierarchy (tag_t p1, tag_t **parentPathNodes, tag_t **parentItems, tag_t **parentThreads, int *parentCount)
 
PS_API int ME_get_appr_path_nodes_for_component (tag_t componentItem, tag_t topItem, tag_t **pathNodes, int *pathCount)
 
PS_API int ME_get_meapprpathnode_from_appearance (tag_t comp, tag_t *new_apprpathnode)
 
PS_API int ME_get_meapprpathnode_from_bomline (tag_t comp, tag_t *new_apprpathnode)
 
PS_API int ME_get_meapprpathnode_with_root_line (tag_t comp, tag_t root_line, tag_t *new_apprpathnode)
 
PS_API int ME_get_meapprpathroot (tag_t tracked_item, tag_t tracked_bv, tag_t *apprpathroot)
 
PS_API int ME_get_meapprpathroot_from_apprroot (tag_t apprRoot, tag_t *apprpathroot)
 
PS_API int ME_get_path_node_item (tag_t p1, tag_t *p1Item)
 
PS_API int ME_meapprpathnode_ask_apprs (tag_t pathNode, int *numApprs, tag_t **appearances)
 
PS_API int ME_meapprpathnode_ask_childnodes (tag_t pathNode, int *numChildren, tag_t **children)
 
PS_API int ME_meapprpathnode_ask_config_appr (tag_t pathNode, tag_t rev_rule, tag_t *appearance)
 
PS_API int ME_meapprpathnode_ask_item_revision (tag_t pathNode, tag_t rev_rule, tag_t *item_rev)
 
PS_API int ME_meapprpathnode_ask_occurrence (tag_t pathNode, tag_t *occ)
 
PS_API int ME_meapprpathnode_ask_parent (tag_t pathNode, tag_t *parent)
 
PS_API int ME_meapprpathnode_ask_pathroot (tag_t pathNode, tag_t *pathRoot)
 
PS_API int ME_meapprpathnode_remove_appr (tag_t pathNode, tag_t appearance)
 
PS_API int ME_meapprpathroot_ask_bomview (tag_t pathRoot, tag_t *bv)
 
PS_API int ME_meapprpathroot_ask_item (tag_t pathRoot, tag_t *item)
 
PS_API int ME_meapprpathroot_ask_pathnodes (tag_t pathRoot, int *childCount, tag_t **path_nodes)
 
PS_API int ME_update_meapprpathnode_from_bomline (tag_t bom_line, tag_t *new_apprpathnode)
 
PS_API int ME_update_meapprpathnode_with_root_line (tag_t bom_line, tag_t root_line, tag_t *new_apprpathnode)
 
PS_API int ME_update_meapprpathroot (tag_t apprRoot, tag_t *new_apprpathroot)
 

Detailed Description

AppearancePathNode related functions

Macro Definition Documentation

#define ABSOCC_max_attribute_name_length   60

Definition at line 31 of file absocc.h.

#define ME_appearance_group_class_name_c   "AppearanceGroup"

Definition at line 30 of file absocc.h.

#define ME_meappearancepathnode_class_name_c   "MEAppearancePathNode"

Definition at line 28 of file absocc.h.

#define ME_meappearancepathroot_class_name_c   "MEAppearancePathRoot"

Definition at line 29 of file absocc.h.

Typedef Documentation

typedef enum ABSOCC_dataTypes ABSOCC_dataTypes_t

Enumeration Type Documentation

enum ABSOCC_dataTypes
Enumerator
ABSOCC_childItem 
ABSOCC_flags 
ABSOCC_gdeobject 
ABSOCC_grm 
ABSOCC_instanceNo 
ABSOCC_name 
ABSOCC_note 
ABSOCC_quantity 
ABSOCC_seqNo 
ABSOCC_type 
ABSOCC_variantCondition 
ABSOCC_xform 
ABSOCC_posRef 
ABSOCC_archRef 
ABSOCC_source 
ABSOCC_UoM 
ABSOCC_isDesInPlace 
ABSOCC_reqPosDesign 
ABSOCC_NUM_TYPES 

Definition at line 34 of file absocc.h.

Function Documentation

PS_API int ME_create_meapprpathnode ( tag_t  path_root,
tag_t  parent,
tag_t  occ_thread,
tag_t *  new_apprpathnode 
)

Create an MEApprPathNode, setting its parent, path_root, occ_thread, attributes to the given arguments.

Note
This function does not save the new Appearance. Use AOM_save for that.
Parameters
path_root(I)
parent(I)
occ_thread(I)
new_apprpathnode(O)
PS_API int ME_create_meapprpathnode_from_appearance ( tag_t  comp,
tag_t *  new_apprpathnode 
)

Given an AppearanceCache, create the corresponding MEApprPathNodes.

  1. PathNode for this Appearance Cache will be created if it doesn't exist
  2. All PathNodes corresponding to parent lines Appearance Cache Parent will be created if they don't exist
Note
This function WILL save the new Path Nodes.
Parameters
comp(I) Tag of Appearance
new_apprpathnode(O) Pathnode corresponding to the comp
PS_API int ME_create_meapprpathnode_from_bomline ( tag_t  lineTag,
tag_t *  new_apprpathnode 
)

Given a BOM Line, create the corresponding MEApprPathNodes.

  1. PathNode for this BOMLine will be created if it doesn't exist
  2. All PathNodes corresponding to parent lines will be created if they don't exist
Note
This function WILL save the new Path Nodes.
Parameters
lineTag(I) Tag of BOMLine
new_apprpathnode(O) Pathnode corresponding to the comp
PS_API int ME_create_meapprpathnode_with_root_line ( tag_t  line_tag,
tag_t  root_line,
tag_t *  new_apprpathnode 
)

Given a BOM Line, and a designated rootLine, create the corresponding MEApprPathNodes.

  1. root_line will be used as End Item
  2. PathNode for this BOMLine will be created if it doesn't exist
  3. All PathNodes corresponding to parent lines will be created if they don't exist
Note
This function WILL save the new Path Nodes.
Parameters
line_tag(I) Tag of BOMLine
root_line(I) BOMLine considered as End Item
new_apprpathnode(O) Pathnode corresponding to the comp
PS_API int ME_create_meapprpathroot ( tag_t  tracked_item,
tag_t  tracked_bv,
tag_t *  new_apprpathroot 
)

Creates an MEApprPathRoot. It will check whether PathRoot exists. Creates PathRoot only if there is no existing PathRoot

Note
This function WILL save the new Path root if got created.
Parameters
tracked_item(I) End item
tracked_bv(I) BOMView of the EndItem
new_apprpathroot(O) Pathroot found or created
PS_API int ME_create_meapprpathroot_from_apprroot ( tag_t  apprRoot,
tag_t *  new_apprpathroot 
)

Creates an MEApprPathRoot. It will check whether PathRoot exists. Creates PathRoot only if there is no existing PathRoot.

Note
This function WILL save the new Path root if got created.
Parameters
apprRoot(I) Appearance Set
new_apprpathroot(O) Pathroot found or created
PS_API int ME_create_meapprpathroot_from_window ( tag_t  bom_window,
tag_t *  new_apprpathroot,
tag_t *  top_pathnode 
)

Create or Update an MEApprPathRoot given a BOMWindow; The Top Line of the window will be used to create PathRoot if not exists. Create and add all PathNodes which are not created according to each child lines

Parameters
bom_window(I)
new_apprpathroot(O)
top_pathnode(O)
PS_API int ME_get_appr_path_node_parent_hierarchy ( tag_t  p1,
tag_t **  parentPathNodes,
tag_t **  parentItems,
tag_t **  parentThreads,
int *  parentCount 
)
Parameters
p1(I)
parentPathNodes(I)
parentItems(I)
parentThreads(I)
parentCount(I)
PS_API int ME_get_appr_path_nodes_for_component ( tag_t  componentItem,
tag_t  topItem,
tag_t **  pathNodes,
int *  pathCount 
)
Parameters
componentItem(I)
topItem(I)
pathNodes(I)
pathCount(I)
PS_API int ME_get_meapprpathnode_from_appearance ( tag_t  comp,
tag_t *  new_apprpathnode 
)

Given an AppearanceCache, find the corresponding MEApprPathNodes.

Parameters
comp(I) Tag of Appearance
new_apprpathnode(O) Pathnode corresponding to the Appearance
PS_API int ME_get_meapprpathnode_from_bomline ( tag_t  comp,
tag_t *  new_apprpathnode 
)

Given a BOMLine, find the corresponding MEApprPathNodes.

Parameters
comp(I) Tag of BOMLine
new_apprpathnode(O) Pathnode corresponding to the BOMLine
PS_API int ME_get_meapprpathnode_with_root_line ( tag_t  comp,
tag_t  root_line,
tag_t *  new_apprpathnode 
)

Given a BOMLine, and a designated rootLine, find the corresponding MEApprPathNodes. The rootLine will be considered as EndItem. If rootLine is NULL, window topLine will be the rootLine

Parameters
comp(I) Tag of BOMLine
root_line(I) BOMLine considered as root
new_apprpathnode(O) Pathnode corresponding to the BOMLine
PS_API int ME_get_meapprpathroot ( tag_t  tracked_item,
tag_t  tracked_bv,
tag_t *  apprpathroot 
)
Parameters
tracked_item(I)
tracked_bv(I)
apprpathroot(O)
PS_API int ME_get_meapprpathroot_from_apprroot ( tag_t  apprRoot,
tag_t *  apprpathroot 
)
Parameters
apprRoot(I)
apprpathroot(O)
PS_API int ME_get_path_node_item ( tag_t  p1,
tag_t *  p1Item 
)
Parameters
p1(I)
p1Item(I)
PS_API int ME_meapprpathnode_ask_apprs ( tag_t  pathNode,
int *  numApprs,
tag_t **  appearances 
)
Parameters
pathNode(I)
numApprs(O)
appearances(O)
PS_API int ME_meapprpathnode_ask_childnodes ( tag_t  pathNode,
int *  numChildren,
tag_t **  children 
)
Parameters
pathNode(I)
numChildren(O)
children(OF) numChildren
PS_API int ME_meapprpathnode_ask_config_appr ( tag_t  pathNode,
tag_t  rev_rule,
tag_t *  appearance 
)
Parameters
pathNode(I)
rev_rule(I)
appearance(O)
PS_API int ME_meapprpathnode_ask_item_revision ( tag_t  pathNode,
tag_t  rev_rule,
tag_t *  item_rev 
)
Parameters
pathNode(I)
rev_rule(I)
item_rev(O)
PS_API int ME_meapprpathnode_ask_occurrence ( tag_t  pathNode,
tag_t *  occ 
)
Parameters
pathNode(I)
occ(O)
PS_API int ME_meapprpathnode_ask_parent ( tag_t  pathNode,
tag_t *  parent 
)
Parameters
pathNode(I)
parent(O)
PS_API int ME_meapprpathnode_ask_pathroot ( tag_t  pathNode,
tag_t *  pathRoot 
)
Parameters
pathNode(I)
pathRoot(O)
PS_API int ME_meapprpathnode_remove_appr ( tag_t  pathNode,
tag_t  appearance 
)
Parameters
pathNode(I)
appearance(I)
PS_API int ME_meapprpathroot_ask_bomview ( tag_t  pathRoot,
tag_t *  bv 
)
Parameters
pathRoot(I)
bv(O)
PS_API int ME_meapprpathroot_ask_item ( tag_t  pathRoot,
tag_t *  item 
)
Parameters
pathRoot(I)
item(O)
PS_API int ME_meapprpathroot_ask_pathnodes ( tag_t  pathRoot,
int *  childCount,
tag_t **  path_nodes 
)
Parameters
pathRoot(I)
childCount(O)
path_nodes(O)
PS_API int ME_update_meapprpathnode_from_bomline ( tag_t  bom_line,
tag_t *  new_apprpathnode 
)

Given a BOM Line, update the corresponding MEApprPathNodes.

  1. PathNode for this BOMLine will be created if it doesn't exist
  2. All PathNodes corresponding to parent lines will be created if they don't exist
  3. All child PathNodes which correspond to child lines will be created
Note
This function WILL save the new Path Nodes.
Calls ME__update_apn_from_bomline without populating AbsOccID.
Parameters
bom_line(I) Tag of BOMLine
new_apprpathnode(O) Pathnode corresponding to the comp
PS_API int ME_update_meapprpathnode_with_root_line ( tag_t  bom_line,
tag_t  root_line,
tag_t *  new_apprpathnode 
)

Given a BOM Line, and a rootLine, update the corresponding MEApprPathNodes.

  1. PathNode for this BOMLine will be created if they don't exist
  2. All PathNodes corresponding to parent lines will be created if they don't exist
  3. All child PathNodes which correspond to child lines will be created
  4. All pathNodes are related to the rootLine as End Item
Note
This function WILL save the new Path Nodes.
Parameters
bom_line(I) Tag of BOMLine
root_line(I) BOMLine considered as End Item
new_apprpathnode(O) Pathnode corresponding to the comp
PS_API int ME_update_meapprpathroot ( tag_t  apprRoot,
tag_t *  new_apprpathroot 
)

Updates an MEApprPathRoot given an Appearance Set. It will check whether PathRoot exists. Create PathRoot only if there is no existing PathRoot. Also, it will create all PathNode corresponding to the Appearance set.

Note
This function WILL save the new Path root if got created.
Parameters
apprRoot(I) Appearance Set
new_apprpathroot(O) Pathroot found or created