BOP Line Functions

Functions
ME_API int	APPGRP_line_add (tag_t appGrpLine_tag, tag_t child_tag)
ME_API int	BOP_line_add (tag_t bom_line, tag_t item_folder, tag_t item_revision_folder, tag_t bv, tag_t *new_line)
ME_API int	BOP_line_add_alternate (tag_t bom_line, tag_t item, tag_t item_revision, tag_t bom_view, tag_t *new_line)
ME_API int	BOP_line_add_app_group (tag_t parent, tag_t app_group, logical as_substitute, tag_t *new_bom_line)
ME_API int	BOP_line_add_app_group_with_occ_type (tag_t parent, tag_t app_group, logical as_substitute, char *occType, tag_t *new_bom_line)
ME_API int	BOP_line_add_substitute (tag_t bom_line, tag_t item, tag_t item_revision, tag_t bom_view, tag_t *new_line)
ME_API int	BOP_line_add_with_occ_type (tag_t bom_line, tag_t item_folder, tag_t item_revision_folder, tag_t bv, char *occType, tag_t *new_line)
ME_API int	BOP_line_ask_appearance (tag_t bomline, int *count, tag_t *appearance)
ME_API int	BOP_line_ask_appearance_links (tag_t bom_line, char *relation_type, int *count, tag_t **appearances)
ME_API int	BOP_line_ask_linked_appearances (tag_t bom_line, logical requiredOnly, int *count, tag_t **appearances)
ME_API int	BOP_line_change_sequence_number (tag_t bopline, int startNum, int incrNum)
ME_API int	BOP_line_create_assembly_tree (tag_t bopline, logical onOperation, logical updateOnly, tag_t *viewTag)
ME_API int	BOP_line_link_to_appearance (tag_t bom_line, tag_t appline, logical asRequired)
ME_API int	BOP_line_remove_appearance (tag_t bom_line, tag_t appearance, logical asRequired)
ME_API int	BOP_line_update_workpiece (tag_t bopline, logical selfOnly)
ME_API int	BOP_window_get_occ_type_filter (tag_t window_tag, int *count, char ***typeList)
ME_API int	BOP_window_hide_occ_type_filter (tag_t bopWindow)
ME_API int	BOP_window_set_occ_type_filter (tag_t window_tag, int count, char **typeList)
ME_API int	BOP_window_show_occ_type_filter (tag_t bopWindow)
ME_API int	BOPLine_set_occ_group_base_mode (tag_t bopline_tag, logical viewModeInBase)
ME_API int	ME_should_create_ice (tag_t line, logical *track)

Detailed Description

Function Documentation

ME_API int APPGRP_line_add	(	tag_t	appGrpLine_tag,
		tag_t	child_tag
	)

Parameters

appGrpLine_tag	(I) >
child_tag	(I) >

ME_API int BOP_line_add	(	tag_t	bom_line,
		tag_t	item_folder,
		tag_t	item_revision_folder,
		tag_t	bv,
		tag_t *	new_line
	)

Adds a new component to given line.

Parameters

bom_line	(I) Bomline to add to
item_folder	(I) Item to add, ignored if rev specified
item_revision_folder	(I) Item rev to add. For specifying the revision when adding to precise bvrs, if null the item's configured revision is used.
bv	(I) The child's bom view, if any, to be shown if the new child is expanded. Optional.
new_line	(O) The new bomline

ME_API int BOP_line_add_alternate	(	tag_t	bom_line,
		tag_t	item,
		tag_t	item_revision,
		tag_t	bom_view,
		tag_t *	new_line
	)

Deprecated this will be obsoleted. Use BOP_line_add_substitute.

Parameters

bom_line	(I)
item	(I)
item_revision	(I)
bom_view	(I)
new_line	(O)

ME_API int BOP_line_add_app_group	(	tag_t	parent,
		tag_t	app_group,
		logical	as_substitute,
		tag_t *	new_bom_line
	)

Adds a new appearance group bop line to the given line.

Parameters

parent	(I)
app_group	(I)
as_substitute	(I) If True, the appropriate error is generated
new_bom_line	(O)

ME_API int BOP_line_add_app_group_with_occ_type	(	tag_t	parent,
		tag_t	app_group,
		logical	as_substitute,
		char *	occType,
		tag_t *	new_bom_line
	)

Adds a new appearance group bop line to the given line.

Parameters

parent	(I)
app_group	(I)
as_substitute	(I) If True, the appropriate error is generated
occType	(I)
new_bom_line	(O)

ME_API int BOP_line_add_substitute	(	tag_t	bom_line,
		tag_t	item,
		tag_t	item_revision,
		tag_t	bom_view,
		tag_t *	new_line
	)

Adds a new line as a substitute to the given preferred/non-substitute line. If the given line currently has no substitutes, the given line becomes the 'preferred' substitute. See BOP_line_add for description of arguments.

