me.h

Go to the documentation of this file.

/*==============================================================================
                Copyright (c) 2003-2005 UGS Corporation
                   Unpublished - All Rights Reserved
 ==============================================================================*/

/*  */

#ifndef ME_H
#define ME_H

#include <fclasses/tc_basic.h>
#include <me/libme_exports.h>


#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"

#define ME_mestation_type_name_c                "MEStation"
#define ME_mestation_rev_type_name_c            "MEStationRevision"
#define ME_meline_type_name_c                   "MELine"
#define ME_meline_rev_type_name_c               "MELineRevision"
#define ME_meplant_type_name_c                  "MEPlant"
#define ME_meplant_rev_type_name_c              "MEPlantRevision"
#define ME_medepartment_type_name_c             "MEDepartment"
#define ME_medepartment_rev_type_name_c         "MEDepartmentRevision"
#define ME_mesite_type_name_c                   "MESite"
#define ME_mesite_rev_type_name_c               "MESiteRevision"
#define ME_machining_type_name_c                "MENCMachining"
#define ME_machining_rev_type_name_c            "MENCMachining Revision"
#define ME_ncprogram_type_name_c                "MENCProgram"
#define ME_workpiece_type_name_c                "MEWorkpiece"
#define Usage_compareResultView_type_name_c     "UsageCompareResultView"
#define ME_appgrp_app_relation_type_name_c      "IMAN_MEComponent"
#define ME_meproductlocation_type_name_c        "MEProductLocation"
#define ME_meproductlocation_rev_type_name_c    "MEProductLocationRevision"
#define ME_medrill_type_name_c                  "MEDrill"
#define ME_medrill_rev_type_name_c              "MEDrillRevision"
#define ME_meedm_type_name_c                    "MEEDM"
#define ME_meedm_rev_type_name_c                "MEEDMRevision"
#define ME_memilling_type_name_c                "MEMilling"
#define ME_memilling_rev_type_name_c            "MEMilling Revision"
#define ME_memillturn_type_name_c               "MEMillTurn"
#define ME_memillturn_rev_type_name_c           "MEMillTurnRevision"
#define ME_meturning_type_name_c                "METurning"
#define ME_meturning_rev_type_name_c            "METurningRevision"
#define ME_mewedm_type_name_c                   "MEWEDM"
#define ME_mewedm_rev_type_name_c               "MEWEDM Revision"


#define ME_metrace_origin_type_name_c           "Mfg0METraceOriginRel"
#define ME_melogical_designator_type_name_c     "Mfg0MELogicalDesignatorRel"


#define ME_base_view_ref_window_name_c          "viewBaseWindow"

#define ME_activity_desc_size_c                 240

#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

#ifdef __cplusplus
    extern "C"{
#endif

extern ME_API int ME_init_module();


extern ME_API int MEBOM_init_module();

extern ME_API int ME_create_process (
    const char*   id,       
    const char*   revid,    
    const char*   type,     
    const char*   name,     
    const char*   desc,     
    tag_t*        newProc   
    );
extern ME_API int ME_create_processrevision (
    const char*   id,           
    const char*   revid,        
    tag_t*        newProcRev    
    );
extern ME_API int ME_create_operation (
    const char*   id,           
    const char*   revid,        
    const char*   type,         
    const char*   name,         
    const char*   desc,         
    tag_t*        newProcOp     
    );
extern ME_API int ME_create_operationrevision (
    const char*   id,           
    const char*   revid,        
    tag_t*        newProcOpRev  
    );
extern ME_API int ME_create_workarea (
    const char*   id,           
    const char*   revid,        
    const char*   type,         
    const char*   name,         
    const char*   desc,         
    tag_t*        newWrkarea    
    );
extern ME_API int ME_create_workarearevision (
    const char*   id,               
    const char*   revid,            
    tag_t*        newWrkAreaRev     
    );

extern ME_API int ME_create_activity(
    const char*   name,     
    const char*   type,     
    const char*   desc,     
    double        time,     
    tag_t*        newAct    
    );
extern 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        
    );
