Allocations

Functions
MECHATRONICS_API int	ALLOC_add_sources (tag_t allocation, int source_count, tag_t *sources)
MECHATRONICS_API int	ALLOC_add_targets (tag_t allocation, int target_count, tag_t *targets)
MECHATRONICS_API int	ALLOC_ask_allocated_from (tag_t target_bom_line, tag_t alloc_map_rev, tag_t source_bom_window, tag_t revision_rule, int *bom_line_count, tag_t **allocated_from_bom_lines)
MECHATRONICS_API int	ALLOC_ask_allocated_to (tag_t source_bom_line, tag_t alloc_map_rev, tag_t target_bom_window, tag_t revision_rule, int *bom_line_count, tag_t **allocated_to_bom_lines)
MECHATRONICS_API int	ALLOC_ask_allocations (tag_t map_rev, int *allocation_count, tag_t **alloc_tags)
MECHATRONICS_API int	ALLOC_ask_condition (tag_t allocation, tag_t *condition)
MECHATRONICS_API int	ALLOC_ask_configured_allocations (tag_t map_rev, tag_t revision_rule, int *allocation_count, tag_t **allocation_tags)
MECHATRONICS_API int	ALLOC_ask_map_rev (tag_t allocation, tag_t *map_rev_tag)
MECHATRONICS_API int	ALLOC_ask_map_source (tag_t map, tag_t *source_bv_tag)
MECHATRONICS_API int	ALLOC_ask_map_target (tag_t map, tag_t *target_bv_tag)
MECHATRONICS_API int	ALLOC_ask_reason (tag_t allocation_tag, char **reason)
MECHATRONICS_API int	ALLOC_ask_source (tag_t allocation, tag_t source_bom_window, tag_t *source_bom_line)
MECHATRONICS_API int	ALLOC_ask_sources (tag_t allocation, int *source_count, tag_t **sources)
MECHATRONICS_API int	ALLOC_ask_target (tag_t allocation, tag_t target_bom_window, tag_t *target_bom_line)
MECHATRONICS_API int	ALLOC_ask_targets (tag_t allocation, int *target_count, tag_t **targets)
MECHATRONICS_API int	ALLOC_change_condition (tag_t allocation, tag_t condition, tag_t ic_rev)
MECHATRONICS_API int	ALLOC_change_sources (tag_t allocation, int source_remove_count, tag_t *sources_to_remove, int source_add_count, tag_t *sources_to_add, tag_t ic_rev)
MECHATRONICS_API int	ALLOC_change_target (tag_t allocation, tag_t target_bom_line, tag_t ic_rev)
MECHATRONICS_API int	ALLOC_change_targets (tag_t allocation, int target_remove_count, tag_t *targets_to_remove, int target_add_count, tag_t *targets_to_add, tag_t ic_rev)
MECHATRONICS_API int	ALLOC_copy_map (tag_t map_rev, const char *new_map_id, const char *new_map_rev_id, tag_t *new_map, tag_t *new_map_rev)
MECHATRONICS_API int	ALLOC_create_allocation (const char *name, const char *type, tag_t source_bom_line, tag_t target_bom_line, tag_t map_rev, tag_t *allocation)
MECHATRONICS_API int	ALLOC_create_allocation_map (const char *id, const char *name, const char *type, const char *rev_id, int bomview_count, tag_t *bomviews, tag_t *map, tag_t *map_rev)
MECHATRONICS_API int	ALLOC_create_map (const char *id, const char *name, const char *type, const char *rev_id, tag_t source_bv_tag, tag_t target_bv_tag, tag_t *map, tag_t *map_rev)
MECHATRONICS_API int	ALLOC_create_map_rev (tag_t map, const char *rev_id, tag_t *new_rev)
MECHATRONICS_API int	ALLOC_create_new_allocation (const char *name, const char *type, int source_count, tag_t *sources, int target_count, tag_t *targets, tag_t map_rev, tag_t *allocation)
MECHATRONICS_API int	ALLOC_find_all_maps_for_bomview (tag_t bomview, int *allocation_map_count, tag_t **allocation_maps)
MECHATRONICS_API int	ALLOC_find_allocated_from (int target_count, tag_t *targets, tag_t map_rev, int *source_count, tag_t **sources)
MECHATRONICS_API int	ALLOC_find_allocated_to (int source_count, tag_t *sources, tag_t map_rev, int *target_count, tag_t **targets)
MECHATRONICS_API int	ALLOC_find_allocations_for_source (tag_t source_bom_line, tag_t map_rev, int *allocationCount, tag_t **alloc_tags)
MECHATRONICS_API int	ALLOC_find_allocations_for_sources (int source_count, tag_t *sources, tag_t map_rev, int *allocation_count, tag_t **allocation_tags)
MECHATRONICS_API int	ALLOC_find_allocations_for_target (tag_t target_bom_line, tag_t map_rev, int *allocationCount, tag_t **alloc_tags)
MECHATRONICS_API int	ALLOC_find_allocations_for_targets (int target_count, tag_t *targets, tag_t map_rev, int *allocation_count, tag_t **allocation_tags)
MECHATRONICS_API int	ALLOC_find_map (tag_t source_bv_tag, tag_t target_bv_tag, int *map_count, tag_t **map_tags)
MECHATRONICS_API int	ALLOC_is_allocation_complete (tag_t allocation, tag_t allocation_window, logical *is_complete)
MECHATRONICS_API int	ALLOC_is_allocation_correct (tag_t allocation, tag_t allocation_window, logical *is_correct)
MECHATRONICS_API int	ALLOC_map_add_bomviews (tag_t alloc_map, int bomview_count, tag_t *bomviews)
MECHATRONICS_API int	ALLOC_map_ask_bomviews (tag_t alloc_map, int *bomview_count, tag_t **bomviews)
MECHATRONICS_API int	ALLOC_map_remove_bomviews (tag_t alloc_map, int bomview_count, tag_t *bomviews)
MECHATRONICS_API int	ALLOC_remove_sources (tag_t allocation, int source_count, tag_t *sources)
MECHATRONICS_API int	ALLOC_remove_targets (tag_t allocation, int target_count, tag_t *targets)
MECHATRONICS_API int	ALLOC_set_condition (tag_t allocation, tag_t condition)
MECHATRONICS_API int	ALLOC_set_reason (tag_t allocation_tag, const char *reason)
MECHATRONICS_API int	ALLOC_set_source (tag_t allocation, tag_t source_bom_line)
MECHATRONICS_API int	ALLOC_set_sources (tag_t allocation, int source_count, tag_t *sources)
MECHATRONICS_API int	ALLOC_set_target (tag_t allocation, tag_t target_bom_line)
MECHATRONICS_API int	ALLOC_set_targets (tag_t allocation, int target_count, tag_t *targets)
MECHATRONICS_API int	MECHATRONICS_should_create_ice (tag_t line, logical *track)

