tccore/item.h

Go to the documentation of this file.

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

/*  */

#ifndef ITEM_H
#define ITEM_H

#include <fclasses/tc_basic.h>
#include <tccore/workspaceobject.h>
#include <tccore/libtccore_exports.h>

#define ITEM_item_class_name_c          "Item"
#define ITEM_rev_class_name_c           "ItemRevision"

#define ITEM_ITEM_ID_PROP                "item_id"

#define ITEM_revise_operation           "Revise"
#define ITEM_saveas_operation           "SaveAs"

#define ITEM_copy_as_object                 "copy_as_object"
#define ITEM_copy_as_reference              "copy_as_reference"
#define ITEM_relate_to_latest               "relate_to_latest"
#define ITEM_revise_and_relate_to_latest    "revise_and_relate_to_latest"
#define ITEM_no_copy                        "no_copy"
#define ITEM_select                         "select"
#define ITEM_system_copy                    "system_copy"

#define ITEM_id_size_c                  128
#define ITEM_name_size_c                WSO_name_size_c
#define ITEM_type_size_c                32
#define ITEM_desc_size_c                240

typedef enum ITEM_attachment_type_e
{
    ITEM_item_master_atth,

    ITEM_manifestation_atth,
    ITEM_requirement_atth,
    ITEM_specification_atth,
    ITEM_reference_atth,

    ITEM_master_data_atth,

    ITEM_bom_view_atth,  
    ITEM_bvr_atth,       
    ITEM_revision_atth,  
    ITEM_unknown_atth
} ITEM_attachment_type_t;

typedef struct ITEM_attached_object_s
{
    tag_t                  attachment;
    ITEM_attachment_type_t attachment_type;
} ITEM_attached_object_t;

typedef struct ITEM_deepcopy_info_s
{
    tag_t component; // Tag of the other side object.
    int action;      //Action
    char* objName; //New name for the copy object
    char* relation; //Name of the relation type.
    logical is_target_primary;
    logical is_required;
    logical copy_relations; // Whether to carry forward the Properties on the Relation
}  ITEM_deepcopy_info_t;