extern ME_API int ME_activity_add_predecessor(
    tag_t         succ,     
    tag_t         pred      
    );
extern ME_API int ME_activity_remove_predecessor(
    tag_t         succ,     
    tag_t         pred      
    );
extern ME_API int ME_activity_list_predecessors(
    tag_t         succ,     
    int*          nPred,    
    tag_t**       pred      
    );
extern ME_API int ME_activity_list_activities(
    tag_t         acttag,   
    int*          nAct,     
    tag_t**       listtags  
    );
extern ME_API int ME_activity_add_tool(
    tag_t         acttag,       
    const char*   toolName      
    );

extern ME_API int ME_activity_add_reference_tool(
    tag_t acttag,             
    const char *toolName,     
    tag_t resLineTag,         
    tag_t opLineTag           
    );
extern ME_API int ME_activity_remove_tool(
    tag_t         acttag,       
    const char*   toolName      
    );
extern ME_API int ME_activity_ask_toollist(
    tag_t         acttag,       
    int*          nTool,        
    char***       toolList      
    );

extern ME_API int ME_activity_list_successors(
    tag_t         predTag,      
    int*          nSucc,        
    tag_t**       succTags      
    );

extern ME_API int ME_activity_list_activity_children(
    tag_t         activityTag,      
    int*          nChild,           
    tag_t**       actChildTags      
    );

extern ME_API int ME_activity_list_all_children(
    tag_t         activityTag,      
    int*          nChild,           
    tag_t**       actChildTags      
    );

extern ME_API int ME_activity_insert_tags(
    tag_t         parentTag,    
    int           nChild,       
    const tag_t*  childTags     
    );

extern ME_API int ME_activity_ask_description(
    tag_t activityTag,                           
    char actDesc[ME_activity_desc_size_c + 1]    
    );

extern ME_API int ME_activity_ask_description2(
    tag_t activityTag,                           
    char **actDesc                               
    );

extern ME_API int ME_activity_set_description(
    tag_t activityTag,                                         
    const char new_description[ME_activity_desc_size_c + 1]    
    );

extern ME_API int ME_activity_set_description2(
    tag_t activityTag,                                         
    const char *new_description                                
    );


extern ME_API int ME_Time_Analysis_Rollup(
    tag_t node,                                                    
    int *nValues,                                                
    double ** timeAnalysisValues,                                
    double * tWork,                                                
    double * tDuration                                            
    );


extern ME_API int ME_Calculate_Allocated_Time(
    tag_t node,                                               
    const char * calculatedBy,                                    
    double * allocated_time                                     
    );




extern 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                   
    );
extern 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            
    );
extern 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           
    );
extern 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            
    );

extern ME_API int ME_create_assembly_window(
    tag_t         revRule,          
    tag_t         sourceBomWin,     
    tag_t*        assyWindow        
    );

extern ME_API int ME_create_attachment_window(
    tag_t         revRule,          
    tag_t         sourceBomWin,     
    tag_t*        attachWindow      
    );

extern ME_API int ME_window_create_root_line(
    tag_t         win,          
    tag_t         root,         
    tag_t*        root_line     
    );

extern ME_API int ME_window_set_effectivity(
    tag_t         window,       
    date_t        date,         
    int           unit_no,      
    tag_t         end_item      
    );

extern ME_API int ME_window_show_incremental_changes(
    tag_t         window    
    );

extern ME_API int ME_window_hide_incremental_changes(
    tag_t         window    
    );

extern ME_API int ME_line_ask_child_lines(
    tag_t         line,         
    int*          count,        
    tag_t**       child_lines   
    );

extern ME_API int ME_line_ask_descendant_lines(
    tag_t         line,         
    int*          count,        
    tag_t**       desc_lines    
    );