Detailed Description

This module defines the required ITK interface for Allocation related operations.

Function Documentation

MECHATRONICS_API int ALLOC_add_sources	(	tag_t	allocation,
		int	source_count,
		tag_t *	sources
	)

This function adds the input sources to the existing sources for a given allocation

Parameters

allocation	(I) Tag of allocation
source_count	(I) Count of source APNs to be added
sources	(I) Tag list of the source APNs that needs to be added to the allocation

MECHATRONICS_API int ALLOC_add_targets	(	tag_t	allocation,
		int	target_count,
		tag_t *	targets
	)

This function adds the input targets to the existing targets for a given allocation

Parameters

allocation	(I) Tag of allocation
target_count	(I) Count of target APNs to be added
targets	(I) Tag list of the target APNs that needs to be added to the allocation

MECHATRONICS_API int ALLOC_ask_allocated_from	(	tag_t	target_bom_line,
		tag_t	alloc_map_rev,
		tag_t	source_bom_window,
		tag_t	revision_rule,
		int *	bom_line_count,
		tag_t **	allocated_from_bom_lines
	)

This function returns the source BOM line tags allocated for a target BOM line.

Parameters

target_bom_line	(I) Tag of target BOM line
alloc_map_rev	(I) Tag of allocation map revision
source_bom_window	(I) Tag of source BOMWindow
revision_rule	(I) Tag of revision rule to be used for configuring allocations
bom_line_count	(O) Number of BOM lines
allocated_from_bom_lines	(OF) Array of source BOM lines from which the target BOM line is allocated

