#include <unidefs.h>
#include <mfgbvr/libmfgbvr_exports.h>
#include <mfgbvr/libmfgbvr_undef.h>

Functions
MFGBVR_API int	MFG_copy_data_for_scope_flows (tag_t old_revision, tag_t new_revision)

MFGBVR_API int	MFG_create_EBOPContext (const char type, const char name, const char desc, const char rootPartitionType, const char rootPartitionName, const char rootPartitionDesc, int count, tag_t *newObjects)

MFGBVR_API int	MFG_create_object (const char type, tag_t target, tag_t context, const char name, const char desc, int count, tag_t **newObjects)

MFGBVR_API int	MFG_export_objects_to_briefcase (const char reason, int n_objects, const tag_t objects, int n_sites, const tag_t sites, tag_t option_set, int n_options, const char option_names, const char option_values, int n_session_options, const char session_option_names, const char session_option_values, tag_t briefcase_dataset, char *briefcase_file_name, int n_export_log_files, char ***export_log_files)

MFGBVR_API int	MFG_request_remote_export (int n_objects, const tag_t objects, int n_sites, const tag_t sites, const char reason, tag_t option_set, int n_options, const char option_names, const char option_values, int n_session_options, const char session_option_names, const char session_option_values, int priority, logical email_notification, int n_email_addrs, char email_addrs, int n_msg_ids, char ***msg_ids)


MFGBVR_API int	MFG_getLDRepresentation (tag_t line, char **ld_concat)

MFGBVR_API int	MFG_search_lines_in_context (tag_t top_line, const char logical_pos, const char usage_address, int op, tag_t *found_lines, int size)


MFGBVR_API int	MFG_create_logical_assignment (tag_t target, tag_t context, const char name, const char desc, const char assignType, const char usageAddr, const char position, tag_t newObj)


MFGBVR_API int	MFG_assign_part (tag_t target, tag_t source, const char relationName, const char relationType, tag_t *newObj)


MFGBVR_API int	MFG_allocate_object (tag_t target, tag_t source, tag_t *newObj)


MFGBVR_API int	MFG_connect_object (tag_t target, tag_t source, const char relationType, tag_t newObj)


MFGBVR_API int	MFG_create_search_criteria_for_tool_requirement (tag_t icsClass, int icsOptions, int noOfUncts, const int uncts, const char unctValues, tag_t searchCriteriaTag)


MFGBVR_API int	MFG_create_tool_requirement (tag_t target, tag_t context, const char name, const char desc, const char assignType, tag_t searchCriteria, tag_t newObj)

Detailed Description

This file contains the function prototypes for working with the class mfgbvr and specifically with the C ITK interface to this class.

Definition in file mfgbvr.h.

Function Documentation

MFGBVR_API int MFG_allocate_object	(	tag_t	target,
		tag_t	source,
		tag_t *	newObj
	)

Parameters

target	(I) target
source	(I) source
newObj	(O) tag to newly created object

MFGBVR_API int MFG_assign_part	(	tag_t	target,
		tag_t	source,
		const char *	relationName,
		const char *	relationType,
		tag_t *	newObj
	)

Parameters

target	(I) target
source	(I) source
relationName	(I) Relation Name
relationType	(I) Relation Type
newObj	(O) tag to newly created object

MFGBVR_API int MFG_connect_object	(	tag_t	target,
		tag_t	source,
		const char *	relationType,
		tag_t *	newObj
	)

Parameters

target	(I) target
source	(I) source
relationType	(I) Relation Type
newObj	(O) tag to newly created object

MFGBVR_API int MFG_copy_data_for_scope_flows	(	tag_t	old_revision,
		tag_t	new_revision
	)

Copies relationship data for scope flows from old revision to new revision.

Returns

ITK_ok on success.
MFGBVR_internal_error if an invalid item revision is provided.
Possibly other errors

Parameters

old_revision	(I) Old Revision tag on which the scope flow relationship exists
new_revision	(I) New Revision tag in which the scope flow relationship data needs to be copied

MFGBVR_API int MFG_create_logical_assignment	(	tag_t	target,
		tag_t	context,
		const char *	name,
		const char *	desc,
		const char *	assignType,
		const char *	usageAddr,
		const char *	position,
		tag_t *	newObj
	)

Parameters

target	(I) target
context	(I) context
name	(I) Name of the object
desc	(I) Description for new object
assignType	(I) assignment type
usageAddr	(I) usage address
position	(I) logical position
newObj	(O) tag to newly created object

MFGBVR_API int MFG_create_search_criteria_for_tool_requirement	(	tag_t	icsClass,
		int	icsOptions,
		int	noOfUncts,
		const int *	uncts,
		const char **	unctValues,
		tag_t *	searchCriteriaTag
	)

Parameters

icsClass	(I)
icsOptions	(I)
noOfUncts	(I)
uncts	(I)
unctValues	(I)
searchCriteriaTag	(O)

MFGBVR_API int MFG_create_tool_requirement	(	tag_t	target,
		tag_t	context,
		const char *	name,
		const char *	desc,
		const char *	assignType,
		tag_t	searchCriteria,
		tag_t *	newObj
	)

Parameters

target	(I) Operation/process
context	(I) Mostly null
name	(I) TR Name
desc	(I) TR description
assignType	(I) Assignment Type say METool
searchCriteria	(I) Could be NULL
newObj	(O) TR Object