extern ME_API int ME_window_place_object(
    tag_t         window,   
    tag_t         key,      
    tag_t*        line      
    );

extern ME_API int ME_window_place_all_instances(
    tag_t         window,   
    tag_t         key,      
    int*          count,    
    tag_t**       lines     
    );

extern ME_API int ME_window_place_instances_with_absoccid(
    tag_t         assyWindow,   
    const char*   ID,           
    int*          count,        
    tag_t**       lines         
    );
extern ME_API int ME_window_close(
    tag_t         window    
    );

extern ME_API int ME_window_configure_variants(
    tag_t         win   
    );

extern ME_API int ME_window_show_variants(
    tag_t         win   
    );

extern ME_API int ME_window_hide_variants(
    tag_t         win   
    );
extern ME_API int ME_line_add_Activity_with_predecessor(
    tag_t         line,         
    tag_t         object,       
    const char*   rel_type,     
    tag_t*        child         
    );

extern ME_API int ME_line_add(
    tag_t         line,         
    tag_t         object,       
    const char*   rel_type,     
    tag_t*        child         
    );

extern ME_API int ME_line_remove(
    tag_t         parent,   
    tag_t         child     
    );

extern ME_API int ME_attachment_line_delete(
    tag_t         parent,   
    tag_t         child     
    );

extern ME_API int ME_attachment_line_change(
    tag_t         line,     
    tag_t*        new_wso    
    );

extern ME_API int ME_line_reparent(
    tag_t         child,        
    tag_t         new_parent    
    );

extern ME_API int ME_line_remove_incremental_changes(
    tag_t line,                   
    int n,                        
    tag_t * ices                  
    );

extern ME_API int ME_activity_remove_res_line(
    tag_t         acttag,       
    tag_t         resTag      
    );

extern ME_API int ME_window_hide_assigned_occurrences(
    tag_t bopWin                          
    );

extern ME_API int ME_window_show_assigned_occurrences(
    tag_t bopWin                          
    );

extern ME_API int ME_create_bop_window(
    tag_t*        window    
    );

extern ME_API int ME_bop_window_add_ref_window(
    tag_t bopWindow,               
    tag_t refWindow,               
    char *winType                  
    );

extern ME_API int ME_bopwindow_add_control_occtype(
    tag_t bopWinTag,                  
    char *occType                     
    );

extern ME_API int ME_bopwindow_remove_control_occtype(
    tag_t bopWinTag,                  
    char *occType                     
    );

extern ME_API int ME_bom_window_has_ref_bop_window(
    tag_t bomWindow,                  
    int* count,                       
    tag_t ** refBopWindows            
    );
extern ME_API int ME_close_bop_window(
    tag_t         window    
    );
extern ME_API int ME_create_bos_window(
    tag_t         rev_rule,     
    tag_t*        window        
    );
extern ME_API int ME_set_bos_window_source(
    tag_t         window,       
    tag_t         src_line,     
    tag_t*        top_line      
    );
extern ME_API int ME_close_bos_window(
    tag_t         window    
    );

extern 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        
    );

extern ME_API int ME_get_source_or_target_line(
    tag_t lineTag,                  
    tag_t winTag,                   
    logical *isTarget,              
    tag_t *outLineTag               
    );

extern ME_API int TCMXML_export_plmxml(
    tag_t*        selectedComps,    
    int           nComps,           
    const char*   applicationKey,   
    const char*   fileName          
    );

extern 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       
    );

extern 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         
    );
extern 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      
    );
extern 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     
    );
extern 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            
    );
extern ME_API int MENXOBJECT_type_delete(
    tag_t         meobj_type_tag    
    );

extern 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                  
    );
extern ME_API int ME_updateIPATree(
    tag_t bopWindow     
    );
extern ME_API int ME_localupdateIPATree(
    tag_t bopLine    
    );
extern ME_API int ME_cleanIPATree(
    tag_t bopWindow,                     
    tag_t *prdctWinAPR                   
    );