MECHATRONICS_API int ALLOC_ask_allocated_to	(	tag_t	source_bom_line,
		tag_t	alloc_map_rev,
		tag_t	target_bom_window,
		tag_t	revision_rule,
		int *	bom_line_count,
		tag_t **	allocated_to_bom_lines
	)

This function returns the target BOM line tags allocated for a source BOM line.

Parameters

source_bom_line	(I) Tag of source BOM line
alloc_map_rev	(I) Tag of allocation map revision
target_bom_window	(I) Tag of target BOMWindow
revision_rule	(I) Tag of revision rule to be used for configuring allocations
bom_line_count	(O) Number of BOM lines
allocated_to_bom_lines	(OF) Array of target BOM lines allocated to given source BOM line

MECHATRONICS_API int ALLOC_ask_allocations	(	tag_t	map_rev,
		int *	allocation_count,
		tag_t **	alloc_tags
	)

This function searches for allocation objects in the database that point to a given map rev as the owning map rev.

Parameters

map_rev	(I) Tag of allocation map revision
allocation_count	(O) Number of allocations found
alloc_tags	(OF) Tag array of allocations found

MECHATRONICS_API int ALLOC_ask_condition	(	tag_t	allocation,
		tag_t *	condition
	)

This function returns the configuration condition for a given allocation.

Parameters

allocation	(I) Allocation tag
condition	(O) Tag of configuration condition defined on the allocation

MECHATRONICS_API int ALLOC_ask_configured_allocations	(	tag_t	map_rev,
		tag_t	revision_rule,
		int *	allocation_count,
		tag_t **	allocation_tags
	)

This function searches for all configured allocation objects in the database that point to the given map rev as the owning map rev.

Parameters

map_rev	(I) Tag of allocation map revision
revision_rule	(I) Tag of revision rule to be used for configuring allocations
allocation_count	(O) Number of configured allocations
allocation_tags	(OF) Array of configured allocation tags

MECHATRONICS_API int ALLOC_ask_map_rev	(	tag_t	allocation,
		tag_t *	map_rev_tag
	)

This function returns the owning allocation map revision for a given allocation.

Parameters

allocation	(I) Allocation map tag
map_rev_tag	(O) Tag of corresponding allocation map revision

MECHATRONICS_API int ALLOC_ask_map_source	(	tag_t	map,
		tag_t *	source_bv_tag
	)

This function returns the source BOM view for a given allocation map.

Parameters

map	(I) Tag of allocation map
source_bv_tag	(O) Tag of source BOM view

MECHATRONICS_API int ALLOC_ask_map_target	(	tag_t	map,
		tag_t *	target_bv_tag
	)

This function returns the target BOM view for a given allocation map.

Parameters

map	(I) Tag of allocation map
target_bv_tag	(O) Tag of target BOM view

MECHATRONICS_API int ALLOC_ask_reason	(	tag_t	allocation_tag,
		char **	reason
	)

This function returns the reason string specified on an allocation.

Parameters

allocation_tag	(I) Tag of allocation
reason	(OF) Reason assigned to the allocation

MECHATRONICS_API int ALLOC_ask_source	(	tag_t	allocation,
		tag_t	source_bom_window,
		tag_t *	source_bom_line
	)

This function returns the source BOM line for a given allocation.

Parameters

allocation	(I) Allocation tag
source_bom_window	(I) BOMWindow of interest for source
source_bom_line	(O) Tag of source BOM line

MECHATRONICS_API int ALLOC_ask_sources	(	tag_t	allocation,
		int *	source_count,
		tag_t **	sources
	)

This function returns the source apns associated for a given allocation

Parameters

allocation	(I) Allocation tag
source_count	(O) Count of source APNs returned
sources	(OF) Tag list of all source APNs associated to the allocation