MFGBVR_API int MFG_export_objects_to_briefcase	(	const char *	reason,
		int	n_objects,
		const tag_t *	objects,
		int	n_sites,
		const tag_t *	sites,
		tag_t	option_set,
		int	n_options,
		const char **	option_names,
		const char **	option_values,
		int	n_session_options,
		const char **	session_option_names,
		const char **	session_option_values,
		tag_t *	briefcase_dataset,
		char **	briefcase_file_name,
		int *	n_export_log_files,
		char ***	export_log_files
	)

Exports objects to Briefcase in off line mode. If the exported object is a Collaboration Context (CC), an Appearance Path Node (APN) is also created for the identified BOMLine objects in the CC.
The BOMLine objects are identified based on the preference MERuleForBriefcaseExport.

Returns

ITK_ok on success.
GMS_zero_target_sites if n_sites is 0.
GMS_invalid_target_site if any site in sites is invalid (NULLTAG).
GMS_nothing_to_process if any object in objects is invalid (NULLTAG).

Parameters

reason	(I) Reason for the export. This can be a null pointer.
n_objects	(I) Number of objects to be exported.
objects	(I) n_objects Objects to be exported.
n_sites	(I) Number of sites to which objects are to be exported.
sites	(I) n_sites Sites to which objects are to be exported.
option_set	(I) The object of type "TransferOptionSet".
n_options	(I) Number of transfer options whose values need to different than in "TransferOptionSet".
option_names	(I) n_options Options whose values need to different than in "TransferOptionSet". Some of the valid values are: opt_do_struct (true/false) opt_rev_select (latestRevisionOnly/allReleasedRevisionsOnly/ etc) opt_entire_bom (true/false) For the extensive list, please refer to the documentation of the PLM XML Export Import administration tool.
option_values	(I) n_options Overridden Values.
n_session_options	(I) Number of session options
session_option_names	(I) n_session_options Session options. Some of the valid values are: modified_objects_only (True/False) continue_on_error (True/False) dry_run (True/False) offline (True/False) transfer_site_ownership (True/False) For the extensive list, please refer to the documentation of the PLM XML Export Import administration tool.
session_option_values	(I) n_session_options Values of session options.
briefcase_dataset	(O) Tag of the dataset representing exported briefcase.
briefcase_file_name	(OF) File name of the exported briefcase.
n_export_log_files	(O) Number of log files.
export_log_files	(OF) n_export_log_files Log files. The array is not packed, which means that the memory is to be deallocated calling MEM_free on all of the members individually and on the container also.

MFGBVR_API int MFG_getLDRepresentation	(	tag_t	line,
		char **	ld_concat
	)

Parameters

line	(I)
ld_concat	(O)

MFGBVR_API int MFG_request_remote_export	(	int	n_objects,
		const tag_t *	objects,
		int	n_sites,
		const tag_t *	sites,
		const char *	reason,
		tag_t	option_set,
		int	n_options,
		const char **	option_names,
		const char **	option_values,
		int	n_session_options,
		const char **	session_option_names,
		const char **	session_option_values,
		int	priority,
		logical	email_notification,
		int	n_email_addrs,
		char **	email_addrs,
		int *	n_msg_ids,
		char ***	msg_ids
	)

Exports objects to Briefcase. If the exported object is a Collaboration Context (CC), an Appearance Path Node (APN) is also created for the identified BOMLine objects in the CC.
The BOMLine objects are identified based on the preference MERuleForBriefcaseExport.

Returns

ITK_ok on success.
GMS_zero_target_sites if n_sites is 0.
GMS_invalid_target_site if any site in sites is invalid (NULLTAG).
GMS_nothing_to_process if any object in objects is invalid (NULLTAG).

Parameters

n_objects	(I) Number of objects to be exported.
objects	(I) n_objects Objects to be exported.
n_sites	(I) Number of sites to which objects are to be exported.
sites	(I) n_sites Sites to which objects are to be exported.
reason	(I) Reason for the export. This can be a null pointer.
option_set	(I) The object of type "TransferOptionSet".
n_options	(I) Number of transfer options whose values need to different than in "TransferOptionSet".
option_names	(I) n_options Options whose values need to different than in "TransferOptionSet". Some of the values are: opt_do_struct (true/false) opt_rev_select (latestRevisionOnly/allReleasedRevisionsOnly/ etc) opt_entire_bom (true/false) For the extensive list, please refer to the documentation of the PLM XML Export Import administration tool.
option_values	(I) n_options Overridden Values.
n_session_options	(I) Number of session options.
session_option_names	(I) n_session_options Session options. Some of the values are: modified_objects_only (True/False) continue_on_error (True/False) dry_run (True/False) offline (True/False) transfer_site_ownership (True/False) For the extensive list, please refer to the documentation of the PLM XML Export Import administration tool.
session_option_values	(I) n_session_options Values of session options.
priority	(I) Can assume value either -2 or -1
email_notification	(I) Should sent email or not.
n_email_addrs	(I) Number of email recipients.
email_addrs	(I) n_email_addrs Email addresses.
n_msg_ids	(O) Number of messages.
msg_ids	(OF) n_msg_ids Messages. The array is not packed, which means that the memory is to be deallocated calling MEM_free on all of the members individually and on the container also.

MFGBVR_API int MFG_search_lines_in_context	(	tag_t	top_line,
		const char *	logical_pos,
		const char *	usage_address,
		int	op,
		tag_t **	found_lines,
		int *	size
	)

Parameters

logical_pos	(I) The top line of the window
usage_address	(I) The value of logical position
op	(I) The value of the usage address
found_lines	(I) The operator
size	(O) The lines that are found in the search (O) The number of the lines found in the search

Functions

Detailed Description

Function Documentation