#include <tc/tc_startup.h>
#include <cm/cm_errors.h>
#include <cm/libcm_exports.h>
#include <cm/libcm_undef.h>

Data Structures
struct	AttributeNameValueList

struct	CM_note_change_info_s

struct	RelationshipDataList

Typedefs
typedef enum AddType	AddType_t

typedef struct AttributeNameValueList	AttributeNameValueList_lst

typedef enum CM_bom_change_type_e	CM_bom_change_type_t

typedef struct CM_note_change_info_s	CM_note_change_info_t

typedef struct RelationshipDataList	RelationshipDataList_lst

Enumerations
enum	AddType { ADD = 0, REMOVE }

enum	CM_bom_change_type_e { CMBOM_unknown = 0, CMBOM_Add, CMBOM_Cancel, CMBOM_Quantity_Change, CMBOM_Move, CMBOM_Reshape, CMBOM_Note_Change, CMBOM_Variant_Change, CMLBOM_Add, CMLBOM_Cancel, CMLBOM_Quantity_Change }

Functions
CM_API int	CM_ask_impacted_items_for_change_item_revision (tag_t change_rev_tag, int n_items, tag_t *items)

CM_API int	CM_ask_solution_items_for_change_item_revision (tag_t change_rev_tag, int n_items, tag_t *items)

CM_API void	CM_free_notechange_info_struct (CM_note_change_info_t info)

CM_API int	CM_get_bomedits (tag_t chngRevTag, tag_t affected_bvr, CM_bom_change_type_t bomch_type, int num_of_bomch, tag_t *bomch_tags)

CM_API int	CM_get_note_change_details (tag_t note_change_tag, CM_note_change_info_t *notechange_details)

CM_API int	CM_get_occurrence_of_bomedit (tag_t bomch_tag, tag_t *occ_tag)

CM_API int	CM_get_prev_bvr (tag_t chngRevTag, tag_t bvr_tag, tag_t *prev_bvr_tag)

CM_API int	CM_get_relations_to_propagate (tag_t source_object_tag, int number_of_relations, char *relations_to_propagate, logical propagation_enabled)

CM_API int	CM_save_BOMEdits (tag_t chngRevTag, tag_t bomWindow, tag_t probBomWindow, int num_of_bom_tags, tag_t *bomchanges)

Typedef Documentation

typedef enum AddType AddType_t

Enumeration for identifying add or remove operation

typedef struct AttributeNameValueList AttributeNameValueList_lst

Structure for Update input attribute name value pair.

typedef enum CM_bom_change_type_e CM_bom_change_type_t

Structure for tracking the BomChanges

typedef struct CM_note_change_info_s CM_note_change_info_t

Structure for Note Changes tracking

typedef struct RelationshipDataList RelationshipDataList_lst

Structure for Update input relationship data.

Enumeration Type Documentation

enum AddType

Enumeration for identifying add or remove operation

Enumerator
ADD
REMOVE

Definition at line 36 of file cm.h.

enum CM_bom_change_type_e

Structure for tracking the BomChanges

Enumerator
CMBOM_unknown	BOM change of other type.
CMBOM_Add	BOM change of Add type.
CMBOM_Cancel	BOM change of Cancel type.
CMBOM_Quantity_Change	BOM Quantity change type.
CMBOM_Move	BOM change of type Move.
CMBOM_Reshape	BOM change of Reshape type.
CMBOM_Note_Change	BOM change of Note type.
CMBOM_Variant_Change	BOM variant change type.
CMLBOM_Add	LBOM change of Add type.
CMLBOM_Cancel	LBOM change of Cancel type.
CMLBOM_Quantity_Change	LBOM change of Quantity type.

Definition at line 63 of file cm.h.

Function Documentation

CM_API int CM_ask_impacted_items_for_change_item_revision	(	tag_t	change_rev_tag,
		int *	n_items,
		tag_t **	items
	)

Retrieves all impacted revisions of the given ChangeItemRevision

Returns

ITK_ok on success
TYPE_invalid_type_name if impacted type is not found.

Parameters

change_rev_tag	(I) The ChangeItemRevision tag
n_items	(O) The number of impacted items
items	(OF) n_items The array of impacted items

CM_API int CM_ask_solution_items_for_change_item_revision	(	tag_t	change_rev_tag,
		int *	n_items,
		tag_t **	items
	)