extern ME_API int ME_isIPAExists(
    tag_t bopWindow,                    
    logical *isNeeded                   
    );

extern ME_API int ME_generateSearchScope(
    tag_t* processes,                    /* (I) The processes */
    int processes_size,                  /* (I) Processes size */
    tag_t** bomlines,                    /* (O) The search scope */
    int* bomlines_size                   /* (O) Search scope size */
    );

extern ME_API int ME_saveSearchResult(
    tag_t process,                      /* (I) The process */
    tag_t* search_result_list,          /* (I) Search result list */
    int search_result_size,             /* (I) Search result size */
    char* name,                         /* (I) The name of the name structure */
    tag_t* filteredIPA,                 /* (O) The new structure */
    tag_t* filteredIPARoot,             /* (O) The collection of all filteredIPA structures */
    tag_t** rejected_list,              /* (O) The bomline that didn't get in the new structure */
    int* rejected_list_size             /* (O) The size of rejected_list */
    );

extern ME_API int ME_getFilteredIPA(
    tag_t process_line,                 /* (I) The process */
    tag_t* filterIPA                    /* (O) The filteredIPA */
    );

extern ME_API int ME_deleteFilteredIPA(
    tag_t* process_lines,               /* (I) The processes */
    int noOfLines                        /* (I) no of processes */
    );


/*======================================================================================
CICO Manager functions
======================================================================================*/

extern ME_API int ME_find_checked_outs_in_structure(
    tag_t *lines,          
    int lines_size,          
    int *size,              
    tag_t **list          
    );

/*
This function checks out items for the given structures recursively
*/

extern ME_API int ME_checkout_for_PS(
                                     tag_t TargetLine                     /* (I) */,
                                     logical coProcess                        /* (I) */,
                                     logical isRecursive                        /* (I) */,
                                     char *changeIdChar              /* (I) */,
                                     char *commentChar                    /* (I) */
                                     );

/*
This function checks in items for the given structures recursively
*/

extern ME_API int ME_checkin_for_PS(
                                    tag_t TargetLine                     /* (I) */
                                    );



extern ME_API int ME_get_connected_mfgs_from_part(
    tag_t part,     
    int*  nMfgs,    
    tag_t** mfgs    
    );

extern ME_API int ME_get_connected_mfgs_from_parts(
    tag_t* parts,    
    int nPartCnt,    
    tag_t** mfgs,   
    int* nMfgCnt    
    );

extern 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    
    );

extern 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    
    );

extern 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  
    );

typedef ME_API struct ME_saved_query_expression_s{
    int     num_entries;                    
    char**  entries;                        
    char**  values;                         
    tag_t   saved_qry_tag;                  
} ME_saved_query_expression_t ;

typedef ME_API struct ME_occurrence_note_expression_s{
    int num_note_type;                          
    char** note_type_str;                       
    char** occ_qry_opr;                         
    char** occurrence_values;                   
} ME_occurrence_note_expression_t;

typedef ME_API struct ME_search_expression_set_s {
    int num_saved_query_expressions;                        
    ME_saved_query_expression_t* saved_query_expressions;   
    int num_occ_note_expressions;                           /* < Number of Occurrence Note Expressions */
    ME_occurrence_note_expression_t* occ_note_expressions;  
} ME_search_expression_set_t;

typedef ME_API struct ME_mfg_search_criteria_s {
    tag_t dummy;                    
} ME_mfg_search_criteria_t;

extern 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                                   
);


extern ME_API int ME_get_occurrence_group_views(
    tag_t base_view_window,   
    int* number_of_views,     
    tag_t** og_views          
    );

extern ME_API int ME_get_base_view(
     tag_t og_view,    
     tag_t* base_view  
     );

extern 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         
                                           );

extern 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               
                                           );

extern 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               
    );

#ifdef __cplusplus
}
#endif

#include <me/libme_undef.h>

#endif