MECHATRONICS_API int ALLOC_ask_target	(	tag_t	allocation,
		tag_t	target_bom_window,
		tag_t *	target_bom_line
	)

This function returns the target BOM line for a given allocation.

Parameters

allocation	(I) Allocation tag
target_bom_window	(I) BOMWindow of interest for target
target_bom_line	(O) Tag of target BOM line

MECHATRONICS_API int ALLOC_ask_targets	(	tag_t	allocation,
		int *	target_count,
		tag_t **	targets
	)

This function returns the target apns associated to the given allocation

Parameters

allocation	(I) Allocation tag
target_count	(O) Count of target APNs returned
targets	(OF) Tag list of target APNs associated to the allcoation

MECHATRONICS_API int ALLOC_change_condition	(	tag_t	allocation,
		tag_t	condition,
		tag_t	ic_rev
	)

This function changes the configuration condition for a given allocation using incremental change.

Parameters

allocation	(I) Allocation tag
condition	(I) Tag of configuration condition to set on allocation
ic_rev	(I) Tag of incremental change revision

MECHATRONICS_API int ALLOC_change_sources	(	tag_t	allocation,
		int	source_remove_count,
		tag_t *	sources_to_remove,
		int	source_add_count,
		tag_t *	sources_to_add,
		tag_t	ic_rev
	)

This function changes the sources for the given allocation based on IC revision. The source apns from sources_to_remove will be removed from the existing source list and sources_to_add will be added to the existing list of source apns for the allocation.

Parameters

allocation	(I) Input allocation tag
source_remove_count	(I) Number of source APNs to be removed
sources_to_remove	(I) Source APN tags to be removed
source_add_count	(I) Number of new APNs to be added
sources_to_add	(I) List of new source APN tags to be added
ic_rev	(I) Incremental change revision

MECHATRONICS_API int ALLOC_change_target	(	tag_t	allocation,
		tag_t	target_bom_line,
		tag_t	ic_rev
	)

This function changes the target BOM line for a given allocation using incremental change.

Parameters

allocation	(I) Tag of allocation
target_bom_line	(I) Tag of target BOM line
ic_rev	(I) Tag of incremental change revision

MECHATRONICS_API int ALLOC_change_targets	(	tag_t	allocation,
		int	target_remove_count,
		tag_t *	targets_to_remove,
		int	target_add_count,
		tag_t *	targets_to_add,
		tag_t	ic_rev
	)

This function changes the targets for the given allocation based on IC revision. The target apns from target_to_remove will be removed and the targets from target_to_add will be added to the existing list of target apns for the allocation.

Parameters

allocation	(I) Input allocation tag
target_remove_count	(I) Number of target APNs to be removed
targets_to_remove	(I) APN target tags to be removed
target_add_count	(I) Number of new target APNs to be added
targets_to_add	(I) List of new APN tags to be added
ic_rev	(I) Incremental change revision

MECHATRONICS_API int ALLOC_copy_map	(	tag_t	map_rev,
		const char *	new_map_id,
		const char *	new_map_rev_id,
		tag_t *	new_map,
		tag_t *	new_map_rev
	)

This function creates a copy of the allocation map object and points to the the same list of bomviews as the given allocation map. The copied allocation map revision will contain all allocations if the prefernece ALLOC_map_copy_allocations has value 'copy'.

Parameters

map_rev	(I) Tag of allocation map revision to be copied
new_map_id	(I) Allocation map id for copy
new_map_rev_id	(I) Revision string for copy
new_map	(O) Tag of copied allocation map
new_map_rev	(O) Tag of copied allocation map revision

MECHATRONICS_API int ALLOC_create_allocation	(	const char *	name,
		const char *	type,
		tag_t	source_bom_line,
		tag_t	target_bom_line,
		tag_t	map_rev,
		tag_t *	allocation
	)

This function creates a new allocation object with a single source and target bomline

Parameters

name	(I) Name of allocation to be created
type	(I) Type of allocation to be created
source_bom_line	(I) Tag of source BOM line
target_bom_line	(I) Tag of target BOM line
map_rev	(I) Tag of allocation map revision
allocation	(O) Tag of allocation created