#ifdef __cplusplus
extern "C"
{
#endif

extern TCCORE_API int ITEM_init_module();

extern TCCORE_API int ITEM_exit_module();

extern TCCORE_API int ITEM_create_item(
    const char*         item_id,    
    const char*         item_name,  
    const char*         item_type,  
    const char*         rev_id,     
    tag_t*              item,       
    tag_t*              rev         
    );

extern TCCORE_API int ITEM_create_item_with_masters(
    const char* item_id,                  
    const char* item_name,                
    const char* item_type,                
    const char* rev_id,                   
    tag_t       item_master_form_tag,     
    tag_t       item_rev_master_form_tag, 
    tag_t*      item,                     
    tag_t*      rev                       
    );

extern TCCORE_API int ITEM_create_item2 (
                const char *type_name,       
                int        numAttrs,         
                char       **attrNames,      
                char       **attrValues,     
                const char *rev_id,          
                tag_t      *item,            
                tag_t      *rev              
                );

extern TCCORE_API int ITEM_create_item_with_masters2(
                                   const char *type_name,           
                                   int        numAttrs,             
                                   char       **attrNames,          
                                   char       **attrValues,         
                                   const char *rev_id,              
                                   tag_t      item_master_tag,      
                                   tag_t      item_rev_master_tag,  
                                   tag_t      *item,                
                                   tag_t      *rev                  
                                   );
extern TCCORE_API int ITEM_save_item(
    tag_t               item    
    );

extern TCCORE_API int ITEM_delete_item(
    tag_t               item    
    );

extern TCCORE_API int ITEM_extent  (
    int*                count,      
    tag_t**             item_list   
    );

extern TCCORE_API int ITEM_find_item(
    const char*         item_id,    
    tag_t*              item        
    );

extern TCCORE_API int ITEM_find(
    const char*         item_id,    
    int*                n_items,    
    tag_t**             item_tags   
    );

extern TCCORE_API int ITEM_find_items_by_key_attributes(
    int num_attributes,                 
    const char** attribute_names,       
    const char** attribute_values,      
    int*                n_items,        
    tag_t**             item_tags       
    );

extern TCCORE_API int ITEM_find_items_by_string(
    const char  *av_string,             
    int         *n_items,               
    tag_t       **item_tags             
    );

extern TCCORE_API int ITEM_find_item_revs_by_key_attributes(
    int num_attributes,                 
    const char** attribute_names,       
    const char** attribute_values,      
    const char* rev_id,                 
    int*                n_items,        
    tag_t**             item_tags       
    );

extern TCCORE_API int ITEM_find_item_revs_by_string(
    const char  *av_string,             
    int         *n_items,               
    tag_t       **item_tags             
    );

extern TCCORE_API int ITEM_find_item_revs_by_string_and_revid(
    const char  *av_string,             
    const char  *revid,                 
    int         *n_items,               
    tag_t       **item_tags             
    );

extern TCCORE_API int ITEM_exists(
    int num_attributes,              
    const char** attribute_names,    
    const char** attribute_values,   
    logical *exists                  
    );

extern TCCORE_API int ITEM_exists_in_domain(
    const char * type_name ,            
    const int  num_attributes,          
    const char** attribute_names,       
    const char** attribute_values,      
    logical *exists                     
    );

extern TCCORE_API int ITEM_rev_get_key_string(
    tag_t item_revision_tag,            
    char ** key_string                  
    );

extern TCCORE_API int ITEM_ask_latest_rev(
    tag_t               item,   
    tag_t*              rev     
    );

extern TCCORE_API int ITEM_list_all_revs(
    tag_t               item,       
    int*                count,      
    tag_t**             rev_list    
    );

extern TCCORE_API int ITEM_list_bom_views(
    tag_t               item,       
    int*                count,      
    tag_t**             bv_list     
    );

extern TCCORE_API int ITEM_attach_object(
    tag_t                  item,            
    tag_t                  object,          
    ITEM_attachment_type_t attachment_type  
    );

extern TCCORE_API int ITEM_detach_object(
    tag_t                  item,            
    tag_t                  object,          
    ITEM_attachment_type_t attachment_type  
    );

extern TCCORE_API int ITEM_list_attachs_of_type(
    tag_t                    item,              
    ITEM_attachment_type_t   attachment_type,   
    int*                     count,             
    ITEM_attached_object_t** objects            
    );

extern TCCORE_API int ITEM_list_all_attachments(
    tag_t                    item,      
    int*                     count,     
    ITEM_attached_object_t** objects    
    );

extern TCCORE_API int ITEM_copy_item(
    tag_t               rev,            
    const char*         new_item_id,    
    const char*         new_rev_id,     
    tag_t*              new_item,       
    tag_t*              new_rev         
    );

extern TCCORE_API int ITEM_copy_item_with_masters(
    tag_t       rev,                      
    const char* new_item_id,              
    const char* new_rev_id,               
    tag_t       item_master_form_tag,     
    tag_t       item_rev_master_form_tag, 
    tag_t*      new_item,                 
    tag_t*      new_rev                   
    );

extern TCCORE_API int ITEM_update_item_attachment(
    tag_t                  item,                
    tag_t                  old_object,          
    ITEM_attachment_type_t attachment_type,     
    tag_t                  new_object           
    );

extern TCCORE_API int ITEM_ask_unit_of_measure(
    tag_t               item,   
    tag_t*              uom     
    );

extern TCCORE_API int ITEM_set_unit_of_measure(
    tag_t               item,   
    tag_t               uom     
    );

extern TCCORE_API int ITEM_ask_id(
    tag_t               item,                           
    char                item_id[ITEM_id_size_c + 1]     
    );


extern TCCORE_API int ITEM_ask_id2(
    tag_t               item,                           
    char                **item_id                       
    );

extern TCCORE_API int ITEM_set_id (
    tag_t               item,       
    const char*         item_id     
    );

extern TCCORE_API int ITEM_ask_name(
    tag_t               item,                               
    char                item_name[ITEM_name_size_c + 1]     
    );

extern TCCORE_API int ITEM_ask_name2(
    tag_t               item,                               
    char                **item_name                         
    );

extern TCCORE_API int ITEM_set_name(
    tag_t               item,       
    const char*         item_name   
    );

extern TCCORE_API int ITEM_ask_description(
    tag_t               item,                               
    char                item_desc[ITEM_desc_size_c + 1]     
    );

extern TCCORE_API int ITEM_ask_description2(
    tag_t               item,                               
    char                **item_desc                         
    );

extern TCCORE_API int ITEM_set_description(
    tag_t               item,       
    const char*         item_desc   
    );

extern TCCORE_API int ITEM_ask_type(
    tag_t               item,                               
    char                item_type[ITEM_type_size_c + 1]     
    );


extern TCCORE_API int ITEM_ask_type2(
    tag_t               item,                               
    char                **item_type                         
    );

extern TCCORE_API int ITEM_create_rev(
    tag_t               item,       
    const char*         rev_id,     
    tag_t*              rev         
    );

extern TCCORE_API int ITEM_create_rev_with_master(
    tag_t       item,                     
    const char* rev_id,                   
    tag_t       item_rev_master_form_tag, 
    tag_t*      rev                       
    );

extern TCCORE_API int ITEM_save_rev(
    tag_t               rev     
    );

extern TCCORE_API int ITEM_delete_rev(
    tag_t               rev     
    );

extern TCCORE_API int ITEM_extent_rev(
    int*                count,      
    tag_t**             list        
    );

extern TCCORE_API int ITEM_find_rev(
    const char*         item_id,    
    const char*         rev_id,     
    tag_t*              rev_tag     
    );

extern TCCORE_API int ITEM_find_revision(
    tag_t               item,       
    const char*         rev_id,     
    tag_t*              rev_tag     
    );

extern TCCORE_API int ITEM_find_revisions(
    tag_t               item,       
    const char*         rev_id,     
    int*                n_revs,     
    tag_t**             rev_tags    
    );

extern TCCORE_API int ITEM_ask_item_of_rev(
    tag_t               rev,    
    tag_t*              item    
    );

extern TCCORE_API int ITEM_copy_rev_using(
    tag_t                   rev,                
    const char              *new_rev_id,        
    const int               option_count,       
    ITEM_deepcopy_info_t*   user_options,       
    tag_t                   *new_rev,           
    int*                    count,              
    tag_t**                 deep_copied_objects 
    );

extern TCCORE_API int ITEM_copy_rev(
    tag_t               rev,            
    const char*         new_rev_id,     
    tag_t*              new_rev_tag     
    );

extern TCCORE_API int ITEM_copy_rev_with_master(
    tag_t       rev,                      
    const char* new_rev_id,               
    tag_t       item_rev_master_form_tag, 
    tag_t*      new_rev_tag               
    );

extern TCCORE_API int ITEM_baseline_rev(
    tag_t               rev,                    
    const char*         new_rev_id,             
    const char*         desc,                   
    const char*         rel_proc_name,          
    const char*         jobName,                
    const char*         jobDescription,         
    tag_t*              new_rev_tag,            
    int*                deepCopiedObjCount,     
    tag_t**             deepCopiedObjs          
    );

extern TCCORE_API int ITEM_dryrun_baseline( tag_t      rev, 
                       const char *rel_proc_name,             
                       char **logFileName,                    
                       char **fullLogFileName                 
                     );

extern TCCORE_API int ITEM_rev_find_base_rev(
    tag_t               baseline_rev,   
    tag_t*              base_rev        
    );

extern TCCORE_API int ITEM_rev_list_baselineRevs(
    tag_t               base_rev,               
    const char*         baselineStatusName,     
    int*                n_revs,                 
    tag_t**             baseline_revs           
    );

extern TCCORE_API int ITEM_attach_rev_object(
    tag_t                  rev,             
    tag_t                  object,          
    ITEM_attachment_type_t attachment_type  
    );

extern TCCORE_API int ITEM_detach_rev_object(
    tag_t                  rev,             
    tag_t                  object,          
    ITEM_attachment_type_t attachment_type  
    );

extern TCCORE_API int ITEM_rev_list_bom_view_revs(
    tag_t               rev,    
    int*                count,  
    tag_t**             bvrs    
    );

extern TCCORE_API int ITEM_rev_list_all_bom_view_revs(
    tag_t               rev,    
    int*                count,  
    tag_t**             bvrs    
    );

extern TCCORE_API int ITEM_rev_delete_bvr(
    tag_t  rev,    
    tag_t  bvr     
    );

extern TCCORE_API int ITEM_list_rev_attachs_of_type(
    tag_t                    rev,               
    ITEM_attachment_type_t   relation_type,     
    int*                     count,             
    ITEM_attached_object_t** objects            
    );

extern TCCORE_API int ITEM_list_all_rev_attachments(
    tag_t                    rev,       
    int*                     count,     
    ITEM_attached_object_t** objects    
    );

extern TCCORE_API int ITEM_update_rev_attachment(
    tag_t                  rev,                 
    tag_t                  old_object,          
    ITEM_attachment_type_t attachment_type,     
    tag_t                  new_object           
    );

extern TCCORE_API int ITEM_ask_rev_id(
    tag_t               rev,                        
    char                rev_id[ITEM_id_size_c + 1]  
    );

extern TCCORE_API int ITEM_ask_rev_id2(
    tag_t               rev,                        
    char                **rev_id                    
    );

extern TCCORE_API int ITEM_set_rev_id(
    tag_t               rev,    
    const char*         rev_id  
    );

extern TCCORE_API int ITEM_ask_rev_name(
    tag_t               rev,                            
    char                rev_name[ITEM_name_size_c + 1]  
    );

extern TCCORE_API int ITEM_ask_rev_name2(
    tag_t               rev,                            
    char                **rev_name                      
    );

extern TCCORE_API int ITEM_set_rev_name(
    tag_t               rev,        
    const char*         rev_name    
    );

extern TCCORE_API int ITEM_ask_rev_description(
    tag_t               rev,                            
    char                rev_desc[ITEM_desc_size_c + 1]  
    );

extern TCCORE_API int ITEM_ask_rev_description2(
    tag_t               rev,                            
    char                **rev_desc                      
    );

extern TCCORE_API int ITEM_set_rev_description(
    tag_t               rev,        
    const char*         rev_desc    
    );

extern TCCORE_API int ITEM_ask_rev_type(
    tag_t               rev,                            
    char                rev_type[ITEM_type_size_c + 1]  
    );

extern TCCORE_API int ITEM_ask_rev_type2(
    tag_t               rev,                            
    char                **rev_type                      
    );

extern TCCORE_API int ITEM_ask_rev_variants(
    tag_t               rev,                        
    tag_t*              variant_expression_block    
    );

extern TCCORE_API int ITEM_set_rev_variants(
    tag_t               rev,                        
    tag_t               variant_expression_block    
    );

extern TCCORE_API int ITEM_create_ic_baseline_rev(
    tag_t               rev,                
    tag_t               bom_window,         
    const char*         copy_rules_key,     
    const char*         name,               
    const char*         desc,               
    const char*         id,                 
    const char*         rev_id,             
    tag_t*              new_rev             
    );

extern TCCORE_API int ITEM_perform_deepcopy(
    tag_t               new_item_rev ,      
    char*               operation,          
    tag_t               parent_item_rev,    
    int*                count,              
    tag_t**             deepcopiedobjects   
    );

extern TCCORE_API int ITEM_perform_deepcopy_using2(
    tag_t               new_item_rev ,      
    char*               operation,          
    tag_t               parent_item_rev,    
    const int           option_count,       
    const tag_t         *obj_tags,          
    const char**        copy_types,         
    const char**        obj_names,          
    const char**        relation_types,     
    const char**      copy_relations,     
    int*                count,              
    tag_t**             deepcopiedobjects   
    );

extern TCCORE_API int ITEM_perform_deepcopy_using(
    tag_t               new_item_rev ,      
    char*               operation,          
    tag_t               parent_item_rev,    
    const int           option_count,       
    const tag_t         *obj_tags,          
    const char**        copy_option,        
    const char**        option_names,        
    const char**        relation_types,      
    int*                count,              
    tag_t**             deepcopiedobjects   
    );

extern TCCORE_API int ITEM_translate_rev_mvl(
    tag_t               from_rev,       
    tag_t               to_rev,         
    int                 n_modules,      
    char**              from_modules,   
    char**              to_modules      
    );

extern TCCORE_API int ITEM_rev_ask_effectivity_mappings(
    tag_t itemrev,                         
    int *n,                                
    tag_t **mappings                       
    );

typedef struct ITEM_attached_object_tag_s
{
    tag_t attachment;
    tag_t attachment_type;
} ITEM_attached_object_tag_t;

extern TCCORE_API int ITEM_attach_object_tag(
    tag_t               item,               
    tag_t               object,             
    tag_t               attachment_type     
    );

extern TCCORE_API int ITEM_detach_object_tag(
    tag_t               item,               
    tag_t               object,             
    tag_t               attachment_type     
    );

extern TCCORE_API int ITEM_attach_rev_object_tag(
    tag_t               rev,                
    tag_t               object,             
    tag_t               attachment_type     
    );

extern TCCORE_API int ITEM_detach_rev_object_tag(
    tag_t               rev,                
    tag_t               object,             
    tag_t               attachment_type     
    );

extern TCCORE_API int ITEM_ask_attachment_name(
    tag_t               attachment_type,    
    char**              name                
    );

extern TCCORE_API int ITEM_list_attachs_of_type_tag(
    tag_t               item,               
    tag_t               attachment_type,    
    int*                count,              
    tag_t**             tag_list            
    );

extern TCCORE_API int ITEM_list_all_attachments_tag(
    tag_t                        item,      
    int*                         count,     
    ITEM_attached_object_tag_t** objects    
    );

extern TCCORE_API int ITEM_list_possible_attachments_tag(
    const char*         obj_type,           
    int*                count,              
    tag_t**             attachment_types    
    );

extern TCCORE_API int ITEM_rev_create_gde_bvr (
    tag_t               item_rev_tag,   
    tag_t               view_type,      
    tag_t*              gde_bvr_tag     
    );

extern TCCORE_API int ITEM_rev_ask_gde_bvr (
    tag_t               item_rev_tag,   
    tag_t               view_type,      
    tag_t*              gde_bvr_tag     
    );


extern TCCORE_API int ITEM_ask_has_module(
    tag_t               item,       
    logical*            is_module   
    );

extern TCCORE_API int ITEM_rev_ask_has_module(
    tag_t               item_rev,       
    logical*            is_module   
    );
extern TCCORE_API int ITEM_ask_is_vi(
    tag_t               item,   
    logical*            is_vi   
    );

extern TCCORE_API int ITEM_vi_ask_sos(
    tag_t               item,       
    tag_t*              db_sos      
    );

extern TCCORE_API int ITEM_vi_ask_generic_component(
    tag_t               item,               
    tag_t*              module_item_rev     
    );

extern TCCORE_API int ITEM_vi_ask_is_linked_to_generic(
    tag_t               item,       
    logical*            is_linked   
    );

extern TCCORE_API int ITEM_vi_unlink_from_generic(
    tag_t               item    
    );

extern TCCORE_API int ITEM_vi_find(
    tag_t               generic_item_rev,   
    int                 n,                  
    tag_t*              items,              
    char**              options,            
    int*                ops,                
    int*                valueTypes,         
    char**              lowValues,          
    char**              highValues,         
    int*                n_matches,          
    tag_t**             matches             
    );

extern TCCORE_API int ITEM_find_in_idcontext (
    const char*         id,             
    tag_t               idcontext_tag,  
    int*                num_items,      
    tag_t**             item_tags       
    );

extern TCCORE_API int ITEM_find_item_in_idcontext (
    const char*         id,             
    tag_t               idcontext_tag,  
    tag_t*              item_tag        
    );

extern TCCORE_API int ITEM_find_revs_in_idcontext (
    const char*         id,             
    const char*         rev_id,         
    tag_t               idcontext_tag,  
    int*                num_revs,       
    tag_t**             rev_tags        
    );

extern TCCORE_API int ITEM_id_exists(
    const char*         id,         
    logical*            verdict     
    );

extern TCCORE_API int ITEM_id_owners (
    const char*         id,         
    int*                num_objs,   
    tag_t**             obj_tags    
    );

extern TCCORE_API void ITEM_free_exclude_list();

extern TCCORE_API void ITEM_build_exclude_list(
    int                  array_length,  
    tag_t*               exclude_array  
    );

extern TCCORE_API void ITEM_get_exclude_list(
    int*                 count,         
    tag_t**              exclude_list   
    );

extern TCCORE_API int ITEM_ask_master_form_type(
    const char * itemType,    
    char ** formType          
    );

extern TCCORE_API int ITEM_ask_rev_master_form_type(
    const char * itemType,    
    char ** formType          
    );

extern TCCORE_API int ITEM_rev_vi_rev_find
    ( tag_t generic_item_rev,      /* (I) */
      int n,                       /* (I) */
      tag_t *items,                /* (I) n */
      char **options,              /* (I) n */
      int *ops,                    /* (I) n */
      int *valueTypes,             /* (I) n */
      char **lowValues,            /* (I) n */
      char **highValues,           /* (I) n */
      int *n_matches,              /* (O) */
      tag_t **matches              /* (OF) n_matches */
    );

extern TCCORE_API int ITEM_vi_rev_ask_linked_generic_component
    ( tag_t         variant_item_rev,               /* <I> */
      tag_t*        module_item_rev     /* <O> */
    );

extern TCCORE_API int ITEM_rev_vi_revise_and_update
    ( tag_t         bom_line,           /* <I> */
      tag_t         generic_item_rev,   /* <I> */
      tag_t         old_variant_item_rev,   /* <I> */
      tag_t*        new_variant_item_rev     /* <O> */
    );

extern TCCORE_API int ITEM_ask_has_global_alternates
(
    tag_t    item,                 
    logical* has_global_alternates 
);


extern TCCORE_API int ITEM_rev_sequence_make_immune (
  tag_t   item_rev_tag /*<I> */
  );

extern TCCORE_API int ITEM_rev_purge_sequences (
  tag_t   item_rev_tag /*<I>*/
  );

extern TCCORE_API int ITEM_rev_sequence_is_latest (
   tag_t         item_rev_tag,    /* <I> */
   logical*      is_latest        /* <O> */
  );

extern TCCORE_API int ITEM_rev_sequence_remove_immunity (
  tag_t   item_rev_tag /*<I>*/
  );

extern TCCORE_API int ITEM_rev_restore_previous_sequence (
  tag_t   item_rev_tag /*<I>*/
  );

extern TCCORE_API int ITEM_list_related_global_alternates
(
    tag_t    item,           
    int*     n_objs,         
    tag_t**  related_objs    
);

extern TCCORE_API int ITEM_add_related_global_alternates
(
    tag_t    item,           
    int      n_objs,         
    tag_t*   added_objs      
);

extern TCCORE_API int ITEM_remove_related_global_alternates
(
    tag_t    item,           
    int      n_objs,         
    tag_t*   removed_objs    
);

extern TCCORE_API int ITEM_prefer_global_alternate
(
    tag_t    item,           
    tag_t    preferred_item  
);

extern TCCORE_API int ITEM_rev_has_been_baselined_during_current_operation
    ( tag_t          item_rev,            
      logical        *verdict,            
      tag_t          *new_item_rev        
    );

extern TCCORE_API int ITEM_rev_set_participants
(
    tag_t item_rev,                     
    int participant_count,              
    tag_t * participant_list            
);

extern TCCORE_API int ITEM_rev_ask_participants
(
    tag_t item_rev,                     
    tag_t participant_type,             
    int * participant_count,            
    tag_t ** participant_list           
);

extern TCCORE_API int ITEM_rev_add_participant
(
    tag_t item_rev,                     
    tag_t participant                   
);

extern TCCORE_API int ITEM_rev_remove_participant
(
    tag_t item_rev,                     
    tag_t participant                   
);


extern TCCORE_API int ITEM_rev_rename_cad_file
(
    logical *status                   
);

extern TCCORE_API int ITEM_rev_get_cloned_item_rev
(
    tag_t old_item_rev,                 
    tag_t *cloned_item_rev              
);

extern TCCORE_API int ITEM_is_product_item
(
    tag_t          item,                
    logical*       is_product_item      
);

extern TCCORE_API int ITEM_new_revision_id
(
    tag_t item,      
    tag_t item_type, 
    logical* mod,    
    char** id        
);

extern TCCORE_API int ITEM_rev_is_immune
(
    tag_t        itemRevisionTag,        
    logical*    isImmune                
);
#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif

---