Parameters

bom_line	(I)
item	(I)
item_revision	(I)
bom_view	(I)
new_line	(O)

ME_API int BOP_line_add_with_occ_type	(	tag_t	bom_line,
		tag_t	item_folder,
		tag_t	item_revision_folder,
		tag_t	bv,
		char *	occType,
		tag_t *	new_line
	)

Adds a new component to given line.

Parameters

bom_line	(I) Bomline to add to
item_folder	(I) Item to add, ignored if rev specified
item_revision_folder	(I) Item rev to add. For specifying the revision when adding to precise bvrs, if null the item's configured revision is used.
bv	(I) The child's bom view, if any, to be shown if the new child is expanded. Optional.
occType	(I)
new_line	(O) The new bomline

ME_API int BOP_line_ask_appearance	(	tag_t	bomline,
		int *	count,
		tag_t *	appearance
	)

Parameters

bomline	(I)
count	(O)
appearance	(O) count

ME_API int BOP_line_ask_appearance_links	(	tag_t	bom_line,
		char *	relation_type,
		int *	count,
		tag_t **	appearances
	)

Find all occurrences linked to this line's appearance.

Parameters

bom_line	(I)
relation_type	(I)
count	(O)
appearances	(OF) count

ME_API int BOP_line_ask_linked_appearances	(	tag_t	bom_line,
		logical	requiredOnly,
		int *	count,
		tag_t **	appearances
	)

Find all linked appearances to this line.

Parameters

bom_line	(I)
requiredOnly	(I)
count	(O)
appearances	(OF) count

ME_API int BOP_line_change_sequence_number	(	tag_t	bopline,
		int	startNum,
		int	incrNum
	)

Re-order sequence number for all immediate children of input process line.

Parameters

bopline	(I)
startNum	(I) Start sequence number
incrNum	(I) Incremental sequence number

ME_API int BOP_line_create_assembly_tree	(	tag_t	bopline,
		logical	onOperation,
		logical	updateOnly,
		tag_t *	viewTag
	)

Create an assembly tree from the input process line.

Parameters

bopline	(I)
onOperation	(I)
updateOnly	(I) True: update assembly tree False: create assembly tree
viewTag	(I/O) When viewTag is NULLTAG, the system will create a view with default name onOperation, where: True: create assembly tree based on operations only False: Create assembly tree based on processes only

ME_API int BOP_line_link_to_appearance	(	tag_t	bom_line,
		tag_t	appline,
		logical	asRequired
	)

Link current bom_line to a corresponding appearance for appline. This is done for a consumed item for Manufacturing Process Planning using a relation type of IMAN_MEProductAppearance.

Parameters

bom_line	(I)
appline	(I)
asRequired	(I)

ME_API int BOP_line_remove_appearance	(	tag_t	bom_line,
		tag_t	appearance,
		logical	asRequired
	)

Remove a GRM from current line to its appearance

Note

The appearance is linked for a consumed item for Manufacturing Process Planning using a relation type of IMAN_MEProductAppearance.

Parameters

bom_line	(I)
appearance	(I)
asRequired	(I)

ME_API int BOP_line_update_workpiece	(	tag_t	bopline,
		logical	selfOnly
	)

Updates an assembly tree from the input process line.

Parameters

bopline	(I)
selfOnly	(I) True: only update workpiece on the input bopline False: update the workpieces from the input bopline to the top line

ME_API int BOP_window_get_occ_type_filter	(	tag_t	window_tag,
		int *	count,
		char ***	typeList
	)

Parameters

window_tag	(I)
count	(O)
typeList	(OF) count

ME_API int BOP_window_hide_occ_type_filter

(

tag_t

bopWindow

)

Show all boplines (not based on occ type filter)

Parameters

bopWindow

(I) The BOP window tag

ME_API int BOP_window_set_occ_type_filter	(	tag_t	window_tag,
		int	count,
		char **	typeList
	)

Parameters

window_tag	(I)
count	(I)
typeList	(I)

ME_API int BOP_window_show_occ_type_filter

(

tag_t

bopWindow

)

Show bopline based on the occurrence type filter

Parameters

bopWindow

(I) The BOP window tag

ME_API int BOPLine_set_occ_group_base_mode	(	tag_t	bopline_tag,
		logical	viewModeInBase
	)

(I) >

Parameters

bopline_tag

(I) >

ME_API int ME_should_create_ice	(	tag_t	line,
		logical *	track
	)

Determines if an Incremental Change Element (ICE) needs to be created for a change on a Attachment line.

Returns

• ITK_ok on success.
• BOM_invalid_tag if an invalid tag if provided for Attachment line.
• Possibly other errors, as the extension functions are implemented by customers.

Parameters

line	(I) Tag of Attachment line
track	(O) If ICE needs to be created