MECHATRONICS_API int ALLOC_create_allocation_map	(	const char *	id,
		const char *	name,
		const char *	type,
		const char *	rev_id,
		int	bomview_count,
		tag_t *	bomviews,
		tag_t *	map,
		tag_t *	map_rev
	)

This function creates an allocation map pointing to a set of bomviews. This will also create an initial revision of the allocation map.

Note

This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

Parameters

id	(I) Id of allocation map
name	(I) Allocation map name
type	(I) Allocation map type
rev_id	(I) Revision string
bomview_count	(I) Bomview count
bomviews	(I) All bomviews that will be associated with the allocation map
map	(O) Tag of allocation map created
map_rev	(O) Tag of allocation map revision created

MECHATRONICS_API int ALLOC_create_map	(	const char *	id,
		const char *	name,
		const char *	type,
		const char *	rev_id,
		tag_t	source_bv_tag,
		tag_t	target_bv_tag,
		tag_t *	map,
		tag_t *	map_rev
	)

This function creates an allocation map between a source BOM view and a target BOM view. This will also create an initial revision of the allocation map.

Note

This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

Parameters

id	(I) Id of allocation map
name	(I) Allocation map name
type	(I) Allocation map type
rev_id	(I) Revision string
source_bv_tag	(I) Tag of source BOM view
target_bv_tag	(I) Tag of target BOM view
map	(O) Tag of allocation map created
map_rev	(O) Tag of allocation map revision created

MECHATRONICS_API int ALLOC_create_map_rev	(	tag_t	map,
		const char *	rev_id,
		tag_t *	new_rev
	)

This function revises an existing allocation map to create a new revision. On setting the preference ALLOC_map_copy_allocations to value 'Revise', the new revision will get a copy of all allocations from the existing revision.

Note

This itk will not save the object. AOM_save_with_extensions needs to be called separately to save the object.

Parameters

map	(I) Tag of allocation map
rev_id	(I) Allocation map revision to be copied
new_rev	(O) Tag of new revision created

MECHATRONICS_API int ALLOC_create_new_allocation	(	const char *	name,
		const char *	type,
		int	source_count,
		tag_t *	sources,
		int	target_count,
		tag_t *	targets,
		tag_t	map_rev,
		tag_t *	allocation
	)

This function creates a new allocation object between multiple source and targets that span between multiple bomviews.

Parameters

name	(I) Name of allocation to be created
type	(I) Type of allocation to be created
source_count	(I) Count of Source APNs to be associated to the allocation
sources	(I) Tag list of source APNs for the allocation
target_count	(I) Count of Target APNs to be associated to the allocation
targets	(I) Tag list of target APNs for the allocation
map_rev	(I) Tag of allocation map revision
allocation	(O) Tag of allocation created

MECHATRONICS_API int ALLOC_find_all_maps_for_bomview	(	tag_t	bomview,
		int *	allocation_map_count,
		tag_t **	allocation_maps
	)

This function will get all allocation maps that are associated to the bomview tag

Parameters

bomview	(I) Tag of the bomview
allocation_map_count	(O) Count of allocation map objects returned
allocation_maps	(OF) Tag list of all allocations that associates the bomview

MECHATRONICS_API int ALLOC_find_allocated_from	(	int	target_count,
		tag_t *	targets,
		tag_t	map_rev,
		int *	source_count,
		tag_t **	sources
	)

This function searches for all source apns that are associated to the set of target apns and the map revision passed as input. NULLTAG is treated as wild card (meaning any).

Parameters

target_count	(I) Number of target APNs
targets	(I) List of target APNs
map_rev	(I) Tag of allocation map revision
source_count	(O) Number of source APNs found
sources	(OF) Array of source APN tags

MECHATRONICS_API int ALLOC_find_allocated_to	(	int	source_count,
		tag_t *	sources,
		tag_t	map_rev,
		int *	target_count,
		tag_t **	targets
	)

This function searches for all targets that are associated to the set of source apns and the map revision passed as input. NULLTAG is treated as wild card (meaning any).

Parameters

