ps.h

Go to the documentation of this file.

/*
   ===============================================
   Copyright 2006 UGS Corp. All Rights Reserved.
   ===============================================
*/


#ifndef PS_H_INCLUDED
#define PS_H_INCLUDED

#include <ps/ps_errors.h>
#include <ps/ps_tokens.h>
#include <unidefs.h>
#include <ps/libps_exports.h>

/* END OF HEADER */

#ifdef __cplusplus
 extern "C"{
#endif

extern PS_API int PS_view_type_ask_valid_occurrence_types(
    tag_t         type_tag,     
    tag_t**       valid_occs,   
    int*          count         
    );

extern PS_API int PS_view_type_ask_default_occurrence_type(
    tag_t         view_type_tag,    
    tag_t*        occ_type_tag      
    );

extern PS_API int PS_ask_view_type_name(
    tag_t         view_type,    
    char**        type_name     
    );

extern PS_API int PS_find_view_type(
    const char*   type_name,    
    tag_t*        view_type     
    );

extern PS_API int PS_view_type_extent(
    int*          n_types,      
    tag_t**       view_types    
    );

extern PS_API int PS_get_displayable_view_types(
    int*          n_types,      
    tag_t**       view_types    
    );

extern PS_API int PS_ask_default_view_type(
    tag_t*        view_type     
    );

extern PS_API int PS_find_occurrence_type(
    const char*   type_name,    
    tag_t*        occ_type      
    );

extern PS_API int PS_occurrence_type_extent(
    int*          n_types,      
    tag_t**       occ_types     
    );

extern PS_API int PS_ask_occurrence_type_name(
    tag_t         occ_type,     
    char**        type_name     
    );

extern PS_API int PS_create_bom_view(
    tag_t         view_type,    
    const char*   view_name,    
    const char*   view_desc,    
    tag_t         parent_item,  
    tag_t*        bom_view      
    );

extern PS_API int PS_default_bom_view_name(
    tag_t         item,         
    tag_t         view_type,    
    char**        name          
    );

extern PS_API int PS_delete_bom_view(
    tag_t         bom_view      
    );

extern PS_API int PS_ask_item_of_bom_view(
    tag_t         bom_view,     
    tag_t*        item          
    );

extern PS_API int PS_ask_bom_view_type(
    tag_t         bom_view,     
    tag_t*        view_type     
    );

extern PS_API int PS_set_bom_view_type(
    tag_t         bom_view,     
    tag_t         view_type     
    );

extern PS_API int PS_list_bvrs_of_bom_view(
    tag_t         bom_view,     
    int*          n_bvrs,       
    tag_t**       bvrs          
    );

extern PS_API int PS_create_bvr(
    tag_t         bom_view,         
    const char*   revision_name,    
    const char*   revision_desc,    
    logical       precise,          
    tag_t         parent_ir,        
    tag_t*        bvr               
    );

extern PS_API int PS_revise_bvr(
    tag_t         source_bvr,       
    const char*   revision_name,    
    const char*   revision_desc,    
    tag_t         parent_ir,        
    tag_t*        new_bvr           
    );

extern PS_API int PS_copy_bvr(
    tag_t         source_bvr,       
    tag_t         bom_view,         
    const char*   revision_name,    
    const char*   revision_desc,    
    tag_t         parent_ir,        
    tag_t*        new_bvr           
    );

extern PS_API int PS_bvr_translate_mvl(
    tag_t         bvr,              
    int           n_modules,        
    char**        from_modules,     
    char**        to_modules        
    );

extern PS_API int PS_default_bvr_name(
    tag_t         item_revision,    
    tag_t         view_type,        
    char**        name              
    );

extern PS_API int PS_delete_bvr(
    tag_t         bvr   
    );

extern PS_API int PS_ask_bom_view_of_bvr(
    tag_t         bvr,      
    tag_t*        bom_view  
    );

extern PS_API int PS_ask_is_bvr_precise(
    tag_t         bvr,          
    logical*      is_precise    
    );

extern PS_API int PS_set_bvr_precise(
    tag_t         bvr   
    );

extern PS_API int PS_set_bvr_imprecise(
    tag_t         bvr   
    );

extern PS_API int PS_list_occurrences_of_bvr(
    tag_t         bvr,              
    int*          n_occurrences,    
    tag_t**       occurrences       
    );

extern PS_API int PS_list_owning_revs_of_bvr(
    tag_t         bvr,          
    int*          n_item_revs,  
    tag_t**       item_revs     
    );

extern PS_API int PS_ask_is_bvr_shared(
    tag_t         bvr,          
    logical*      is_shared     
    );

extern PS_API int PS_ask_struct_modified_date(
    tag_t         bvr,          
    date_t*       struct_dlm    
    );

extern PS_API int PS_ask_legacy_transform_factor(
    tag_t         bvr,             
    double*       legacy_factor    
    );

extern PS_API int PS_set_legacy_transform_factor(
    tag_t         bvr,          
    double        legacy_factor 
    );

extern PS_API int PS_remove_legacy_transform_factor(
    tag_t         bvr   
    );

extern PS_API int PS_add_predecessor(
    tag_t         bvr,          
    tag_t         occ,          
    tag_t         predecessor   
   );

extern PS_API int PS_remove_predecessor(
    tag_t         bvr,          
    tag_t         occ,          
    tag_t         predecessor   
   );

extern PS_API int PS_list_predecessors(
    tag_t         bvr,      
    tag_t         occ,      
    int*          count,    
    tag_t**       pred      
   );

extern PS_API int PS_create_occurrences(
    tag_t         parent,           
    tag_t         child_item,       
    tag_t         child_bom_view,   
    int           n_occurrences,    
    tag_t**       occurrences       
    );
extern PS_API int PS_create_occurrences_with_occ_type(
    tag_t         parent,           
    tag_t         child_item,       
    tag_t         child_bom_view,   
    int           n_occurrences,    
    tag_t         occType,          
    tag_t**       occurrences       
    );

extern PS_API int PS_create_occurrences_tag_validation(
    tag_t         parent,           
    tag_t         child_item,       
    int           n_occurrences     
    );
  
extern PS_API int PS_verify_occurrence_conditions
(
      tag_t     parent_rev_tag,     
      tag_t     child_rev_tag       
);
extern PS_API int PS_delete_occurrence(
    tag_t         parent,       
    tag_t         occurrence    
    );

extern PS_API int PS_set_occurrence_type(
    tag_t         parent,           
    tag_t         occurrence,       
    const char*   occTypeString     
    );

extern PS_API int PS_ask_occurrence_type(
    tag_t         parent,           
    tag_t         occurrence,       
    char**        occTypeString     
    );

extern PS_API int PS_ask_occurrence_child(
    tag_t         parent,           
    tag_t         occurrence,       
    tag_t*        child_item,       
    tag_t*        child_bom_view    
    );

extern PS_API int PS_set_occurrence_child(
    tag_t         parent,           
    tag_t         occurrence,       
    tag_t         child_item,       
    tag_t         child_bom_view    
    );

extern PS_API int PS_ask_seq_no(
    tag_t         parent,       
    tag_t         occurrence,   
    char**        seq_no        
    );

extern PS_API int PS_set_seq_no(
    tag_t         parent,       
    tag_t         occurrence,   
    const char*   seq_no        
    );

extern PS_API int PS_ask_occurrence_name(
    tag_t         parent,           
    tag_t         occurrence,       
    char**        occurrence_name   
    );

extern PS_API int PS_set_occurrence_name(
    tag_t         parent,           
    tag_t         occurrence,       
    const char*   occurrence_name   
    );

extern PS_API int PS_ask_occ_clone_stable_uid(
    tag_t   parent,             
    tag_t   occurrence,         
    char**  clone_stable_uid    
    );

extern PS_API int PS_ask_occurrence_ref_designator(
    tag_t         parentBVR,         
    tag_t         occThread,         
    char**        refDesignator      
    );

extern PS_API int PS_set_occurrence_ref_designator(
    tag_t         parentBVR,         
    tag_t         occThread,      
    const char    *refDesignator  
    );

extern PS_API int PS_ask_occurrence_qty(
    tag_t         parent,       
    tag_t         occurrence,   
    double*       qty           
    );

extern PS_API int PS_set_occurrence_qty(
    tag_t         parent,       
    tag_t         occurrence,   
    double        qty           
    );

extern PS_API int PS_ask_occurrence_flag(
    tag_t         parent,       
    tag_t         occurrence,   
    int           flag,         
    logical*      is_set        
    );

extern PS_API int PS_set_occurrence_flag(
    tag_t         parent,       
    tag_t         occurrence,   
    int           flag          
    );

extern PS_API int PS_clear_occurrence_flag(
    tag_t         parent,       
    tag_t         occurrence,   
    int           flag          
    );

extern PS_API int PS_ask_transform(
    tag_t         parent,       
    tag_t         occurrence,   
    double**      transform     
    );

extern PS_API int PS_ask_plmxml_transform(
    tag_t         parent,       
    tag_t         occurrence,   
    double**      transform     
    );

extern PS_API int PS_set_plmxml_transform(
    tag_t         parent,       
    tag_t         occurrence,   
    double*       transform     
    );

extern PS_API int PS_convert_legacy_transform(
    tag_t         parent,           
    tag_t         occurrence,       
    double**      ext_transform     
    );

extern PS_API int PS_move_occurrence_to(
    tag_t         parent,       
    tag_t         occurrence,   
    int           new_index     
    );

extern PS_API int PS_move_occurrence_up(
    tag_t         parent,       
    tag_t         occurrence    
    );

extern PS_API int PS_move_occurrence_down(
    tag_t         parent,       
    tag_t         occurrence    
    );

extern PS_API int PS_list_occurrence_notes(
    tag_t         parent,       
    tag_t         occurrence,   
    int*          n_notes,      
    tag_t**       note_types    
    );

extern PS_API int PS_ask_occurrence_note_text(
    tag_t         parent,       
    tag_t         occurrence,   
    tag_t         note_type,    
    char**        text          
    );

extern PS_API int PS_set_occurrence_note_text(
    tag_t         parent,       
    tag_t         occurrence,   
    tag_t         note_type,    
    const char*   text          
    );

extern PS_API int PS_delete_occurrence_note(
    tag_t         parent,       
    tag_t         occurrence,   
    tag_t         note_type     
    );

extern PS_API int PS_list_substitutes(
    tag_t         parent,           
    tag_t         occurrence,       
    int*          n_substitutes,    
    tag_t**       sub_items,        
    tag_t**       sub_views         
    );

extern PS_API int PS_ask_has_substitutes(
    tag_t         parent,           
    tag_t         occurrence,       
    logical*      has_substitutes   
    );

extern PS_API int PS_add_substitute(
    tag_t         parent,           
    tag_t         occurrence,       
    tag_t         child_item,       
    tag_t         child_bom_view    
    );

extern PS_API int PS_delete_substitute(
    tag_t         parent,       
    tag_t         occurrence,   
    tag_t         child_item    
    );

extern PS_API int PS_prefer_substitute(
    tag_t         parent,       
    tag_t         occurrence,   
    tag_t         child_item,   
    logical*      is_temporary  
    );

extern PS_API int PS_ask_has_variant_data(
    tag_t         parent,           
    tag_t         occurrence,       
    logical*      has_variant_data  
    );

extern PS_API int PS_ask_variant_data(
    tag_t         parent,                   
    tag_t         occurrence,               
    tag_t*        variant_expression_block  
    );

extern PS_API int PS_set_variant_data(
    tag_t         parent,                   
    tag_t         occurrence,               
    tag_t         variant_expression_block  
    );

extern PS_API int PS_load_variant_expr_blocks(
    int           n_blocks,                  
    tag_t *       variant_expression_blocks, 
    logical       force_sub_expr_check       
    );

extern PS_API int PS_load_variant_exprs(
    int           n_exprs,                   
    tag_t *       variant_expressions,       
    logical       force_sub_expr_check       
    );

extern PS_API int PS_define_client_data(
    int           ps_class,     
    const char*   attr_name,    
    tag_t         ref_class,    
    int           property      
    );

#ifdef __cplusplus
}
#endif