Retrieves all solution revisions of the given ChangeItemRevision

Returns

ITK_ok on success
TYPE_invalid_type_name if solution type is not found.

Parameters

change_rev_tag	(I) The ChangeItemRevision tag
n_items	(O) The number of solution items
items	(OF) n_items The array of solution items

CM_API void CM_free_notechange_info_struct ( CM_note_change_info_t info )

This ITK can be used to free memory of all members of CM_note_change_info_t structure

Parameters

info	(I) Note Change Info to be freed

CM_API int CM_get_bomedits	(	tag_t	chngRevTag,
		tag_t	affected_bvr,
		CM_bom_change_type_t	bomch_type,
		int *	num_of_bomch,
		tag_t **	bomch_tags
	)

This API returns all BomChange objects of a specified type for the specified affected assembly and Change Revision combination. The output also includes all derived BomChange objects. Currently there are three supported types: BOM_Add, BOM_Cancel and BOM_Quantity_Change.

Parameters

chngRevTag	(I) Change Revision tag
affected_bvr	(I) Affected assembly tag
bomch_type	(I) Type of BOMEdit requested
num_of_bomch	(O) The number of BOMEdit objects found
bomch_tags	(OF) num_of_bomch The array of BOMEdit tags found

CM_API int CM_get_note_change_details	(	tag_t	note_change_tag,
		CM_note_change_info_t *	notechange_details
	)

This method will return the note change details for the input Note Change object. Information includes the list of changed note types, their values in impacted and solution assembly. Form field related members of the output structure wouldn�t be filled as output of this ITK method. They are reserved for future use.

Restrictions:

If input BOMEdit object is not an solution side BOMEdit, this ITK will return an error code

Parameters

note_change_tag	(I) Note Change Tag
notechange_details	(O) Output structure of type CM_note_change_info_t

CM_API int CM_get_occurrence_of_bomedit	(	tag_t	bomch_tag,
		tag_t *	occ_tag
	)

This function returns the Occurrence object associated with the given BOMEdit object.

Parameters

bomch_tag	(I) Tag of the BomEdit object
occ_tag	(O) Occurrence tag

CM_API int CM_get_prev_bvr	(	tag_t	chngRevTag,
		tag_t	bvr_tag,
		tag_t *	prev_bvr_tag
	)

This API returns the problem assembly of the given impacted assembly with the context of the given change Revision. The relationship is obtained using the internal affected to problem relationship between the corresponding impacted Revision and its related problem revision.

Parameters

chngRevTag	(I) Change Revision tag
bvr_tag	(I) Tag of impacted assembly
prev_bvr_tag	(O) Tag of problem assembly

CM_API int CM_get_relations_to_propagate	(	tag_t	source_object_tag,
		int *	number_of_relations,
		char ***	relations_to_propagate,
		logical *	propagation_enabled
	)

Retrieves all the relations to propagate from source objects to derived objects.

The propagation is based on the source object type and the value of the preference "CM_automate_derive_propagation" for a derive change operation.
If the value of the preference is true, this ITK will return all the relations specified as the value of a preference "CM_<SourceObjectType>_Relations_To_Propagate", where <SourceObjectType> is the type name of the object pointed by the parameter source_object_tag.

Returns

ITK_ok on success.
PF_NOTFOUND if the preference "CM_automate_derive_propagation" is not set.

Parameters

source_object_tag	(I) The tag of the source object
number_of_relations	(O) Number of relations to propagate
relations_to_propagate	(OF) number_of_relations Array of relation names. The array is packed, which means that the memory is to be deallocated by calling MEM_free on the container. This will also deallocate the memory for its elements.
propagation_enabled	(O) Returns true if propagation is enabled by preference

CM_API int CM_save_BOMEdits	(	tag_t	chngRevTag,
		tag_t	bomWindow,
		tag_t	probBomWindow,
		int *	num_of_bom_tags,
		tag_t **	bomchanges
	)

This API saves a BOMEdit

Parameters

chngRevTag	(I) Tag of the Change Object
bomWindow	(I) Tag of solution BOMWindow
probBomWindow	(I) Tag of impacted BOMWindow
num_of_bom_tags	(O) No of bomedit
bomchanges	(OF) num_of_bom_tags Tags of bomedit

Data Structures

Typedefs

Enumerations

Functions

Typedef Documentation

Enumeration Type Documentation

Function Documentation