source_count	(I) Number of source APNs
sources	(I) List of source APNs
map_rev	(I) Tag of allocation map revision
target_count	(O) Number of target APNs found
targets	(OF) Array of target APN tags

MECHATRONICS_API int ALLOC_find_allocations_for_source	(	tag_t	source_bom_line,
		tag_t	map_rev,
		int *	allocationCount,
		tag_t **	alloc_tags
	)

This function searches for all allocation objects in the database that point to the given BOM line as source BOM line and point to the given map rev as the owning map rev. NULLTAG is treated as wild card (meaning any).

Parameters

source_bom_line	(I) Tag of source BOM line
map_rev	(I) Tag of allocation map revision
allocationCount	(O) Number of allocations found
alloc_tags	(OF) Array of allocation tags

MECHATRONICS_API int ALLOC_find_allocations_for_sources	(	int	source_count,
		tag_t *	sources,
		tag_t	map_rev,
		int *	allocation_count,
		tag_t **	allocation_tags
	)

This function searches for all allocation objects in the database that point to the given allocation map rev as the owning map rev and having any of the given sources as the associated source apns. NULLTAG is treated as wild card (meaning any)

Parameters

source_count	(I) Number of source APNs
sources	(I) List of source APNs
map_rev	(I) Tag of allocation map revision
allocation_count	(O) Number of allocations found
allocation_tags	(OF) Array of allocation tags

MECHATRONICS_API int ALLOC_find_allocations_for_target	(	tag_t	target_bom_line,
		tag_t	map_rev,
		int *	allocationCount,
		tag_t **	alloc_tags
	)

This function searches for all allocation objects in the database that point to the given BOM line as target BOM line and point to the given map rev as the owning map rev. NULLTAG is treated as wild card (meaning any).

Parameters

target_bom_line	(I) Tag of target BOM line
map_rev	(I) Tag of allocation map revision
allocationCount	(O) Number of allocations found
alloc_tags	(OF) Array of allocation tags

MECHATRONICS_API int ALLOC_find_allocations_for_targets	(	int	target_count,
		tag_t *	targets,
		tag_t	map_rev,
		int *	allocation_count,
		tag_t **	allocation_tags
	)

This function searches for all allocation objects in the database that point to the given allocation map rev as the owning map rev and having any of the given targets as the associated target apns. NULLTAG is treated as wild card (meaning any).

Parameters

target_count	(I) Count of target APNs
targets	(I) List of target APNs
map_rev	(I) Tag of allocation map revision
allocation_count	(O) Number of allocations found
allocation_tags	(OF) Array of allocation tags

MECHATRONICS_API int ALLOC_find_map	(	tag_t	source_bv_tag,
		tag_t	target_bv_tag,
		int *	map_count,
		tag_t **	map_tags
	)

This function searches the database for allocation map objects that refer to a given view as source view and a given view as target view. NULLTAGs can be specified for source view and target view to indicate wildcards (meaning any).

Parameters

source_bv_tag	(I) Tag of source BOM view
target_bv_tag	(I) Tag of target BOM view
map_count	(O) Number of allocation maps found
map_tags	(OF) Tag array of allocations maps found

MECHATRONICS_API int ALLOC_is_allocation_complete	(	tag_t	allocation,
		tag_t	allocation_window,
		logical *	is_complete
	)

This API provides a means for users to hook-up thier business logic to define what a complete Allocation can be in Teamcenter. By-default this API returs a True value, in other words it is users who are to decide what it means for a Allocation to be complete. The Input parameter of allocation window is Optional.

Parameters

allocation	(I) Input allocation tag
allocation_window	(I) Input allocation window tag - Optional
is_complete	(O) Flag indicating whether this allocation Object is a complete or not

MECHATRONICS_API int ALLOC_is_allocation_correct	(	tag_t	allocation,
		tag_t	allocation_window,
		logical *	is_correct
	)

This API provides a means for users to hook-up thier business logic to define what a correct Allocation can be in Teamcenter. By-default this API returs a True value, in other words it is users who are to decide what it means for a Allocation to be correct. The Input parameter of allocation window is Optional!

