cbaext.h

Go to the documentation of this file.

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

#ifndef CBAEXT_H_INCLUDED
#define CBAEXT_H_INCLUDED

#include <cba/pmm.h>
#include <cba1cbaext/libcbaext_exports.h>


#ifdef __cplusplus
    extern "C" {
#endif

typedef struct  CBAEXT_item_revision_part_info_s
{
    tag_t                    item_rev_tag;    
    tag_t                    part_tag;       
    int                      client_id;      
} CBAEXT_item_revision_part_info_t;

typedef struct CBAEXT_item_revision_info_s
{
    tag_t            item_rev_tag;        
    int              client_id;          
} CBAEXT_item_revision_info_t;

typedef struct CBAEXT_cad_occurrence_info_s
{
    tag_t            bomline;       
    int              client_id;      
} CBAEXT_cad_occurrence_info_t;

typedef struct CBAEXT_set_of_aligned_act_lines_s 
{     
    int n_actlines;       
    tag_t* actlines;      
} CBAEXT_set_of_aligned_act_lines_t;

typedef struct CBAEXT_act_line_to_bomline_s
{
    tag_t actline;    
    tag_t bomline;    
} CBAEXT_act_line_to_bomline_t;

typedef struct CBAEXT_item_revision_primary_publish_info_s
{
    tag_t  design_tag;           
    bool   primary_flag;         
    bool   publish_flag;         
} CBAEXT_item_revision_primary_publish_info_t;


typedef struct CBAEXT_item_revision_to_part_info_s
{
    tag_t                                         part_tag;         
    int                                           n_item_rev_tags;   
    CBAEXT_item_revision_primary_publish_info_t*  item_rev_tags;     
} CBAEXT_item_revision_to_part_info_t;

typedef struct CBAEXT_part_to_item_revision_info_s
{
    tag_t   item_tag;            
    int     n_part_rev_tags;      
    tag_t*  part_rev_tags;        
} CBAEXT_part_to_item_revision_info_t;

typedef struct CBAEXT_solution_information_s
{
    tag_t solution;             
    int   client_id;             
} CBAEXT_solution_information_t;

typedef struct CBAEXT_design_occurrence_solution_info_s
{     
    tag_t bomLine;              
    tag_t solution;             
    int   client_id;             
} CBAEXT_design_occurrence_solution_info_t;

typedef struct CBAEXT_related_object_info_s
{
    char *table_name;                         
    char *action;                             
    char *related_object_tuid;                
    int  num_attribute;                       
    char **related_object_attributes;         
    char **related_object_attribute_values;   
}CBAEXT_related_object_info_t;

typedef struct CBAEXT_cad_occurrence_solution_information_s 
{     
    tag_t                               bomline;                
    tag_t                               solution;               
    int                                 num_attribute;          
    char**                              solution_attr;          
    char**                              solution_attr_values;   
    int                                 n_related_object;       
    CBAEXT_related_object_info_t*       related_object;         
    char *                              client_id;               
} CBAEXT_cad_occurrence_solution_infomation_t;

typedef struct CBAEXT_design_info_s
{
    tag_t            item_rev_tag;       
    char *           client_id;         
} CBAEXT_design_info_t;

typedef struct CBAEXT_design_to_part_information_s
{
    tag_t                               part_tag;               
    int                                 n_item_rev_tags;        
    CBAEXT_design_info_t*               design_info;            
    int                                 num_attribute;          
    char**                              part_attr;              
    char**                              part_attr_values;       
    int                                 n_related_object;       
    CBAEXT_related_object_info_t*       related_object;         
} CBAEXT_design_to_part_information_t;


typedef struct CBAEXT_part_info_s
{
    tag_t                    part_tag;       
    int                      client_id;      
} CBAEXT_part_info_t;

typedef struct CBAEXT_design_occurrence_act_line_info_s
{     
    tag_t bomline;              
    tag_t actline;              
    int   client_id;             
} CBAEXT_design_occurrence_act_line_info_t;

extern CBAEXT_API int CBAEXT_init_module( void );

extern CBAEXT_API int CBAEXT_is_cba_enabled(
    logical         *is_enabled         
    );

extern CBAEXT_API int CBAEXT_align_item_revisions_and_parts(
        const int                        n_links,           
        CBAEXT_item_revision_part_info_t *alignment_info,   
        int                              *error_count,      
        PMM_error_store_map_t        **error_map         
        );

extern CBAEXT_API int CBAEXT_align_item_revisions_and_parts_eco(
        int                                      n_links,                           
        const CBAEXT_design_to_part_information_t       *alignment_info,                   
        const char                               *eco,                              
        logical                                  auto_commit,                       
        int                                      *return_part_count,                
        tag_t                                    **return_part_tag,                 
        int                                      *error_count,                      
        PMM_error_store_map_t                    **error_map                        
        );

extern CBAEXT_API int CBAEXT_unalign_item_revisions_and_parts(
        const int                           n_links,          
        CBAEXT_item_revision_part_info_t    *alignment_info,  
        int                                 *error_count,     
        PMM_error_store_map_t            **error_map       
        );

extern CBAEXT_API int CBAEXT_unalign_item_revisions_and_parts_eco(
        int                                      n_links,                           
        const CBAEXT_design_to_part_information_t       *alignment_info,                   
        const char                               *eco,                              
        logical                                  auto_commit,                       
        int                                      *return_part_count,                
        tag_t                                    **return_part_tag,                 
        int                                      *error_count,                      
        PMM_error_store_map_t                    **error_map                        
        );

extern CBAEXT_API int CBAEXT_publish_item_revisions(
        const int                       n_item_revs,    
        CBAEXT_item_revision_info_t     *publish_info,  
        int                             *error_count,   
        PMM_error_store_map_t       **error_map      
        );

extern CBAEXT_API int CBAEXT_set_default_cad_representations_for_parts(
        const int                           n_item_revs,         
        CBAEXT_item_revision_part_info_t    *make_primary_info,  
        int                                 *error_count,        
        PMM_error_store_map_t            **error_map          
        );

extern CBAEXT_API int CBAEXT_set_default_cad_representations_for_parts_eco(
        int                                      n_links,                           
        const CBAEXT_design_to_part_information_t       *alignment_info,                   
        const char                               *eco,                              
        logical                                  auto_commit,                       
        int                                      *return_part_count,                
        tag_t                                    **return_part_tag,                 
        int                                      *error_count,                      
        PMM_error_store_map_t                    **error_map                        
        );

extern CBAEXT_API int CBAEXT_link_cad_occs_and_solutions_eco(
        int                                            n_cad_occ,                     
        const CBAEXT_cad_occurrence_solution_infomation_t   *alignment_info,               
        const char                                     *eco,                          
        logical                                        auto_commit,                   
        int                                            *return_solution_count,        
        tag_t                                          **return_solution_tag,         
        int                                            *error_count,                  
        PMM_error_store_map_t                          **error_map                    
        );

extern CBAEXT_API int CBAEXT_unlink_cad_occs_and_solutions_eco(
        int                                            n_cad_occ,                     
        const CBAEXT_cad_occurrence_solution_infomation_t   *alignment_info,               
        const char                                     *eco,                          
        logical                                        auto_commit,                   
        int                                            *return_solution_count,        
        tag_t                                          **return_solution_tag,         
        int                                            *error_count,                  
        PMM_error_store_map_t                          **error_map                    
    );

extern CBAEXT_API int CBAEXT_publish_cad_occurrences(
        const int                           n_cad_occ,          
        const CBAEXT_cad_occurrence_info_t  *publish_info,      
        int                                 *error_count,       
        PMM_error_store_map_t            **error_map         
        );

extern CBAEXT_API int CBAEXT_link_design_occ_to_act_line(
        int                        n_des_occ,            
        tag_t                      *design_occs,         
        int                        n_act_line,           
        tag_t                      *act_lines            
        );

extern CBAEXT_API int CBAEXT_unalign_design_occs_to_act_lines(
        int                        n_des_occ,            
        tag_t                      *design_occs,         
        int                        n_act_line,           
        tag_t                      *act_lines            
        );

extern CBAEXT_API int CBAEXT_link_set_of_design_occ_and_act_line(
        int                                             n_design_occ,    
        const CBAEXT_design_occurrence_act_line_info_t  *alignment_info, 
        int                                             *error_count,    
        PMM_error_store_map_t                           **error_map      
        );

extern CBAEXT_API int CBAEXT_unalign_set_of_design_occ_and_act_line(
        int                                             n_design_occ,    
        const CBAEXT_design_occurrence_act_line_info_t  *alignment_info, 
        int                                             *error_count,    
        PMM_error_store_map_t                           **error_map      
        );

extern CBAEXT_API int CBAEXT_find_aligned_act_lines_for_bomlines(
        const int                          n_des_occ,             
        const tag_t                       *design_occs,           
        const char                        *effective_date,        
        int                               *n_set_of_actlines,     
        CBAEXT_set_of_aligned_act_lines_t **set_of_actlines       
        );

extern CBAEXT_API int CBAEXT_find_aligned_act_lines_for_designs(
        int                               n_des_occ,              
        const tag_t                       *design_occs,           
        const char                        *effective_date,        
        const char                        *effective_point,       
        int                               *n_set_of_actlines,     
        CBAEXT_set_of_aligned_act_lines_t **set_of_actlines,      
        int                               *error_count,           
        PMM_error_store_map_t             **error_map             
        );

extern CBAEXT_API int CBAEXT_find_aligned_act_lines_for_designs_with_stream(
        int                               n_des_occ,              
        const tag_t                       *design_occs,           
        const char                        *effective_date,        
        const char                        *effective_point,       
        const char                        *db_query_stream,       
        int                               *n_set_of_actlines,     
        CBAEXT_set_of_aligned_act_lines_t **set_of_actlines,      
        int                               *error_count,           
        PMM_error_store_map_t             **error_map             
        );


extern CBAEXT_API int  CBAEXT_find_bomlines_for_act_lines(
        const int                        n_actlines,               
        const tag_t*                     actlines,                 
        CBAEXT_act_line_to_bomline_t**   actline_to_bomline        
        );

extern CBAEXT_API int CBAEXT_design_expand_below_all_levels(
        tag_t       line,                   
        int         *child_lines_count,     
        tag_t       **child_lines           
        );

extern CBAEXT_API int CBAEXT_find_item_revisions_linked_to_parts(
        const int                               n_parttags,     
        const CBAEXT_part_info_t*               inp_part_info,  
        CBAEXT_item_revision_to_part_info_t**   item_info       
        );

extern CBAEXT_API int CBAEXT_find_drawing_revisions_linked_to_parts(
    const int                               n_parttags,      
    const CBAEXT_part_info_t*               inp_part_info,   
    CBAEXT_item_revision_to_part_info_t**   drawing_info     
    );

extern CBAEXT_API int CBAEXT_find_parts_linked_to_item_revisions(
    const int                               n_itemtags,     
    const tag_t*                            item_tags,      
    CBAEXT_part_to_item_revision_info_t**   part_info       
    );

extern CBAEXT_API int CBAEXT_find_parts_linked_to_drawing_revisions(
    const int                               n_itemtags,     
    const tag_t*                            item_tags,      
    CBAEXT_part_to_item_revision_info_t**   part_info       
    );

extern CBAEXT_API int CBAEXT_find_solutions_linked_to_design_occurrences(
        int                                         n_cad_occ,        
        const CBAEXT_cad_occurrence_info_t          *cadocc_info,     
        int                                         *n_solutions,     
        CBAEXT_design_occurrence_solution_info_t    **solution_output,
        int                                         *error_count,     
        PMM_error_store_map_t                       **error_map       
    );

extern CBAEXT_API int CBAEXT_find_design_occurrences_linked_to_solutions(
        const int                                  n_solutions,         
        const CBAEXT_solution_information_t        *solution_info,      
        int                                        *n_cad_occs,         
        CBAEXT_design_occurrence_solution_info_t   **solution_output,   
        int                                        *error_count,        
        PMM_error_store_map_t                      **error_map          
    );
        
extern CBAEXT_API int CBAEXT_ask_primary_representations(
    int                                     n_parts,             
    const CBAEXT_part_info_t                *part_info,          
    CBAEXT_item_revision_part_info_t        **output,            
    PMM_error_store_map_t                   **error_map          
    );

#ifdef __cplusplus
}
#endif


#include <cba1cbaext/libcbaext_undef.h>
#endif