asmaintained.h

Go to the documentation of this file.

/*==============================================================================
//Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
//==================================================
//Copyright $2008.
//Siemens Product Lifecycle Management Software Inc.
//All Rights Reserved.
//==================================================
//Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
 ==============================================================================*/

#ifndef ASMAINTAINED_H
#define ASMAINTAINED_H

#include <mrocore/mrocore.h>

#include <asmaintained/libasmaintained_exports.h>


typedef struct ASMAINTAINED_API ASMAINTAINED_saved_queries_info_s {

    tag_t pom_query;       
    char * name;           
    char * desc;           
} ASMAINTAINED_saved_queries_info_t;

typedef struct ASMAINTAINED_API GenerateAsmStructureParams
{
    char*       partNumber;         
    char*       serialNumber;       
    char*       lotNumber;          
    char*       manufacturerId;     
    char*       structureContext;   
    char*       locationName;       
    char*       dispositionType;    
    date_t      installationDate;   
    date_t      manufactureDate;    
    date_t      effectiveFromDate;  
    date_t      effectiveToDate;    
    logical     useSrlNoGen;        
    int         numberOfLevels;     
    double      physicalQuantity;   
}GenerateAsmStructureParams;

typedef struct ASMAINTAINED_API InstallAsmPhysPartParams
{
    char*   usagePropertyValue;     
    date_t  installationDate;       
}InstallAsmPhysPartParams;

typedef struct ASMAINTAINED_API ASMAINTAINED_uninstall_params_s
{
    char*   dispositionName;            
    char*   locationName;               
    date_t  unInstallDate;              
}ASMAINTAINED_uninstall_params_s;

typedef struct ASMAINTAINED_physical_children_s
{
    tag_t     childPhysPart;          
    tag_t     childPhysPartRev;       
    tag_t     asmStrucRelation;       
} ASMAINTAINED_physical_children_t;

typedef struct ASMAINTAINED_API SearchInstallableAsmPhysPartParams
{
    int                        preferredCount;                 
    tag_t*                     prefPhysPartRevs;               
    int                        alternateCount;                 
    tag_t*                     altPhysPartRevs;                
    int                        substituteCount;                
    tag_t*                     subPhysPartRevs;                
    int                        deviatedCount;                  
    tag_t*                     devPhysPartRevs;                
}SearchInstallableAsmPhysPartParams;