Parameters

allocation	(I) Input allocation tag
allocation_window	(I) Input allocation window tag - Optional
is_correct	(O) Flag indicating whether this allocation Object is a complete or not

MECHATRONICS_API int ALLOC_map_add_bomviews	(	tag_t	alloc_map,
		int	bomview_count,
		tag_t *	bomviews
	)

This function will add the bomviews to the allocation map object.

Parameters

alloc_map	(I) Tag of the allocation map object
bomview_count	(I) Count for bomview
bomviews	(I) Tag list of bomviews that needs to be associated to the allocation map

MECHATRONICS_API int ALLOC_map_ask_bomviews	(	tag_t	alloc_map,
		int *	bomview_count,
		tag_t **	bomviews
	)

This function will get all bomviews associated to the allocation map object.

Parameters

alloc_map	(I) Tag of the allocation map object
bomview_count	(O) Count of bomviews returned
bomviews	(OF) Tag list of bomviews that are associated to the allocation map

MECHATRONICS_API int ALLOC_map_remove_bomviews	(	tag_t	alloc_map,
		int	bomview_count,
		tag_t *	bomviews
	)

This function will remove the bomviews from the allocation map object

Parameters

alloc_map	(I) Tag of the allocation map object
bomview_count	(I) Count of bomviews
bomviews	(I) Tag list of bomviews that needs to be removed from the allocation map

MECHATRONICS_API int ALLOC_remove_sources	(	tag_t	allocation,
		int	source_count,
		tag_t *	sources
	)

This function removes the input sources from the existing sources for a given allocation

Parameters

allocation	(I) Tag of allocation
source_count	(I) Count of source APNs
sources	(I) Tag list of source APNs to be removed from the allocation

MECHATRONICS_API int ALLOC_remove_targets	(	tag_t	allocation,
		int	target_count,
		tag_t *	targets
	)

This function removes the input targets from the existing targets for a given allocation

Parameters

allocation	(I) Tag of allocation
target_count	(I) Count of target APNs
targets	(I) Tag list of target APNs to be removed from the allocation

MECHATRONICS_API int ALLOC_set_condition	(	tag_t	allocation,
		tag_t	condition
	)

This function sets the configuration condition for a given allocation.

Parameters

allocation	(I) Allocation tag
condition	(I) Tag of configuration condition to set on allocation

MECHATRONICS_API int ALLOC_set_reason	(	tag_t	allocation_tag,
		const char *	reason
	)

This function assigns the reason string to allocation that explains the purpose of creating this allocation.

Parameters

allocation_tag	(I) Tag of allocation
reason	(I) Reason to be assigned

MECHATRONICS_API int ALLOC_set_source	(	tag_t	allocation,
		tag_t	source_bom_line
	)

This function sets the source BOM line for a given allocation.

Parameters

allocation	(I) Tag of allocation
source_bom_line	(I) Tag of source BOM line

MECHATRONICS_API int ALLOC_set_sources	(	tag_t	allocation,
		int	source_count,
		tag_t *	sources
	)

This function sets the source apns for a given allocation. This method will replace the existing list of sources for the allocation with the new sources passed.

Parameters

allocation	(I) Tag of allocation
source_count	(I) Count of source APNs
sources	(I) Tag list of source APNs to be associated to the allocation

MECHATRONICS_API int ALLOC_set_target	(	tag_t	allocation,
		tag_t	target_bom_line
	)

This function sets the target BOM line for a given allocation.

Parameters

allocation	(I) Tag of allocation
target_bom_line	(I) Tag of target BOM line

MECHATRONICS_API int ALLOC_set_targets	(	tag_t	allocation,
		int	target_count,
		tag_t *	targets
	)

This function sets the target apns for a given allocation. This method will replace the existing list of targets for the allocation with the new targets passed.

Parameters

allocation	(I) Allocation tag
target_count	(I) Count of target APNs returned
targets	(I) Tag list of target APNs associated to the allcoation

MECHATRONICS_API int MECHATRONICS_should_create_ice	(	tag_t	line,
		logical *	track
	)

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

Returns

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

Parameters

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