ecm.h

Go to the documentation of this file.

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

/*  */

#ifndef ECM_H
#define ECM_H

#include <stdio.h>
#include <tc/tc_startup.h>
#include <ecm/ecm_errors.h>
#include <ecm/libecm_exports.h>

#define EC_Item_Type_c                          "EngChange"
#define EC_Item_class_name_c                    "Item"
#define EC_Rev_Type_c                           "EngChange Revision"
#define EC_Rev_class_name_c                     "ItemRevision"
#define ECMIMPACTANALYSISTASK_TYPE_NAME         "ECMImpactAnalysisTask"
#define ECMPREPAREECOTASK_TYPE_NAME             "ECMPrepareECOTask"
#define ECMCHECKLISTTASK_TYPE_NAME              "ECMChecklistTask"
#define ECMIMPACTANALYSISTASKTEMPLATE_TYPE_NAME "ECMImpactAnalysisTaskTemplate"
#define ECMPREPAREECOTASKTEMPLATE_TYPE_NAME     "ECMPrepareECOTaskTemplate"
#define ECMCHECKLISTTASKTEMPLATE_TYPE_NAME      "ECMChecklistTaskTemplate"
#define ECM_COMPARE_MODE_NAME                   "ECM_compare_mode"
#define ECM_COMPARE_DESCRIPTOR_NAME             "CMP_std_descriptor_ecm_compare"

typedef enum ECM_bom_change_type_e{
    BOM_unknown = 0,
    BOM_Add,
    BOM_Cancel,
    BOM_Quantity_Change,
    BOM_Move,
    BOM_Reshape,
    BOM_Note_Change,       
    BOM_Variant_Change,    
    LBOM_Add,              
    LBOM_Cancel,           
    LBOM_Quantity_Change   
} ECM_bom_change_type_t;

typedef struct ECM_note_change_info_s{
    tag_t      notechange_tag;
    tag_t      ec_rev_tag;
    tag_t      aff_bvr_tag;
    tag_t      prob_bvr_tag;
    int        no_of_note_changed;
    int        no_of_form_flds;
    char**     note_type_names;
    char**     before_values;
    char**     after_values;
    char**     form_fld_names;
    char**     form_fld_values;
} ECM_note_change_info_t;

typedef struct ECM_variant_change_info_s{
    tag_t      variantchange_tag;
    tag_t      ec_rev_tag;
    tag_t      aff_bvr_tag;
    tag_t      prob_bvr_tag;
    int        no_of_form_flds;
    char*      before_value;
    char*      after_value;
    char**     form_fld_names;
    char**     form_fld_values;
} ECM_variant_change_info_t;