#ifdef __cplusplus
    extern "C"{
#endif

extern ASMAINTAINED_API int ASMAINTAINED_line_set_window_top(
    tag_t          window,                 
    tag_t          physicalPart,           
    tag_t          physicalPartRev,        
    tag_t*         topBOMLine              
    );

extern ASMAINTAINED_API int ASMAINTAINED_line_ask_all_child_lines(
    tag_t          bom_line,           
    int*           count,              
    tag_t**        children            
    );

extern ASMAINTAINED_API int ASMAINTAINED_gen_phystruc(
    tag_t                       inLine,       
    GenerateAsmStructureParams* inParam,      
    tag_t*                      phys_rev      
    );

extern ASMAINTAINED_API int ASMAINTAINED_create_compare_desc();

extern ASMAINTAINED_API int ASMAINTAINED_bom_compare(
    tag_t* srcLines,            
    int srcLineCount,           
    tag_t* tarLines,            
    int tarLineCount,           
    int options,                
    tag_t assyCtxtLineTag,      
    tag_t bomCtxtLineTag,       
    int* srcRetCount,           
    tag_t** srcRetTags,         
    int* matRetCount,           
    tag_t** matRetTags          
    );

extern ASMAINTAINED_API int ASMAINTAINED_bom_compare_no_context(
    tag_t       srcLine,            
    tag_t       tarLine,            
    const char  *mode_name,         
    int         output_to,          
    int         * srcRetCount,       
    tag_t       ** srcRetTags,       
    int         * matRetCount,       
    tag_t       ** matRetTags,       
    int         * reportLength,      
    char        *** report_lines     
    );

extern ASMAINTAINED_API int ASMAINTAINED_get_all_open_usage(
    tag_t       inLine,                 
    tag_t       childPhysicalPart,      
    char***     openUsages,             
    int*        count,                  
    tag_t**     childBOMLine            
    );


extern ASMAINTAINED_API int ASMAINTAINED_get_all_open_usage_2(
    tag_t       parentPhysicalPartRevision,     
    tag_t       childPhysicalPart,              
    char***     openUsages,                     
    int*        count,                          
    tag_t**     childBOMLine                    
    );

extern ASMAINTAINED_API int ASMAINTAINED_install_physical_part(
    tag_t                           selectedAsMaintainedLine,       
    tag_t                           copiedPhysicalPart,             
    tag_t                           usageBOMLineImpl,               
    InstallAsmPhysPartParams*       inParams,                       
    tag_t*                          asMaintainedStructure,          
    tag_t*                          installedLineTag                
    );

extern ASMAINTAINED_API int ASMAINTAINED_uninstall_physical_part(
    tag_t                                   selectedAsMaintainedLine,       
    ASMAINTAINED_uninstall_params_s*        inParams,                       
    tag_t*                                  replacerLine                    
    );

extern ASMAINTAINED_API int ASMAINTAINED_physlocationline_set_window_top(
    tag_t          window,                 
    tag_t          physicalLocation,       
    tag_t*         topBOMLine              
    );

extern ASMAINTAINED_API int ASMAINTAINED_get_effective_physical_part_revision(
    tag_t   physPart,                
    date_t  effectiveDate,           
    tag_t*  physPartRev              
    );

extern ASMAINTAINED_API int ASMAINTAINED_create_window(
    tag_t*   window                  
    );

extern ASMAINTAINED_API int ASMAINTAINED_get_children(
    tag_t                               physPart,       
    date_t                              effectiveDate,  
    ASMAINTAINED_physical_children_t**  children,       
    int*                                childCount      
    );

extern ASMAINTAINED_API int ASMAINTAINED_apply_revision_rule(
    tag_t    topLine,                      
    tag_t    mroRevRule,                   
    tag_t*   configuredTopLine             
    );

extern ASMAINTAINED_API int ASMAINTAINED_get_physical_part_parent(
    tag_t   physPart,           
    date_t  effectiveDate,      
    tag_t*  parentPhysPartRev,  
    tag_t*  asmStrucRel         
    );

extern ASMAINTAINED_API int ASMAINTAINED_get_root_physical_part(
    tag_t   physPart,           
    date_t  effectiveDate,      
    tag_t*  rootPhysPartRev     
    );

extern ASMAINTAINED_API int ASMAINTAINED_maintain_physical_part_revision(
    tag_t   oldPhysPartRevTag,          
    date_t  effectiveFromDate,          
    tag_t*  outPhysPartRevTag);         
extern ASMAINTAINED_API int ASMAINTAINED_replace_physical_part(
    tag_t                            selectedAsMaintainedLine,       
    tag_t                            copiedPhysicalPart,             
    ASMAINTAINED_uninstall_params_s  * inParams,                       
    tag_t*                           asMaintainedStructure,          
    tag_t*                           replacedLineTag                 
    );

extern ASMAINTAINED_API int ASMAINTAINED_change_physical_part_disposition(
    tag_t   physPart,            
    tag_t   disposition,         
    date_t  dispStartDate,       
    tag_t*  dispRelation         
    );

extern ASMAINTAINED_API int ASMAINTAINED_move_physical_part(
    tag_t physPart,             
    tag_t location,             
    date_t inTime,              
    tag_t *relation);           
extern ASMAINTAINED_API int ASMAINTAINED_search_installable_physical_part_revisions
(
    tag_t                               selParentPhysBOMLine,           
    tag_t                               selectedBOMLineImpl,            
    int                                 attrCount,                      
    char**                              attributeNames,                 
    char**                              attributeValues,                
    SearchInstallableAsmPhysPartParams* outParams                       
);

extern ASMAINTAINED_API int ASMAINTAINED_get_current_physical_part_location
(
    tag_t physical_part_revision,           
    tag_t* location,                        
    tag_t* relation                         
);

extern ASMAINTAINED_API int ASMAINTAINED_get_current_physical_part_disposition
(
    tag_t physical_part_revision,         
    tag_t* disposition,                   
    tag_t* relation                       
);

extern ASMAINTAINED_API int ASMAINTAINED_convert_uids_into_bom_lines(
    int count,                          
    const char** bom_line_uids,         
    tag_t** bom_lines                   
);

extern ASMAINTAINED_API int ASMAINTAINED_generate_recipe(
    tag_t asmaintained_bom_line,                   
    char** recipe                                  
);

extern ASMAINTAINED_API int ASMAINTAINED_get_saved_queries_info
(
    int *num_queries,                              
    ASMAINTAINED_saved_queries_info_t*** queries   
);

extern ASMAINTAINED_API int ASMAINTAINED_get_neutral_part_children_list(
    tag_t    neutral_bom_line,         
    int*     count_lines,              
    tag_t**  child_bom_lines,          
    tag_t**  occurrence_tags           
);

extern ASMAINTAINED_API int ASMAINTAINED_get_physical_part_children_list(
    tag_t   physical_bom_line,         
    int*    count_lines,               
    tag_t** child_bom_lines,           
    tag_t** occurrence_tags            
);

extern ASMAINTAINED_API int ASMAINTAINED_get_locale_location_and_disposition
(
   char**  location_prop_name,        
   char**  disposition_prop_name      
);

extern ASMAINTAINED_API int ASMAINTAINED_validation_for_replace(
   tag_t parent_physical_part_item,            
   tag_t parent_physical_part_item_revision,   
   tag_t copied_physical_item_rev,             
   tag_t selected_asmaintained_bom_line,       
   date_t installation_date,                   
   date_t validation_manf_date                 
);
extern ASMAINTAINED_API int ASMAINTAINED_convert_uids_into_bom_lines_with_flag(
    int count,                          
    const char** bom_line_uids,         
    logical show_untraced_parts,        
    tag_t** bom_lines                   
);

#ifdef __cplusplus
    }
#endif


#include <asmaintained/libasmaintained_undef.h>

#endif