#ifdef __cplusplus
 extern "C"{
#endif

extern PS_API int PS_delete_client_data_defn(
    int           ps_class,     
    const char*   attr_name     
    );

extern PS_API int PS_describe_client_data(
    int           ps_class,     
    const char*   attr_name,    
    tag_t*        ref_class,    
    int*          property      
    );

extern PS_API int PS_ask_client_data(
    tag_t         instance,     
    const char*   attr_name,    
    tag_t*        client_data   
    );

extern PS_API int PS_set_client_data(
    tag_t         instance,     
    const char*   attr_name,    
    tag_t         client_data   
    );

extern PS_API int PS_ask_occurrence_client_data(
    tag_t         parent,       
    tag_t         occurrence,   
    const char*   attr_name,    
    tag_t*        client_data   
    );

extern PS_API int PS_set_occurrence_client_data(
    tag_t         parent,       
    tag_t         occurrence,   
    const char*   attr_name,    
    tag_t         client_data   
    );

extern PS_API int PS_note_type_extent(
    int*          n_note_types,     
    tag_t**       note_types        
    );

extern PS_API int PS_find_note_type(
    const char*   name,         
    tag_t*        note_type     
    );

extern PS_API int PS_ask_note_type_name(
    tag_t         note_type,    
    char**        name          
    );

extern PS_API int PS_ask_note_type_description(
    tag_t         note_type,    
    char**        description   
    );

extern PS_API int PS_ask_note_type_default_value(
    tag_t         note_type,        
    char**        default_value     
    );

extern PS_API int PS_where_used_all(
    tag_t         target_tag,       
    int           n_levels,         
    int*          n_parents,        
    int**         levels,           
    tag_t**       parents           
    );

extern PS_API int PS_where_used_precise(
    tag_t         target_tag,       
    int           n_levels,         
    int*          n_parents,        
    int**         levels,           
    tag_t**       parents           
    );

extern PS_API int PS_where_used_configured(
    tag_t         target_tag,       
    tag_t         rev_rule,         
    int           n_levels,         
    int*          n_parents,        
    int**         levels,           
    tag_t**       parents           
    );

extern PS_API int PS_system_default_bom_view_name(
    tag_t         item,         
    tag_t         view_type,    
    char**        name          
    );

extern PS_API int PS_system_default_bvr_name(
    tag_t         item_revision,    
    tag_t         view_type,        
    char**        name              
    );

extern PS_API int PS_has_form_attached_to_ug_dataset(
    tag_t         item_rev,     
    logical*      result        
    );
extern PS_API int PS_list_related_substitutes
(
    tag_t    occurrence,     
    tag_t    sub_item,       
    int      *n_items,       
    tag_t    **related_occs, 
    tag_t    **related_items 
);

extern PS_API int PS_add_related_substitutes
(
    int      n_items,        
    tag_t    *occurrences,   
    tag_t    *sub_items,     
    tag_t    *substitute_set 
);

extern PS_API int PS_remove_related_substitutes
(
    int      n_items,        
    tag_t    *occurrences,   
    tag_t    *sub_items      
);

extern PS_API int PS_change_to_replace(tag_t oldBvr,       
                                       tag_t oldOccTag,    
                                       tag_t newBvr,       
                                       tag_t newOccTag     
                                     );
extern PS_API int PS_bvr_ask_default_next_seq_no(
    tag_t         bvr,          
    tag_t         child_item,   
    char**        seq_no        
    );

extern PS_API int PS_occ_eff_create(
    tag_t   bvr,         
    tag_t   occ,         
    tag_t * eff          
    );

extern PS_API int PS_occ_eff_add_eff(
    tag_t    bvr,           
    tag_t    occ,           
    tag_t    eff            
    );

extern PS_API int PS_occ_eff_remove_eff(
    tag_t    bvr,           
    tag_t    occ,           
    tag_t    eff            
    );

extern PS_API int PS_occ_eff_set_id(
    tag_t        bvr,     
    tag_t        occ,     
    tag_t        eff,     
    const char * id       
    );

extern PS_API int PS_occ_eff_set_protection(
    tag_t       bvr,        
    tag_t       occ,        
    tag_t       eff,        
    logical     protection  
    );

extern PS_API int PS_occ_eff_set_enditem(
    tag_t    bvr,         
    tag_t    occ,         
    tag_t    eff,         
    tag_t    enditem      
    );

extern PS_API int PS_occ_eff_set_enditemrev(
    tag_t    bvr,         
    tag_t    occ,         
    tag_t    eff,         
    tag_t    enditemrev   
    );

extern PS_API int PS_occ_eff_set_unit_range(
    tag_t        bvr,           
    tag_t        occ,           
    tag_t        eff,           
    const char * range_text,    
    logical      append         
    );

extern PS_API int PS_occ_eff_set_units(
    tag_t       bvr,                       
    tag_t       occ,                       
    tag_t       eff,                       
    int         n_units,                   
    int*        start_end_values,          
    int         open_ended_or_stock_out,   
    logical     append                     
    );

extern PS_API int PS_occ_eff_set_date_range(
    tag_t        bvr,            
    tag_t        occ,            
    tag_t        eff,            
    const char * range_text,     
    logical      append          
    );

extern PS_API int PS_occ_eff_set_dates(
    tag_t       bvr,                       
    tag_t       occ,                       
    tag_t       eff,                       
    int         n_dates,                   
    date_t*     start_end_values,          
    int         open_ended_or_stock_out,   
    logical     append                     
    );

extern PS_API int PS_occ_eff_ask_effs(
    tag_t    bvr,           
    tag_t    occ,           
    int *    n_effs,        
    tag_t ** effs           
    );

extern PS_API int PS_occ_eff_ask_id(
    tag_t     bvr,         
    tag_t     occ,         
    tag_t     eff,         
    char **   id           
    );

extern PS_API int PS_occ_eff_ask_protection(
    tag_t     bvr,         
    tag_t     occ,         
    tag_t     eff,         
    logical * protection   
    );

extern PS_API int PS_occ_eff_ask_enditem(
    tag_t    bvr,            
    tag_t    occ,            
    tag_t    eff,            
    tag_t *  enditem         
    );

extern PS_API int PS_occ_eff_ask_enditemrev(
    tag_t    bvr,            
    tag_t    occ,            
    tag_t    eff,            
    tag_t *  enditemrev      
    );

extern PS_API int PS_occ_eff_ask_range_type(
    tag_t       bvr,            
    tag_t       occ,            
    tag_t       eff,            
    int*        range_type      
    );

extern PS_API int PS_occ_eff_ask_unit_range(
    tag_t       bvr,            
    tag_t       occ,            
    tag_t       eff,            
    char **     range_text      
    );

extern PS_API int PS_occ_eff_ask_units(
    tag_t       bvr,                        
    tag_t       occ,                        
    tag_t       eff,                        
    int*        n_units,                    
    int**       start_end_values,           
    int*        open_ended_or_stock_out     
    );

extern PS_API int PS_occ_eff_ask_date_range(
    tag_t       bvr,            
    tag_t       occ,            
    tag_t       eff,            
    char **     range_text      
    );

extern PS_API int PS_occ_eff_ask_dates(
    tag_t       bvr,                        
    tag_t       occ,                        
    tag_t       eff,                        
    int*        n_dates,                    
    date_t**    start_end_values,           
    int*        open_ended_or_stock_out     
    );

extern PS_API int PS_add_optional_item
(
    tag_t   parent,           
    tag_t   occurrence,       
    tag_t   child_item,       
    tag_t   opt_item,         
    tag_t   opt_rev,          
    tag_t   opt_view,         
    tag_t   *optlist          
);

extern PS_API int PS_remove_optional_item
(
    tag_t   parent,          
    tag_t   occurrence,      
    tag_t   child_item,      
    tag_t   opt_item,        
    tag_t   opt_rev,         
    tag_t   opt_view         
);

extern PS_API int PS_list_optional_items
(
    tag_t   parent,           
    tag_t   occurrence,       
    tag_t   child_item,       
    int     *count,           
    tag_t   **opt_items       
);

extern PS_API int PS_ask_latest_option_rev
    ( tag_t     variant,
      tag_t    *variantRev
    );


extern PS_API int PS_variant_expression_new_persistent_id(
    char** variant_expression_persistent_id     
    );

#ifdef __cplusplus
}
#endif

#include <ps/libps_undef.h>

#endif