|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
Modules | |
| ME Errors | |
| ME messages | |
| BOP Line Functions | |
Data Structures | |
| struct | ME_mfg_search_criteria_s |
| struct | ME_occurrence_note_expression_s |
| struct | ME_saved_query_expression_s |
| struct | ME_search_expression_set_s |
ME related | |
| #define | ME_meprocess_class_name_c "MEProcess" |
| #define | ME_meop_class_name_c "MEOP" |
| #define | ME_meprocess_rev_class_name_c "MEProcessRevision" |
| #define | ME_meop_rev_class_name_c "MEOPRevision" |
| #define | ME_activity_class_name_c "MEActivity" |
| #define | ME_meworkarea_class_name_c "MEWorkarea" |
| #define | ME_meworkarea_rev_class_name_c "MEWorkareaRevision" |
| #define | ME_meappearancepathnode_class_name_c "MEAppearancePathNode" |
| #define | ME_meappearancepathroot_class_name_c "MEAppearancePathRoot" |
| #define | ME_placeholder_item_id_c "MEAppGroupPlaceholder" |
| #define | ME_placeholder_item_id_c "MEAppGroupPlaceholder" |
| #define | ME_appearance_group_class_name_c "AppearanceGroup" |
| #define | ME_component_relation_class_name_c "ComponentRelation" |
base view ref window | |
| #define | ME_base_view_ref_window_name_c "viewBaseWindow" |
activity description size | |
| #define | ME_activity_desc_size_c 240 |
Flags to control action on a released Manufacturing BOM (MBOM) node while creating/updating from Engineering BOM (EBOM) | |
| #define | ME_SKIP_RELEASED_NODE 1 |
| #define | ME_REVISE_ON_RELEASE 2 |
| #define | ME_UPDATE_PROP_ON_SELF_ON_RELEASE 3 |
| #define | ME_UPDATE_PROP_ON_SELF_AND_BELOW_ON_RELEASE 4 |
ME Setup Functions | |
| ME_API int | ME_init_module () |
| ME_API int | MEBOM_init_module () |
ME Revisable Objects | |
| ME_API int | ME_create_process (const char *id, const char *revid, const char *type, const char *name, const char *desc, tag_t *newProc) |
| ME_API int | ME_create_processrevision (const char *id, const char *revid, tag_t *newProcRev) |
| ME_API int | ME_create_operation (const char *id, const char *revid, const char *type, const char *name, const char *desc, tag_t *newProcOp) |
| ME_API int | ME_create_operationrevision (const char *id, const char *revid, tag_t *newProcOpRev) |
| ME_API int | ME_create_workarea (const char *id, const char *revid, const char *type, const char *name, const char *desc, tag_t *newWrkarea) |
| ME_API int | ME_create_workarearevision (const char *id, const char *revid, tag_t *newWrkAreaRev) |
ME Activity Creation and Management | |
| ME_API int | ME_create_activity (const char *name, const char *type, const char *desc, double time, tag_t *newAct) |
| ME_API int | ME_create_activity_with_list (const char *name, const char *type, const char *desc, double time, int numPred, const tag_t *predList, tag_t *newAct) |
| ME_API int | ME_activity_add_predecessor (tag_t succ, tag_t pred) |
| ME_API int | ME_activity_remove_predecessor (tag_t succ, tag_t pred) |
| ME_API int | ME_activity_list_predecessors (tag_t succ, int *nPred, tag_t **pred) |
| ME_API int | ME_activity_list_activities (tag_t acttag, int *nAct, tag_t **listtags) |
| ME_API int | ME_activity_add_tool (tag_t acttag, const char *toolName) |
| ME_API int | ME_activity_add_reference_tool (tag_t acttag, const char *toolName, tag_t resLineTag, tag_t opLineTag) |
| ME_API int | ME_activity_remove_tool (tag_t acttag, const char *toolName) |
| ME_API int | ME_activity_ask_toollist (tag_t acttag, int *nTool, char ***toolList) |
| ME_API int | ME_activity_list_successors (tag_t predTag, int *nSucc, tag_t **succTags) |
| ME_API int | ME_activity_list_activity_children (tag_t activityTag, int *nChild, tag_t **actChildTags) |
| ME_API int | ME_activity_list_all_children (tag_t activityTag, int *nChild, tag_t **actChildTags) |
| ME_API int | ME_activity_insert_tags (tag_t parentTag, int nChild, const tag_t *childTags) |
| ME_API int | ME_activity_ask_description (tag_t activityTag, char actDesc[ME_activity_desc_size_c+1]) |
| ME_API int | ME_activity_ask_description2 (tag_t activityTag, char **actDesc) |
| ME_API int | ME_activity_set_description (tag_t activityTag, const char new_description[ME_activity_desc_size_c+1]) |
| ME_API int | ME_activity_set_description2 (tag_t activityTag, const char *new_description) |
| ME_API int | ME_Time_Analysis_Rollup (tag_t node, int *nValues, double **timeAnalysisValues, double *tWork, double *tDuration) |
| ME_API int | ME_Calculate_Allocated_Time (tag_t node, const char *calculatedBy, double *allocated_time) |
Template Cloning | |
| ME_API int | ME_copy_recursively (tag_t WSO_to_copy, tag_t configuring_BOM_window, const char *copy_rules_key, const char *name, const char *description, tag_t *new_WSO) |
| ME_API int | ME_create_process_from_template (const char *id, const char *revid, const char *name, const char *desc, tag_t templateProc, tag_t revisionRule, tag_t bopWindow, const char *cloneRuleKey, tag_t *newProc) |
| ME_API int | ME_create_plant_from_template (const char *id, const char *revid, const char *name, const char *desc, tag_t templatePlantRev, tag_t revisionRule, tag_t workingWinTag, const char *cloneRuleKey, tag_t *newPlant) |
| ME_API int | ME_create_product_from_template (const char *id, const char *revid, const char *name, const char *desc, tag_t templateProdRev, tag_t revisionRule, tag_t workingWinTag, const char *cloneRuleKey, tag_t *newProd) |
Attachments Related | |
| ME_API int | ME_create_assembly_window (tag_t revRule, tag_t sourceBomWin, tag_t *assyWindow) |
| ME_API int | ME_create_attachment_window (tag_t revRule, tag_t sourceBomWin, tag_t *attachWindow) |
| ME_API int | ME_window_create_root_line (tag_t win, tag_t root, tag_t *root_line) |
| ME_API int | ME_window_set_effectivity (tag_t window, date_t date, int unit_no, tag_t end_item) |
| ME_API int | ME_window_show_incremental_changes (tag_t window) |
| ME_API int | ME_window_hide_incremental_changes (tag_t window) |
| ME_API int | ME_line_ask_child_lines (tag_t line, int *count, tag_t **child_lines) |
| ME_API int | ME_line_ask_descendant_lines (tag_t line, int *count, tag_t **desc_lines) |
| ME_API int | ME_window_place_object (tag_t window, tag_t key, tag_t *line) |
| ME_API int | ME_window_place_all_instances (tag_t window, tag_t key, int *count, tag_t **lines) |
| ME_API int | ME_window_place_instances_with_absoccid (tag_t assyWindow, const char *ID, int *count, tag_t **lines) |
| ME_API int | ME_window_close (tag_t window) |
| ME_API int | ME_window_configure_variants (tag_t win) |
| ME_API int | ME_window_show_variants (tag_t win) |
| ME_API int | ME_window_hide_variants (tag_t win) |
| ME_API int | ME_line_add_Activity_with_predecessor (tag_t line, tag_t object, const char *rel_type, tag_t *child) |
| ME_API int | ME_line_add (tag_t line, tag_t object, const char *rel_type, tag_t *child) |
| ME_API int | ME_line_remove (tag_t parent, tag_t child) |
| ME_API int | ME_attachment_line_delete (tag_t parent, tag_t child) |
| ME_API int | ME_attachment_line_change (tag_t line, tag_t *new_wso) |
| ME_API int | ME_line_reparent (tag_t child, tag_t new_parent) |
| ME_API int | ME_line_remove_incremental_changes (tag_t line, int n, tag_t *ices) |
| ME_API int | ME_activity_remove_res_line (tag_t acttag, tag_t resTag) |
| ME_API int | ME_window_hide_assigned_occurrences (tag_t bopWin) |
| ME_API int | ME_window_show_assigned_occurrences (tag_t bopWin) |
BOP/BOS Window Related | |
| ME_API int | ME_create_bop_window (tag_t *window) |
| ME_API int | ME_bop_window_add_ref_window (tag_t bopWindow, tag_t refWindow, char *winType) |
| ME_API int | ME_bopwindow_add_control_occtype (tag_t bopWinTag, char *occType) |
| ME_API int | ME_bopwindow_remove_control_occtype (tag_t bopWinTag, char *occType) |
| ME_API int | ME_bom_window_has_ref_bop_window (tag_t bomWindow, int *count, tag_t **refBopWindows) |
| ME_API int | ME_close_bop_window (tag_t window) |
| ME_API int | ME_create_bos_window (tag_t rev_rule, tag_t *window) |
| ME_API int | ME_set_bos_window_source (tag_t window, tag_t src_line, tag_t *top_line) |
| ME_API int | ME_close_bos_window (tag_t window) |
| ME_API int | ME_process_balancing (tag_t srcWin, tag_t *srcLines, int num_srcLines, tag_t tarWin, tag_t *tarLines, int num_tarLines, char *resultName, char *resultDesc, int options, tag_t assyCtxtLineTag, tag_t bomCtxtLineTag, tag_t *resultView) |
| ME_API int | ME_get_source_or_target_line (tag_t lineTag, tag_t winTag, logical *isTarget, tag_t *outLineTag) |
TCM XML Related - may have been replaced by PLMXML!!! | |
| ME_API int | TCMXML_export_plmxml (tag_t *selectedComps, int nComps, const char *applicationKey, const char *fileName) |
| ME_API int | TCMXML_import_plmxml (const char *filePath, const char *applicationType, tag_t icComponent, tag_t *endItem, int *viewsCount, tag_t **views, int *errorStatus) |
ME NX Object Related | |
| ME_API int | ME_create_nx_object (const char *name, const char *desc, const char *type, const char *subType, int n_int, int *intList, int n_double, double *doubleList, int n_string, char **stringList, char **intKeyList, char **doubleKeyList, char **stringKeyList, tag_t *newObjTag) |
| ME_API int | ME_nx_object_read_data (tag_t theTag, char **resource_desc, int *numIntAtts, int **intAtts, int *numDoubleAtts, double **doubleAtts, int *numStringAtts, char ***stringAttrs, char ***intKeyIds, char ***doubleKeyIds, char ***stringKeyIds) |
| ME_API int | ME_nx_object_modify_data (tag_t nxObjTag, const char *desc, int n_int, int *intList, int n_double, double *doubleList, int n_string, char **stringList, char **intKeyList, char **doubleKeyList, char **stringKeyList) |
| ME_API int | MENXOBJECT_type_create (const char *meobj_class_name, const char *meobj_type_name, const char *def_class_name, int cardinality, int numOfViewAllowableTypes, tag_t *allowableViewTypes, tag_t *meobj_type_tag) |
| ME_API int | MENXOBJECT_type_delete (tag_t meobj_type_tag) |
IPA - InProcess Assembly Tree Related | |
| ME_API int | ME_genrateIPATree (tag_t bopWindow, char *ipaName, char *occGrpType, int count_selectedProcessTypes, char **selectedProcessTypes, int count_selectedConsumptionOcc, char **selectedConsumptionOcc, char *attachmentName, logical isLogFileNeeded, int count_ToReceivers, char **ToReceivers, int count_CCReceivers, char **CCReceivers, char *MailSubject, char *MailMessage, tag_t EffectivityEndItem, tag_t EffectivityEndRev, char *EffUnitRange, char *EffDateRange, tag_t *prdctWinAPR) |
| ME_API int | ME_updateIPATree (tag_t bopWindow) |
| ME_API int | ME_localupdateIPATree (tag_t bopLine) |
| ME_API int | ME_cleanIPATree (tag_t bopWindow, tag_t *prdctWinAPR) |
| ME_API int | ME_isIPAExists (tag_t bopWindow, logical *isNeeded) |
| ME_API int | ME_generateSearchScope (tag_t *processes, int processes_size, tag_t **bomlines, int *bomlines_size) |
| ME_API int | ME_saveSearchResult (tag_t process, tag_t *search_result_list, int search_result_size, char *name, tag_t *filteredIPA, tag_t *filteredIPARoot, tag_t **rejected_list, int *rejected_list_size) |
| ME_API int | ME_getFilteredIPA (tag_t process_line, tag_t *filterIPA) |
| ME_API int | ME_deleteFilteredIPA (tag_t *process_lines, int noOfLines) |
Find Checked outs in structure | |
| ME_API int | ME_find_checked_outs_in_structure (tag_t *lines, int lines_size, int *size, tag_t **list) |
| ME_API int | ME_checkout_for_PS (tag_t TargetLine, logical coProcess, logical isRecursive, char *changeIdChar, char *commentChar) |
| ME_API int | ME_checkin_for_PS (tag_t TargetLine) |
Find Connected MFGs with part(bomline) in product structure | |
| typedef ME_API struct ME_saved_query_expression_s | ME_saved_query_expression_t |
| typedef ME_API struct ME_occurrence_note_expression_s | ME_occurrence_note_expression_t |
| typedef ME_API struct ME_search_expression_set_s | ME_search_expression_set_t |
| typedef ME_API struct ME_mfg_search_criteria_s | ME_mfg_search_criteria_t |
| ME_API int | ME_get_connected_mfgs_from_part (tag_t part, int *nMfgs, tag_t **mfgs) |
| ME_API int | ME_get_connected_mfgs_from_parts (tag_t *parts, int nPartCnt, tag_t **mfgs, int *nMfgCnt) |
| ME_API int | ME_find_node_in_context (tag_t context, tag_t node, logical byIdOnly, logical allContexts, tag_t inContextLine, tag_t **found_lines, int *found_lines_size) |
| ME_API int | ME_find_node_in_context_by_relation (tag_t context, tag_t node, logical byIdOnly, logical allContexts, tag_t inContextLine, const char *relationName, int relationDirection, int relationDepth, tag_t **found_lines, int *found_lines_size) |
| ME_API int | ME_set_bomline_prop_based_on (tag_t item_tag, tag_t revrule_tag, tag_t sc_tag, const char *closure_rule, const char *scope_id_in_context, const char *scope_id, const char *preference, logical force_update, const char *dry_run_file) |
| ME_API int | ME_execute_structure_search (int num_scope_tags, const tag_t *scope_tags, const ME_search_expression_set_t *search_expression, const ME_mfg_search_criteria_t *mfg_search_criteria, int *num_bom_lines, tag_t **bom_lines) |
| ME_API int | ME_get_occurrence_group_views (tag_t base_view_window, int *number_of_views, tag_t **og_views) |
| ME_API int | ME_get_base_view (tag_t og_view, tag_t *base_view) |
| ME_API int | ME_create_mbom_from_ebom (tag_t ebom_root, const char *rev_rule, tag_t mbom_rev_rule, int depth, int action_on_release, const char *opaque_data, const char *log_file, tag_t *mbom_root) |
| ME_API int | ME_update_mbom_from_ebom (tag_t ebom_root, const char *rev_rule, tag_t ebom_scope_object, const char *ebom_idic, tag_t mbom_root, tag_t mbom_rev_rule, int depth, int action_on_release, const char *user_data, const char *log_file, tag_t *mbom_node) |
| ME_API int | ME_paste_duplicate_structure (const int num_src_objects, const tag_t *src_objects, const tag_t target_line, const char *copy_rules_key, int *num_new_child_lines, tag_t **new_child_lines) |
| #define ME_meappearancepathnode_class_name_c "MEAppearancePathNode" |
| #define ME_meappearancepathroot_class_name_c "MEAppearancePathRoot" |
| #define ME_melogical_designator_type_name_c "Mfg0MELogicalDesignatorRel" |
| #define ME_meproductlocation_rev_type_name_c "MEProductLocationRevision" |
| #define ME_REVISE_ON_RELEASE 2 |
| #define ME_SKIP_RELEASED_NODE 1 |
| #define ME_UPDATE_PROP_ON_SELF_AND_BELOW_ON_RELEASE 4 |
| #define ME_UPDATE_PROP_ON_SELF_ON_RELEASE 3 |
| #define Usage_compareResultView_type_name_c "UsageCompareResultView" |
| typedef ME_API struct ME_mfg_search_criteria_s ME_mfg_search_criteria_t |
| typedef ME_API struct ME_occurrence_note_expression_s ME_occurrence_note_expression_t |
| typedef ME_API struct ME_saved_query_expression_s ME_saved_query_expression_t |
| typedef ME_API struct ME_search_expression_set_s ME_search_expression_set_t |
Adds activity "pred" as a predecessor activity to an activity "succ". Restrictions:
It will not allow adding same activity twice. It will also not allow creation of cyclic relationships.
| succ | (I) Successor activity |
| pred | (I) Predecessor activity |
| ME_API int ME_activity_add_reference_tool | ( | tag_t | acttag, |
| const char * | toolName, | ||
| tag_t | resLineTag, | ||
| tag_t | opLineTag | ||
| ) |
Adds a tool that is used by the activity and defined by resLine
| acttag | (I) Activity to which reference tool needs to be added |
| toolName | (I) Name of the tool |
| resLineTag | (I) Tag to resouce bom line |
| opLineTag | (I) Tag to activity's parent operation bom line |
| ME_API int ME_activity_add_tool | ( | tag_t | acttag, |
| const char * | toolName | ||
| ) |
Adds a tool that is used by the activity.
| acttag | (I) Activity for which tool needs to be added |
| toolName | (I) Tool name |
| ME_API int ME_activity_ask_description | ( | tag_t | activityTag, |
| char | actDesc[ME_activity_desc_size_c+1] | ||
| ) |
This routine will ask the long description of an activity.
| activityTag | (I) Input activity |
| actDesc | (O) Description of the object |
| ME_API int ME_activity_ask_description2 | ( | tag_t | activityTag, |
| char ** | actDesc | ||
| ) |
This routine will ask the long description of an activity.
| activityTag | (I) Input activity |
| actDesc | (OF) Description of the object |
| ME_API int ME_activity_ask_toollist | ( | tag_t | acttag, |
| int * | nTool, | ||
| char *** | toolList | ||
| ) |
Lists all tools used by the activity.
| acttag | (I) Activity for which list of tools is needed |
| nTool | (O) Number of tools used by activity |
| toolList | (OF) Array of tool names used by this activity |
This routine will insert the child tags to parent tag. If the child tag is an activity, the system will make a new copy and insert to the parentTag. If the child tag is not not an activity, then the system will insert the input tag only
| parentTag | (I) Input activity |
| nChild | (O) Number of children to be inserted |
| childTags | (OF) Array of children to be inserted |
Lists all leaf level activities for a given activity. Activities can contain other activities as its children creating a tree of activities. This API will start at the activity supplied and traverse to all leaf (activities without children) level and output all of them in listtags. The memory for the array holding listtags will need to be freed.
| acttag | (I) Activity for which leaf level activities are needed |
| nAct | (I) Number of activities |
| listtags | (I) List of tags to leaf level activities |
| ME_API int ME_activity_list_activity_children | ( | tag_t | activityTag, |
| int * | nChild, | ||
| tag_t ** | actChildTags | ||
| ) |
This routine lists immediate child activities of a given parent activity. The memory for the output array "actChildTags" needs to be freed by the caller.
| activityTag | (I) Input activity |
| nChild | (O) Number of immediate children found |
| actChildTags | (OF) Array of immediate children for input |
This routine lists child activities below given activity including all level below it and its immediate children. The memory for actChildTags needs to be freed by the caller.
| activityTag | (I) Input activity |
| nChild | (O) Number of child activities below input activity |
| actChildTags | (OF) Array of child activities below input activity |
Lists predecessor activities for a given activity. The list can be empty if no predecessors are defined. Please note the memory allocated for an array returning preds will have to be freed by the caller.
| succ | (I) Activity whose predecessors are needed |
| nPred | (O) Number of predecessors found |
| pred | (OF) Array of nPred predecessors |
Lists successor activities for a given activity. The list can be empty. Please note the memory allocated for an array returning succTags will have to be freed by the caller.
| predTag | (I) Input activity |
| nSucc | (O) Number of successors |
| succTags | (OF) Array of successor activities to input activity |
Removes activity "pred" from predecessor activities of an activity "succ".
| succ | (I) Successor activity |
| pred | (I) Predecessor activity |
Remove a resource line from an activity.
Restrictions:
If the line is not a resource line in the activty nothing is done. The input should be a valid bomline tag It will return an error if this is not a valid line or if i can't remove the resource line or if i can't lock the activity.
| acttag | (I) Tag of an activity |
| resTag | (I) Tag of the resource bomline we like to remove |
| ME_API int ME_activity_remove_tool | ( | tag_t | acttag, |
| const char * | toolName | ||
| ) |
Removes a tool that is used by the activity.
| acttag | (I) Activity for which tool needs to be removed |
| toolName | (I) Name of the tool |
| ME_API int ME_activity_set_description | ( | tag_t | activityTag, |
| const char | new_description[ME_activity_desc_size_c+1] | ||
| ) |
This routine will set the long description of an activity.
| activityTag | (I) Input activity |
| new_description | (I) Description of activity |
| ME_API int ME_activity_set_description2 | ( | tag_t | activityTag, |
| const char * | new_description | ||
| ) |
This routine will set the long description of an activity.
| activityTag | (I) Input activity |
| new_description | (I) Description of activity |
Makes a copy of the workspace object that the line is representing, and groups the changes related to a workspace object together.
Restrictions:
Make sure you are in incremental change context.
| line | (I) Attachment line which needs to be changed |
| new_wso | (O) Tag of the new workspace object |
Deletes a child attachment line from a parent attachment line. It also deletes underlying workspace object, which the line is representing.
Restrictions:
This call is valid only for children of attachment line.
| parent | (I) Attachment line whose child needs to be deleted |
| child | (I) Attachment line which needs to be deleted |
| ME_API int ME_bom_window_has_ref_bop_window | ( | tag_t | bomWindow, |
| int * | count, | ||
| tag_t ** | refBopWindows | ||
| ) |
This function take a BOMWindow tag (Product Window)and find out the array of BOPWindow's tags (Process Windows),which have a reference to this BOMWindow.
| bomWindow | (I) Tag of a BOMwindow |
| refBopWindows | (O) Number of refernced BOPWindows(O) Tags of all the BOPWindows reference to the BOMWindow |
Add reference window to BOPWindow - reference windows are needed for configuring items that are consumed or referenced in a compostion loaded in a BOP window. The reference window contains BOM from which components were assigned to composition or process (e.g. product is reference for a process loaded in a BOPWindow).
| bopWindow | (I) input bopwindow |
| refWindow | (I) reference window with referenced bom |
| winType | (I) window type |
| ME_API int ME_bopwindow_add_control_occtype | ( | tag_t | bopWinTag, |
| char * | occType | ||
| ) |
Add an occurrence type as a controlling type to a bopwindow. The occType added here will be used by BOPWindow in configuring the parent operations out.
Usage - ME_bopwindow_add_control_occtype(bp_tag, "MEConsumed") - will add MEConsumed as a controlling occ for this BOPWindow. Therefore operations with consumed items will be configured out if the consumed item is configured out from its respective product definition.
Restrictions:
It will return an error if a type that is not defined in the database is used as second parameter.
Caution - Do not add same type more than once. E.g.If you add MEConsumed twice, you will need to remove it twice.
| bopWinTag | (I) Tag of a bopwindow |
| occType | (I) Occurrence Type |
| ME_API int ME_bopwindow_remove_control_occtype | ( | tag_t | bopWinTag, |
| char * | occType | ||
| ) |
Remove an occurrence type as a controlling type from a bopwindow.
Usage - ME_bopwindow_remove_control_occtype(bp_tag, "MEConsumed") - will remove MEConsumed from a bopwindow as a controlling occ. Therefore operations with consumed items will not be configured out if the consumed item is configured out from its respective product definition.
Restrictions: It will return an error if a type that is not defined in the database is used as second parameter.
| bopWinTag | (I) Tag of a bopwindow |
| occType | (I) Occurrence Type |
| ME_API int ME_Calculate_Allocated_Time | ( | tag_t | node, |
| const char * | calculatedBy, | ||
| double * | allocated_time | ||
| ) |
This routine will get the time analysis results for the sub tree activities
| node | (I) |
| calculatedBy | (I) |
| allocated_time | (O) |
| ME_API int ME_checkin_for_PS | ( | tag_t | TargetLine | ) |
| ME_API int ME_checkout_for_PS | ( | tag_t | TargetLine, |
| logical | coProcess, | ||
| logical | isRecursive, | ||
| char * | changeIdChar, | ||
| char * | commentChar | ||
| ) |
Delete the IPA tree
Restrictions: It will return an error if this is not a valid window, or other internal errors during deletion
| prdctWinAPR | (I) Tag of the window where the configured process structure contains the IPA tree we want to delete (O) Returns null if there is not open BOMWindow for the consumed products otherwise it return the APR of the consumed product BOMWindow |
| ME_API int ME_close_bop_window | ( | tag_t | window | ) |
Close BOP Window
| window | (I) input bopwindow |
| ME_API int ME_close_bos_window | ( | tag_t | window | ) |
Close the window - not used anymore
| window | (I) |
| ME_API int ME_copy_recursively | ( | tag_t | WSO_to_copy, |
| tag_t | configuring_BOM_window, | ||
| const char * | copy_rules_key, | ||
| const char * | name, | ||
| const char * | description, | ||
| tag_t * | new_WSO | ||
| ) |
Performs a clone operation on the specified workspace object
| WSO_to_copy | (I) Tag of the workspace object to clone |
| configuring_BOM_window | (I) BOM window tag to determine which revision to clone |
| copy_rules_key | (I) Rule key from the preferences which controls cloning operation |
| name | (I) Name of the newly cloned workspace object |
| description | (I) Description of newly created object |
| new_WSO | (O) Tag of a newly created workspace object |
| ME_API int ME_create_activity | ( | const char * | name, |
| const char * | type, | ||
| const char * | desc, | ||
| double | time, | ||
| tag_t * | newAct | ||
| ) |
Creates a new Activity of a given type. The type can be empty. The default location for the activity in the Pert chart will be set to (0,0).
| name | (I) Name of the activity |
| type | (I) Type of the activity - can be empty |
| desc | (I) Description of the activity |
| time | (I) Time take for activity |
| newAct | (O) Tag to newly created activity |
| ME_API int ME_create_activity_with_list | ( | const char * | name, |
| const char * | type, | ||
| const char * | desc, | ||
| double | time, | ||
| int | numPred, | ||
| const tag_t * | predList, | ||
| tag_t * | newAct | ||
| ) |
Creates a new Activity of a given type as above. It then takes the activities that are supplied by an array of activities called predList and sets them as predecessor for the newly created activity. Restrictions:
It will not allow adding itself as a predecessor. The predList needs to be an array of tags to activities. It will not allow adding same activity twice to its predecessors.
| name | (I) Name of the activity |
| type | (I) Type of the activity - can be empty |
| desc | (I) Description of the activity |
| time | (I) Time take for activity |
| numPred | (I) Number of predecessors |
| predList | (O) Array of tags to predecessor activities |
| newAct | (O) Tag to newly created activity |
Create assembly window for browsing appearance group tree - the source bomwindow is the window consisting of a bom with appearance group's base view.
| revRule | (I) Revision Rule for the window |
| sourceBomWin | (I) Source BOM Window |
| assyWindow | (O) Tag to assembly window |
Creates an attachment window. The source bomwindow is the window for which attachments will be viewed.
| revRule | (I) Revision Rule for the window |
| sourceBomWin | (I) Source BOM Window |
| attachWindow | (O) Attachment Window |
| ME_API int ME_create_bop_window | ( | tag_t * | window | ) |
Create BOP window for Process or Compositions
| window | (O) newly created BOP window |
Create BOS window – not used anymore
| rev_rule | (I) |
| window | (O) |
| ME_API int ME_create_mbom_from_ebom | ( | tag_t | ebom_root, |
| const char * | rev_rule, | ||
| tag_t | mbom_rev_rule, | ||
| int | depth, | ||
| int | action_on_release, | ||
| const char * | opaque_data, | ||
| const char * | log_file, | ||
| tag_t * | mbom_root | ||
| ) |
Creates a Manufacturing BOM (MBOM) from Engineering BOM(EBOM) based on user customizations for new MBOM item types.
Relies on the user_exit functions: USER_create_or_ref_item and USER_sync_item to be implemented to support custom behavior.
ebom_root. rev_rule. | ebom_root | (I) Can be item/revision/StructureContext. |
| rev_rule | (I) Name of revision rule. Unused if ebomRoot is StructureContext. |
| mbom_rev_rule | (I) Tag of revision rule or structure context (with configuration context having the revision rule) to be used for the mbom structure. |
| depth | (I) If supplied � create the mbom structure only upto the depth specified here. pass -1 if not used. |
| action_on_release | (I) Perform action. Valid values are:
|
| opaque_data | (I) Pass through data for any extensions registered from caller. |
| log_file | (I) Filename to write additional logs. |
| mbom_root | (O) New MBOM root tag. |
| ME_API int ME_create_nx_object | ( | const char * | name, |
| const char * | desc, | ||
| const char * | type, | ||
| const char * | subType, | ||
| int | n_int, | ||
| int * | intList, | ||
| int | n_double, | ||
| double * | doubleList, | ||
| int | n_string, | ||
| char ** | stringList, | ||
| char ** | intKeyList, | ||
| char ** | doubleKeyList, | ||
| char ** | stringKeyList, | ||
| tag_t * | newObjTag | ||
| ) |
Create a MENX object.
Restrictions: It will return an error if unable to save new MENX object
| name | (I) Name of MENX object |
| desc | (I) Description of MENX object |
| type | (I) Type of MENX object, such as MILL, DRILL, ... |
| subType | (I) Sub type MENX object, such as 5 Parameters, 7 Parameters, ... |
| n_int | (I) Count of integer parameters of MENX object |
| intList | (I) An array of integer paraemters of MENX object |
| n_double | (I) Count of double parameters of MENX object |
| doubleList | (I) An array of double parameters of MENX object |
| n_string | (I) Count of string parameters of MENX object |
| stringList | (I) An array of string parameters of MENX object |
| intKeyList | (I) An array of strings that hold integer key values of MENX object |
| doubleKeyList | (I) An array of strings that hold double key values of MENX object |
| stringKeyList | (I) An array of strings that hold string key values of MENX object |
| newObjTag | (O) Tag of the new MENX object |
| ME_API int ME_create_operation | ( | const char * | id, |
| const char * | revid, | ||
| const char * | type, | ||
| const char * | name, | ||
| const char * | desc, | ||
| tag_t * | newProcOp | ||
| ) |
Creates a new Operation of a given type. It creates a Operation and Operation Revision. Restrictions:
For a type other than null to be specified, that type must be defined by the site. If type is null, the default type is MEOP. The name will be used as the revision's name.
| id | (I) operation identification number - system will assign automatically if empty |
| revid | (I) revision id for the first rev - can be empty - automatically assigned |
| type | (I) type name - can be empty - will take default type |
| name | (I) Name of the operation |
| desc | (I) Description for new operation |
| newProcOp | (O) tag to newly created operation |
| ME_API int ME_create_operationrevision | ( | const char * | id, |
| const char * | revid, | ||
| tag_t * | newProcOpRev | ||
| ) |
Creates a new Operation revision for a given Operation. The revid can be empty. Restrictions:
The Operation for a given "id" needs to be created and saved before creating the revision for it.
| id | (I) operation identification number for which rev is created |
| revid | (I) revision id - can be empty - automatically assigned to next available |
| newProcOpRev | (O) tag for newly created operation revision |
| ME_API int ME_create_plant_from_template | ( | const char * | id, |
| const char * | revid, | ||
| const char * | name, | ||
| const char * | desc, | ||
| tag_t | templatePlantRev, | ||
| tag_t | revisionRule, | ||
| tag_t | workingWinTag, | ||
| const char * | cloneRuleKey, | ||
| tag_t * | newPlant | ||
| ) |
Clone a Plant revision recursively from input revision id
| id | (I) Optional - ID of a newly created plant |
| revid | (I) Optional - revision id of a newly created plant |
| name | (I) Name of a newly created plant |
| desc | (I) Optional - description of a newly created plant |
| templatePlantRev | (I) Tag of the plant revision to be cloned |
| revisionRule | (I) Tag of a revision rule used for cloning |
| workingWinTag | (I) Tag of a bomwindow tag to determine which revision to clone |
| cloneRuleKey | (I) Rule key from the preferences which controls cloning operation |
| newPlant | (O) Tag of newly cloned plant revision |
| ME_API int ME_create_process | ( | const char * | id, |
| const char * | revid, | ||
| const char * | type, | ||
| const char * | name, | ||
| const char * | desc, | ||
| tag_t * | newProc | ||
| ) |
Creates a new process of a given type. It creates a Process, Process Revision and BV/BVR. Restrictions:
For a type other than null to be specified, that type must be defined by the site. If type is null, the default type is MEProcess. The name will be used as the revision's name.
| id | (I) process identification number - system will assign automatically if empty |
| revid | (I) revision id for the first rev - can be empty - automatically assigned |
| type | (I) type name - can be empty - will take default type |
| name | (I) Name of the process |
| desc | (I) Description of process |
| newProc | (O) tag for newly created process |
| ME_API int ME_create_process_from_template | ( | const char * | id, |
| const char * | revid, | ||
| const char * | name, | ||
| const char * | desc, | ||
| tag_t | templateProc, | ||
| tag_t | revisionRule, | ||
| tag_t | bopWindow, | ||
| const char * | cloneRuleKey, | ||
| tag_t * | newProc | ||
| ) |
Clone a MEProcess or MEOperation revision recursively from input revision id
| id | (I) Optional - ID of a newly created process |
| revid | (I) Optional - revision id of a newly created process |
| name | (I) Name of a newly created process |
| desc | (I) Optional - description of a newly created process |
| templateProc | (I) Tag of the process revision to be cloned |
| revisionRule | (I) Tag of a revision rule used for cloning |
| bopWindow | (I) Tag of a bopwindow tag to determine which revision to clone |
| cloneRuleKey | (I) Rule key from the preferences which controls cloning operation |
| newProc | (O) Tag of newly cloned process revision |
| ME_API int ME_create_processrevision | ( | const char * | id, |
| const char * | revid, | ||
| tag_t * | newProcRev | ||
| ) |
Creates a new Process revision for a given Process. The revid can be empty. Restrictions:
The process for a given "id" needs to be created and saved before creating the revision for it.
| id | (I) process identification number for which rev is created |
| revid | (I) revision id - can be empty - automatically assigned to next available |
| newProcRev | (O) tag for newly created process revision |
| ME_API int ME_create_product_from_template | ( | const char * | id, |
| const char * | revid, | ||
| const char * | name, | ||
| const char * | desc, | ||
| tag_t | templateProdRev, | ||
| tag_t | revisionRule, | ||
| tag_t | workingWinTag, | ||
| const char * | cloneRuleKey, | ||
| tag_t * | newProd | ||
| ) |
Clone a Product revision recursively from input revision id
| id | (I) Optional - ID of a newly created product |
| revid | (I) Optional - revision id of a newly created product |
| name | (I) Name of a newly created product |
| desc | (I) Optional - description of a newly created product |
| templateProdRev | (I) Tag of the product revision to be cloned |
| revisionRule | (I) Tag of a revision rule used for cloning |
| workingWinTag | (I) Tag of a bomwindow tag to determine which revision to clone |
| cloneRuleKey | (I) Rule key from the preferences which controls cloning operation |
| newProd | (O) Tag of newly cloned product revision |
| ME_API int ME_create_workarea | ( | const char * | id, |
| const char * | revid, | ||
| const char * | type, | ||
| const char * | name, | ||
| const char * | desc, | ||
| tag_t * | newWrkarea | ||
| ) |
Creates a new WorkArea of a given type. It creates a WorkArea, WorkArea Revision and BV/BVR. Restrictions:
For a type other than null to be specified, that type must be defined by the site. If type is null, the default type is MEWorkArea. The name will be used as the revision's name.
| id | (I) workarea identification number - system will assign automatically if empty |
| revid | (I) revision id for the first rev - can be empty - automatically assigned |
| type | (I) type name - can be empty - will take default type |
| name | (I) Name of the workarea |
| desc | (I) Description of the workarea |
| newWrkarea | (O) tag for newly created workarea |
| ME_API int ME_create_workarearevision | ( | const char * | id, |
| const char * | revid, | ||
| tag_t * | newWrkAreaRev | ||
| ) |
Creates a new WorkArea revision for a given WorkArea. The revid can be empty. Restrictions:
The WorkArea for a given "id" needs to be created and saved before creating the revision for it.
| id | (I) workarea identification number for which rev is created |
| revid | (I) revision id - can be empty - automatically assigned to next available |
| newWrkAreaRev | (O) tag for newly created workarea revision |
| ME_API int ME_deleteFilteredIPA | ( | tag_t * | process_lines, |
| int | noOfLines | ||
| ) |
Deletes a filteredIPA structure under a given processes
| ME_API int ME_execute_structure_search | ( | int | num_scope_tags, |
| const tag_t * | scope_tags, | ||
| const ME_search_expression_set_t * | search_expression, | ||
| const ME_mfg_search_criteria_t * | mfg_search_criteria, | ||
| int * | num_bom_lines, | ||
| tag_t ** | bom_lines | ||
| ) |
Performs the structure search on the structure specified by the scope expression and the criteria specified by the different search expressions and provides the result BOMLines.
| num_scope_tags | (I) Number of scope BOMLine tags |
| scope_tags | (I) Scope BOMLine tags |
| search_expression | (I) Search Expression containing parameters for general search |
| mfg_search_criteria | (I) Manufacturing Search Criteria. Pass it as a null pointer for the moment. |
| num_bom_lines | (O) Number of result BOMLine array size |
| bom_lines | (OF) num_bom_lines Array of BOMLines found by the performed search |
| ME_API int ME_find_checked_outs_in_structure | ( | tag_t * | lines, |
| int | lines_size, | ||
| int * | size, | ||
| tag_t ** | list | ||
| ) |
This function will return all the checked out items for the given structures.
| lines_size | (I) Array of tags, the search scope |
| size | (I) Size of the array |
| list | (O) Array of all the checked out items (O) Number of the checked out items |
| ME_API int ME_find_node_in_context | ( | tag_t | context, |
| tag_t | node, | ||
| logical | byIdOnly, | ||
| logical | allContexts, | ||
| tag_t | inContextLine, | ||
| tag_t ** | found_lines, | ||
| int * | found_lines_size | ||
| ) |
This function finds parallel nodes in a given context for a given node, returns all the lines found and their number.
| context | (I) The context to search in |
| node | (I) The node to search |
| byIdOnly | (I) |
| allContexts | (I) |
| inContextLine | (I) |
| found_lines | (O) The lines that are found |
| found_lines_size | (O) The number of the lines found in the search |
| ME_API int ME_find_node_in_context_by_relation | ( | tag_t | context, |
| tag_t | node, | ||
| logical | byIdOnly, | ||
| logical | allContexts, | ||
| tag_t | inContextLine, | ||
| const char * | relationName, | ||
| int | relationDirection, | ||
| int | relationDepth, | ||
| tag_t ** | found_lines, | ||
| int * | found_lines_size | ||
| ) |
This function finds related nodes in a given context for a given node with the relation information, returns all the lines found and their number.
| context | (I) The context to search in |
| node | (I) The node to search |
| byIdOnly | (I) |
| allContexts | (I) |
| inContextLine | (I) |
| relationName | (I) The relation name |
| relationDirection | (I) The relation direction |
| relationDepth | (I) The relation depth |
| found_lines | (O) The lines that are found |
| found_lines_size | (O) The number of the lines found in the search |
| ME_API int ME_generateSearchScope | ( | tag_t * | processes, |
| int | processes_size, | ||
| tag_t ** | bomlines, | ||
| int * | bomlines_size | ||
| ) |
Runs over each process in the vector get its IPA the return the search scope under it.
| ME_API int ME_genrateIPATree | ( | tag_t | bopWindow, |
| char * | ipaName, | ||
| char * | occGrpType, | ||
| int | count_selectedProcessTypes, | ||
| char ** | selectedProcessTypes, | ||
| int | count_selectedConsumptionOcc, | ||
| char ** | selectedConsumptionOcc, | ||
| char * | attachmentName, | ||
| logical | isLogFileNeeded, | ||
| int | count_ToReceivers, | ||
| char ** | ToReceivers, | ||
| int | count_CCReceivers, | ||
| char ** | CCReceivers, | ||
| char * | MailSubject, | ||
| char * | MailMessage, | ||
| tag_t | EffectivityEndItem, | ||
| tag_t | EffectivityEndRev, | ||
| char * | EffUnitRange, | ||
| char * | EffDateRange, | ||
| tag_t * | prdctWinAPR | ||
| ) |
Generate an IPA tree.
Restrictions: It will return an error if this is not a valid window, or other internal errors during creation
| ipaName | (I) Tag of the process structure window we want to create an IPA for |
| occGrpType | (I) String of the IPA name(top occ group) |
| count_selectedProcessTypes | (I) String, type of IPA occ. groups |
| selectedProcessTypes | (I) Int ,count of the process types that an IPA will create for them |
| count_selectedConsumptionOcc | (I) An array of strings, that hold the different process types names |
| selectedConsumptionOcc | (I) Int, count of the consumption types that will be added to the occ. grp |
| attachmentName | (I) An array of stringsm that hold the different consumption types names |
| isLogFileNeeded | (I) String, the name of the log file |
| count_ToReceivers | (I) Bool, if to create a statistic log file |
| ToReceivers | (I) Int ,the count of the email TO recipients |
| count_CCReceivers | (I) An array of strings, the addresses of the email TO recipients |
| CCReceivers | (I) Int ,the count of the email CC recipients |
| MailSubject | (I) An array of strings, the addresses of the email CC recipients |
| MailMessage | (I) String the subject of the email |
| EffectivityEndItem | (I) String the message of the email |
| EffectivityEndRev | (I) Tag the effectivity end item |
| EffUnitRange | (I) Tag the effectivity end item revision |
| EffDateRange | (I) String ,the effectivity unit range represented as text |
| prdctWinAPR | (I) String the effectivity date represented as text (O) Returend APR tag of the top occ. grp |
Retrieves the base view for a given Occurrence Group view window.
| og_view | (I) The og view window |
| base_view | (O) The base view window |
This function will return all the connected MFGs with part(bomline) in product structure.
| part | (I) Part (BOM Line) |
| nMfgs | (O) Number of MFGs found |
| mfgs | (OF) Array of MFGs |
| ME_API int ME_get_connected_mfgs_from_parts | ( | tag_t * | parts, |
| int | nPartCnt, | ||
| tag_t ** | mfgs, | ||
| int * | nMfgCnt | ||
| ) |
This function returns all the MFGs connected to parts in the product structure
| parts | (I) Parts (BOM Lines) |
| nPartCnt | (I) Count of Parts |
| mfgs | (OF) Array of MFGs |
| nMfgCnt | (O) Number of MFGs connected |
| ME_API int ME_get_occurrence_group_views | ( | tag_t | base_view_window, |
| int * | number_of_views, | ||
| tag_t ** | og_views | ||
| ) |
Retrieves the Occurrence Group views for a given base view window.
| base_view_window | (I) The base view window |
| number_of_views | (O) the number of Occurrence Group views |
| og_views | (OF) number_of_views The Occurrence Group views |
| ME_API int ME_get_source_or_target_line | ( | tag_t | lineTag, |
| tag_t | winTag, | ||
| logical * | isTarget, | ||
| tag_t * | outLineTag | ||
| ) |
This function take a line tag and its window tag and find out the corresponding line in last compare window.
| lineTag | (I) The line tag |
| winTag | (I) The window tag |
| isTarget | (O) True is the corresponding line is found |
| outLineTag | (O) The corresponding line tag |
return a filteredIPA of a given process will return NULL if not found or not exist the filteredIPA of a process is defined as the direct parent of the AppGroupBOPLine child (of the process) with "MEFilteredIPA" occ type
| ME_API int ME_init_module | ( | ) |
Initializes the ME module. This function must be called before using any other ME module functions. This function will be called by the standard ITK startup code. The ITK programmer can ignore this function.
Check if an IPA tree exists for the BOPWindow config rule
Restrictions: It will return an error if this is not a valid window, or other internal errors during the IPA check
| isNeeded | (I) Tag of the window where we check if configured process structure contains an IPA tree (O) The return value showing if the IPA tree exists |
Add object to parent line with relation type rel_type
| line | (I) Parent Line - any MECfgLine |
| object | (I) Object that needs to be added |
| rel_type | (I) Relationship type - needed only for attachments |
| child | (O) MECfgLine for the newly added object |
| ME_API int ME_line_add_Activity_with_predecessor | ( | tag_t | line, |
| tag_t | object, | ||
| const char * | rel_type, | ||
| tag_t * | child | ||
| ) |
Add actitivy object to parent line with relation type rel_type with predecessor handling
| line | (I) Parent Line - any MECfgLine |
| object | (I) Object that needs to be added |
| rel_type | (I) Relationship type - needed only for attachments |
| child | (O) MECfgLine for the newly added object |
List all immediate children of a given line - will need to free up child_lines
| line | (I) MECfgLine parent line for which children are needed |
| count | (O) Number of children |
| child_lines | (OF) Array of children |
List all descendant children of given line - will need to free up desc_lines.
| line | (I) MECfgLine parent line for which children are needed |
| count | (O) Number of children |
| desc_lines | (OF) Array of children |
Remove child line from parent line
| parent | (I) Parent Line - any MECfgLine |
| child | (I) MECfgLine for the child that needs to be removed |
remove incremental changes from the child MECfgLine line
| line | (I) MECfgLine for the line with incremental change |
| n | (I) number of changes to be removed from the input line |
| ices | (I) array of changes to be removed |
Move child line from original parent to new parent line
| child | (I) MECfgLine for the child that needs to be moved |
| new_parent | (I) MECfgLine for the new parent under which child will move |
| ME_API int ME_localupdateIPATree | ( | tag_t | bopLine | ) |
Update the IPA tree starting from a specific line
Restrictions: It will return an error if this is not a valid line, or other internal errors during update
| bopLine | (I) Tag of the window where the configured process structure contains the IPA tree we want to update |
| ME_API int ME_nx_object_modify_data | ( | tag_t | nxObjTag, |
| const char * | desc, | ||
| int | n_int, | ||
| int * | intList, | ||
| int | n_double, | ||
| double * | doubleList, | ||
| int | n_string, | ||
| char ** | stringList, | ||
| char ** | intKeyList, | ||
| char ** | doubleKeyList, | ||
| char ** | stringKeyList | ||
| ) |
Modify the parameters a MENX object.
Restrictions: It will return an error if fail to find or checkout MENX object
| nxObjTag | (I) Input MENX object tag |
| desc | (I) String, description of MENX object |
| n_int | (I) Int, count of integer parameters of MENX object |
| intList | (I) An array of integer paraemters of MENX object |
| n_double | (I) Int, count of double parameters of MENX object |
| doubleList | (I) An array of double parameters of MENX object |
| n_string | (I) Int, count of string parameters of MENX object |
| stringList | (I) An array of string parameters of MENX object |
| intKeyList | (I) An array of strings that hold integer key values of MENX object |
| doubleKeyList | (I) An array of strings that hold double key values of MENX object |
| stringKeyList | (I) An array of strings that hold string key values of MENX object |
| ME_API int ME_nx_object_read_data | ( | tag_t | theTag, |
| char ** | resource_desc, | ||
| int * | numIntAtts, | ||
| int ** | intAtts, | ||
| int * | numDoubleAtts, | ||
| double ** | doubleAtts, | ||
| int * | numStringAtts, | ||
| char *** | stringAttrs, | ||
| char *** | intKeyIds, | ||
| char *** | doubleKeyIds, | ||
| char *** | stringKeyIds | ||
| ) |
This function reads a MENX object and return all parameters of the MENX object
Restrictions: It will return an error if unable to find the MENX object
| theTag | (I) Input MENX object tag |
| resource_desc | (O) Returned a string, description of MENX object |
| numIntAtts | (O) Returned int, count of integer parameters of MENX object |
| intAtts | (OF) Returned an array of integer paraemters of MENX object |
| numDoubleAtts | (O) Returned int, count of double parameters of MENX object |
| doubleAtts | (OF) Returned an array of double parameters of MENX object |
| numStringAtts | (O) Returned int, count of string parameters of MENX object |
| stringAttrs | (OF) Returned an array of string parameters of MENX object |
| intKeyIds | (OF) Returned an array of strings that hold integer key values of MENX object |
| doubleKeyIds | (OF) Returned an array of strings that hold double key values of MENX object |
| stringKeyIds | (OF) Returned an array of strings that hold string key values of MENX object |
| ME_API int ME_paste_duplicate_structure | ( | const int | num_src_objects, |
| const tag_t * | src_objects, | ||
| const tag_t | target_line, | ||
| const char * | copy_rules_key, | ||
| int * | num_new_child_lines, | ||
| tag_t ** | new_child_lines | ||
| ) |
Creates new lines by duplicating source objects and pasting them to the target line.
copy_rule_key is invalid. target_line or any value in src_objects is not a valid tag. | num_src_objects | (I) Number of source objects to duplicate. |
| src_objects | (I) The source objects to duplicate. |
| target_line | (I) The target line for connecting newly created lines. |
| copy_rules_key | (I) Name of the rule to be used for copy. |
| num_new_child_lines | (O) Number of newly created lines under the target line. |
| new_child_lines | (OF) num_new_child_lines Newly created lines under the target line. |
| ME_API int ME_process_balancing | ( | tag_t | srcWin, |
| tag_t * | srcLines, | ||
| int | num_srcLines, | ||
| tag_t | tarWin, | ||
| tag_t * | tarLines, | ||
| int | num_tarLines, | ||
| char * | resultName, | ||
| char * | resultDesc, | ||
| int | options, | ||
| tag_t | assyCtxtLineTag, | ||
| tag_t | bomCtxtLineTag, | ||
| tag_t * | resultView | ||
| ) |
Process BOM balancing (Persistent-mode accountability check)
| srcWin | (I) The source window (e.g., product or workarea) |
| srcLines | (I) BOM Lines from the source window, whose sub-structures balancing will be performed. If empty, then top line of the source window assumed. |
| num_srcLines | (I) Size of above array |
| tarWin | (I) The target window (BOM window) to perform balancing against |
| tarLines | (I) Specified BOM lines from the target window, whose sub-structures balancing will be performed against. If empty, then top line of the target window assumed. |
| num_tarLines | (I) Size of above array |
| resultName | (I) Name of the result view (occurrence group) |
| resultDesc | (I) Description of the result view (occurrence group) |
| options | (I) Options of accountability check. Expected to be any combination of the following: add 1 - For source lines with "stop" marks, if to check their children. add 2 - If to check source lines at the lowest level only, as opposed to at all levels. add 4 - If to search all contextes in target, as opposed to the current active context. add 8 - If to search by absolute occurrence ID's only, as opposed to strictly by absolute occurrence objects. add 16 - If to compare a pre-define list of additional properties during the check. add 32 - If to compare occurrences linked via PublishLink |
| assyCtxtLineTag | (I) The possible source context line (in case the check is done when in-context mode is on) |
| bomCtxtLineTag | (I) The possible target context line (in case the check is done when in-context mode is on) |
| resultView | (O) The view (an occurrence group) containing result in its sub-groups |
| ME_API int ME_saveSearchResult | ( | tag_t | process, |
| tag_t * | search_result_list, | ||
| int | search_result_size, | ||
| char * | name, | ||
| tag_t * | filteredIPA, | ||
| tag_t * | filteredIPARoot, | ||
| tag_t ** | rejected_list, | ||
| int * | rejected_list_size | ||
| ) |
Generate a sub structure of the given IPA with only the bomlines from the search result list will save in as a permanent structure under the given name and will be consumed under the given process
| ME_API int ME_set_bomline_prop_based_on | ( | tag_t | item_tag, |
| tag_t | revrule_tag, | ||
| tag_t | sc_tag, | ||
| const char * | closure_rule, | ||
| const char * | scope_id_in_context, | ||
| const char * | scope_id, | ||
| const char * | preference, | ||
| logical | force_update, | ||
| const char * | dry_run_file | ||
| ) |
Sets the BOM Line property specified by the preference "MEIdGenerationPropertySetting" with the values of the contituent properties on that BOM Line. The specified Closure Rule must follow a pattern similar to any of the Accountability Closure Rules defined in the PLMXML admin application.
| item_tag | (I) item representing the root of the structure. If specified will ignore scTag. If not specified scTag must be specified. |
| revrule_tag | (I) revision rule for the structure. Must be supplied if itemTag is not NULLTAG. |
| sc_tag | (I) The Structure Context representing the structure in which to set the bomline property. |
| closure_rule | (I) optional closureRule name used to traverse the structure for selecting the lines to set properties. If null will traverse entire structure. |
| scope_id_in_context | (I) optional id in context top level string used to find the scope below which expansion is done. If neither scope parameters are specified or are invalid, top line of the BOM window is used as scope. |
| scope_id | (I) optional itemId to be used as scope below which expansion is done. Only used if scopeIdInContext is not specified. If neither scope parameters are specified or are invalid, top line of the BOM window is used as scope. |
| preference | (I) optional preference name if "MEIdGenerationPropertySetting" is not suitable. |
| force_update | (I) If prior value is set for the property, override it if this flag is true. Should be specified as false if original not empty ids are to be maintained. |
| dry_run_file | (I) Fully qualified filename to write the bomline details on which id will be set. Can be null. |
set source for the window - not used anymore
| window | (I) |
| src_line | (I) |
| top_line | (O) |
| ME_API int ME_Time_Analysis_Rollup | ( | tag_t | node, |
| int * | nValues, | ||
| double ** | timeAnalysisValues, | ||
| double * | tWork, | ||
| double * | tDuration | ||
| ) |
This routine will get the time analysis results for the sub tree activities
| node | (I) |
| nValues | (O) |
| timeAnalysisValues | (O) |
| tWork | (O) |
| tDuration | (O) |
| ME_API int ME_update_mbom_from_ebom | ( | tag_t | ebom_root, |
| const char * | rev_rule, | ||
| tag_t | ebom_scope_object, | ||
| const char * | ebom_idic, | ||
| tag_t | mbom_root, | ||
| tag_t | mbom_rev_rule, | ||
| int | depth, | ||
| int | action_on_release, | ||
| const char * | user_data, | ||
| const char * | log_file, | ||
| tag_t * | mbom_node | ||
| ) |
Updates a Manufacturing bom (MBOM) subassembly/node from a Engineering bom(EBOM) node based on user customizations for new MBOM item types.
Relies on the user_exit functions: USER_create_or_ref_item and USER_sync_item to be implemented to support custom behavior.
ebom_root. rev_rule. | ebom_root | (I) Can be item/revision/StructureContext. |
| rev_rule | (I) Name of revision rule. Unused if ebomRoot is StructureContext. |
| ebom_scope_object | (I) Item representing the ebom (sub)node to be updated or created in mbom structure. |
| ebom_idic | (I) Id in context of top level for ebom scope line. Will be used instead of ebomScopeObject are specified. |
| mbom_root | (I) Item/revision/StructureContext representing the root of mbom structure. |
| mbom_rev_rule | (I) Tag of revision rule for mbom structure. Unused if mbomRoot is StructureContext. |
| depth | (I) How many levels to go below scopeobject to create/update. |
| action_on_release | (I) Perform action. Valid values are:
|
| user_data | (I) Pass through data for any extensions registered from caller. |
| log_file | (I) Filename to write additional logs. |
| mbom_node | (O) MBOM node created/updated corresponding to the EBOM scope object. |
| ME_API int ME_updateIPATree | ( | tag_t | bopWindow | ) |
Update the IPA tree
Restrictions: It will return an error if this is not a valid window, or other internal errors during update
| bopWindow | (I) Tag of the window where the configured process structure contains the IPA tree we want to update |
| ME_API int ME_window_close | ( | tag_t | window | ) |
Close the assembly or attachment window
| window | (I) Input assembly or attachment window |
| ME_API int ME_window_configure_variants | ( | tag_t | win | ) |
Update assy window for variants - variants are applicable only to assembly window
| win | (I) Input assembly window |
Create root line for an attachment window or assembly window Assembly window expects appearance group Attachment window expects bomline or workspace object Attachment window can also take activity as input to traverse activity tree.
| win | (I) Input assembly or attachment window |
| root | (I) Root as defined above |
| root_line | (O) Tag to root MECFGLine class |
| ME_API int ME_window_hide_assigned_occurrences | ( | tag_t | bopWin | ) |
Hide assigned items in the process window (items that are configured out in the source)
| bopWin | (I) Tag of a BOPWindow |
| ME_API int ME_window_hide_incremental_changes | ( | tag_t | window | ) |
Hide incremental changes
| window | (I) Input attchemnt or assembly window |
| ME_API int ME_window_hide_variants | ( | tag_t | win | ) |
Update assy window for variants - applicable only for assembly window
| win | (I) Input assembly window |
Check to see if passed in tag is a valid key for this window; if it is, load it in all the appropriate places in the hierarchy
| window | (I) Input window |
| key | (O) Key object |
| count | (O) Number of lines found with the key |
| lines | (O) Array of MECfgLines |
| ME_API int ME_window_place_instances_with_absoccid | ( | tag_t | assyWindow, |
| const char * | ID, | ||
| int * | count, | ||
| tag_t ** | lines | ||
| ) |
Load all lines with the AbsOcc ID into an Assembly Window
| assyWindow | (I) Input assembly window |
| ID | (O) AbsOcc ID |
| count | (O) Number of lines found |
| lines | (O) Array of found MECfgLines |
Check to see if passed in tag is a valid key for this window; if it is, load it in the appropriate place in the hierarchy
| window | (I) Input window |
| key | (O) Key object |
| line | (O) MECfgLine for the key |
Set effectivity on window
| window | (I) Input window |
| date | (I) Date effectivity |
| unit_no | (I) Unit_no for effectivity |
| end_item | (I) End item for which unit_no is applied |
| ME_API int ME_window_show_assigned_occurrences | ( | tag_t | bopWin | ) |
Show assigned items in the process window (items that are configured out in the source)
| bopWin | (I) Tag of a BOPWindow |
| ME_API int ME_window_show_incremental_changes | ( | tag_t | window | ) |
Show incremental changes
| window | (I) Input attchemnt or assembly window |
| ME_API int ME_window_show_variants | ( | tag_t | win | ) |
Update assy window for variants - applicable only for assembly window
| win | (I) Input assembly window |
| ME_API int MEBOM_init_module | ( | ) |
Initializes the MEBOM module. This function must be called before using any BOP related functions. This function will be called by the standard ITK startup code. The ITK programmer can ignore this function.
| ME_API int MENXOBJECT_type_create | ( | const char * | meobj_class_name, |
| const char * | meobj_type_name, | ||
| const char * | def_class_name, | ||
| int | cardinality, | ||
| int | numOfViewAllowableTypes, | ||
| tag_t * | allowableViewTypes, | ||
| tag_t * | meobj_type_tag | ||
| ) |
Create a MENX object type in database.
Restrictions: It will return an error if fail to create the type
| meobj_class_name | (I) String, the class name of MENC object |
| meobj_type_name | (I) String, the type name of MENC object |
| def_class_name | (I) String, name of the Storage class to be associated with the type |
| cardinality | (I) Number of occurrences MENX Object of this type can have |
| numOfViewAllowableTypes | (I) Number of allowed view types for this type |
| allowableViewTypes | (I) An array of view types tags |
| meobj_type_tag | (O) Returned MENX object type tag |
| ME_API int MENXOBJECT_type_delete | ( | tag_t | meobj_type_tag | ) |
Delete a MENX object type in database.
Restrictions: It will return an error if fail to delete the type
| meobj_type_tag | (I) Type tag of MENX object to be deleted |
| ME_API int TCMXML_export_plmxml | ( | tag_t * | selectedComps, |
| int | nComps, | ||
| const char * | applicationKey, | ||
| const char * | fileName | ||
| ) |
| selectedComps | (I) |
| nComps | (I) |
| applicationKey | (I) |
| fileName | (I) |
| ME_API int TCMXML_import_plmxml | ( | const char * | filePath, |
| const char * | applicationType, | ||
| tag_t | icComponent, | ||
| tag_t * | endItem, | ||
| int * | viewsCount, | ||
| tag_t ** | views, | ||
| int * | errorStatus | ||
| ) |
| filePath | (I) |
| applicationType | (I) |
| icComponent | (I) |
| endItem | (O) |
| viewsCount | (O) |
| views | (O) |
| errorStatus | (O) |
| tag_t ME_mfg_search_criteria_s::dummy |
| char** ME_saved_query_expression_s::entries |
| char** ME_occurrence_note_expression_s::note_type_str |
| int ME_saved_query_expression_s::num_entries |
| int ME_occurrence_note_expression_s::num_note_type |
| int ME_search_expression_set_s::num_saved_query_expressions |
| ME_occurrence_note_expression_t* ME_search_expression_set_s::occ_note_expressions |
| char** ME_occurrence_note_expression_s::occ_qry_opr |
Occurrence Query Operator used for Occurrence Filter.
Possible values are EQ, NE, LT, GT, LE, GE, LIKE, NOT_LIKE, NULL, NOT NULL for equal, not equal, less than, greater than, less than equal to, greater than equal to, like, not like, null, not null respectively.
| char** ME_occurrence_note_expression_s::occurrence_values |
| tag_t ME_saved_query_expression_s::saved_qry_tag |
| ME_saved_query_expression_t* ME_search_expression_set_s::saved_query_expressions |