#ifdef __cplusplus
    extern "C"{
#endif

extern ECM_API int ECM_init_module( void );

extern ECM_API int ECM_create_ec_item(
    const char*    ec_id,          
    const char*    ec_rev_id,      
    const char*    ec_name,        
    const char*    ec_desc,        
    tag_t*         ec_item_tag,    
    tag_t*         ec_rev_tag      
    );

extern ECM_API int ECM_set_ec_type(
    tag_t          ec_rev_tag,    
    const char*    ec_type        
    );

extern ECM_API int ECM_remove_all_relations(
    tag_t          ec_rev_tag     
    );

extern ECM_API int ECM_get_ec_type(
    tag_t          ec_rev_tag,    
    char**         ec_type        
    );

extern ECM_API int ECM_find_ec_revision(
    const char*    ec_id,          
    const char*    ec_rev_id,      
    tag_t*         ec_rev_tag      
    );

extern ECM_API int ECM_find_associated_ec(
    tag_t          target_rev_tag,    
    tag_t*         ec_rev_tag         
    );

extern ECM_API int ECM_get_contents(
    tag_t          ec_rev_tag,     
    const char*    folder_name,    
    int*           num_of_obj,     
    tag_t**        obj_tags        
    );

extern ECM_API int ECM_add_contents(
    tag_t          ec_rev_tag,    
    const char*    folder_name,   
    int            num_of_obj,    
    tag_t*         obj_tags       
    );

extern ECM_API int ECM_remove_contents(
    tag_t          ec_rev_tag,    
    const char*    folder_name,   
    int            num_of_obj,    
    tag_t*         obj_tags       
    );

extern ECM_API int ECM_save_bom_changes(
    tag_t          ec_rev_tag,    
    tag_t          bom_window     
    );

extern ECM_API int ECM_get_bom_changes(
    tag_t                  ec_rev_tag,    
    tag_t                  affected_bvr,  
    ECM_bom_change_type_t  bomch_type,    
    int*                   num_of_bomch,  
    tag_t**                bomch_tags     
    );

extern ECM_API int ECM_is_affected_rev(
    tag_t          ec_rev_tag,    
    tag_t          ir_tag,        
    logical*       is_affected    
    );

extern ECM_API int ECM_is_problem_rev(
    tag_t          ec_rev_tag,    
    tag_t          ir_tag,        
    logical*       is_problem     
    );

extern ECM_API int ECM_set_problem_of_affected(
    tag_t          ec_rev_tag,    
    tag_t          affected_ir,   
    tag_t          problem_ir     
    );

extern ECM_API int ECM_get_problem_of_affected(
    tag_t          ec_rev_tag,    
    tag_t          affected_ir,   
    tag_t*         problem_ir     
    );

extern ECM_API int ECM_is_problem_relation_set(
    tag_t          ec_rev_tag,    
    tag_t          affected_ir,   
    logical*       is_set         
    );

extern ECM_API int ECM_get_relation_of_folder(
    const char*    folder_name,   
    char**         reln_name      
    );

extern ECM_API int ECM_get_ec_pseudofolder_names(
    int*           nFolder,     
    char***        folderNames, 
    char***        relnNames    
    );

extern ECM_API int ECM_get_prev_bvr(
    tag_t          ec_rev_tag,  
    tag_t          bvr_tag,     
    tag_t*         prev_bvr_tag 
    );

extern ECM_API int ECM_get_form_relation(
    char**         formRelationType    
    );

extern ECM_API int ECM_get_affected_items(
    tag_t          ec_rev_tag,   
    int*           n_items,      
    tag_t**        itemTags      
    );

extern ECM_API int ECM_get_occurrence_of_bomchange(
    tag_t          bomch_tag,    
    tag_t*         occ_tag       
    );

extern ECM_API int ECM_get_affected_bvr_of_bomchange(
    tag_t          bomch_tag,    
    tag_t*         affected_bvr  
    );

extern ECM_API int ECM_get_ecrev_of_bomchange(
    tag_t          bomch_tag,    
    tag_t*         ec_rev_tag    
    );

extern ECM_API int ECM_get_bomchange_type(
    tag_t                   bomch_tag,    
    ECM_bom_change_type_t*  bomch_type    
    );

extern ECM_API int ECM_bomchange_is_derived(
    tag_t          bomch_tag,    
    logical*       is_derived    
    );

extern ECM_API int ECM_find_bomchanges_of_occ(
    tag_t          occ_tag,     
    int*           bomch_count, 
    tag_t**        bomch_tags   
    );

extern ECM_API int ECM_bomchange_get_childrens(
    tag_t          bomch_tag,     
    int*           n_children,    
    tag_t**        child_tags     
    );

extern ECM_API int ECM_create_supercedure(
    tag_t          bvr_tag,        
    logical        is_transfer,    
    int            n_adds,         
    tag_t*         add_tags,       
    int            n_cancels,      
    tag_t*         cancel_tags,    
    tag_t*         sup_tag         
    );

extern ECM_API int ECM_append_bomadd_list_of_sup(
    tag_t          sup_tag,     
    tag_t          add_tag      
    );

extern ECM_API int ECM_append_bomcancel_list_of_sup(
    tag_t          sup_tag,        
    tag_t          cancel_tag      
    );

extern ECM_API int ECM_remove_bomadd_from_sup(
    tag_t          sup_tag,     
    tag_t          add_tag      
    );

extern ECM_API int ECM_remove_bomcancel_from_sup(
    tag_t          sup_tag,        
    tag_t          cancel_tag      
    );

extern ECM_API int ECM_delete_supercedure(
    tag_t          sup_tag        
    );

extern ECM_API int ECM_get_note_change_details(
    tag_t                   note_change_tag,    
    ECM_note_change_info_t* notechange_details  
    );

extern ECM_API int ECM_get_note_change_history_info(
    tag_t                       bomline_tag,           
    int*                        number_of_notechanges, 
    ECM_note_change_info_t**    details                
    );

extern ECM_API void ECM_free_notechange_info_struct(
    ECM_note_change_info_t  info
    );

extern ECM_API int ECM_get_variant_change_details(
    tag_t                       variant_change_tag,       
    ECM_variant_change_info_t*  variantchange_details     
    );

extern ECM_API int ECM_get_variant_change_history_info(
    tag_t                       bomline_tag,              
    int*                        number_of_variantchanges, 
    ECM_variant_change_info_t** details                   
    );

extern ECM_API void ECM_free_variantchange_info_struct(
    ECM_variant_change_info_t   info
    );
extern ECM_API int ECM_create_ec_snapshot(
       tag_t   ec_rev,       
       char    *desc,        
       tag_t   *snapshot     
    );
extern ECM_API int ECM_snapshot_apply_stylesheet(
       tag_t  ec_snapshot,       
       char   *stylesheet_file,  
       char   **output_dir,      
       char   **output_file      
    );


extern ECM_API int ECM_find_supercedure_of_bomchange(
       tag_t   bcTag,                  
       tag_t   *supTag                 
    );

#ifdef __cplusplus
}
#endif

#include <ecm/libecm_undef.h>
#endif