dmi.h

Go to the documentation of this file.

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

/*  */

#ifndef DMI_ITK_H_INCLUDED
#define DMI_ITK_H_INCLUDED
#include <tccore/workspaceobject.h>
#include <dmi/dmi_const.h>
#include <dmi/libdmi_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

extern DMI_API int DMI_store_image_file (
    tag_t          image,                                      
    const char     image_file_name[DMI_file_name_size_c + 1],  
    const char     path_name[DMI_path_name_size_c + 1]         
    );


extern DMI_API int DMI_store_image_file2 (
    tag_t          image,                                      
    const char     *image_file_name,                           
    const char     *path_name                                  
    );

extern DMI_API int DMI_fetch_image_file (
    tag_t          image,                                   
    const char     dest_dir[DMI_path_name_size_c + 1] ,     
    char           image_name[DMI_file_name_size_c + 1]     
    );

extern DMI_API int DMI_fetch_image_file2 (
    tag_t          image,                                   
    const char     *dest_dir ,                              
    char           **image_name                             
    );


extern DMI_API int DMI_store_thumbnail_file (
    tag_t          image,                                         
    const char     thumbnail_file_name[DMI_file_name_size_c + 1], 
    const char     path_name[DMI_path_name_size_c + 1]            
    );


extern DMI_API int DMI_store_thumbnail_file2 (
    tag_t          image,                                         
    const char     *thumbnail_file_name,                          
    const char     *path_name                                     
    );


extern DMI_API int DMI_fetch_thumbnail_file (
    tag_t          image,                                         
    const char     dest_dir[DMI_path_name_size_c + 1],            
    char           thumbnail_name[DMI_file_name_size_c + 1]       
    );


extern DMI_API int DMI_fetch_thumbnail_file2 (
    tag_t          image,                                         
    const char     *dest_dir,                                     
    char           **thumbnail_name                               
    );

extern DMI_API int DMI_ask_image_markups (
    tag_t          image,           
    tag_t          markup_type,     
    int*           n_markups,       
    tag_t**        markups          
    );

extern DMI_API int DMI_fetch_image_markup_files (
    tag_t          image,                                
    const char     dest_dir[DMI_path_name_size_c + 1],   
    int*           n_files,                              
    char**         image_file,                           
    char***        markup_files                          
    );


extern DMI_API int DMI_fetch_image_markup_files2 (
    tag_t          image,                                
    const char     *dest_dir,                            
    int*           n_files,                              
    char**         image_file,                           
    char***        markup_files                          
    );


extern DMI_API int DMI_merge_image_markup_files (
    tag_t          image,            
    tag_t          markup_type,      
    tag_t*         new_markup        
    );

extern DMI_API int DMI_verify_image (
    tag_t          image,            
    logical*       answer            
    );

extern DMI_API int DMI_delete_image(
    tag_t          image         
    );

extern DMI_API int DMI_create_markup (
    tag_t          image,                             
    const char     markup_name[WSO_name_size_c + 1],  
    const char     markup_desc[WSO_desc_size_c + 1],  
    const char     markup_type[WSO_name_size_c + 1],  
    tag_t*         markup                             
    );


extern DMI_API int DMI_create_markup2 (
    tag_t          image,                             
    const char     *markup_name,                      
    const char     *markup_desc,                      
    const char     *markup_type,                      
    tag_t*         markup                             
    );

extern DMI_API int DMI_delete_markup (
    tag_t          markup               
    );

extern DMI_API int DMI_update_markup (
    tag_t          markup               
    );

extern DMI_API int DMI_fetch_markup_file (
    tag_t          markup,                              
    const char     dest_dir[DMI_path_name_size_c + 1],  
    char**         image_file,                          
    char**         markup_file                          
    );


extern DMI_API int DMI_fetch_markup_file2 (
    tag_t          markup,                              
    const char     *dest_dir,                           
    char**         image_file,                          
    char**         markup_file                          
    );


extern DMI_API int DMI_store_markup_file (
    tag_t          markup,                                        
    const char     markup_file_name[DMI_file_name_size_c + 1],    
    const char     path_name[DMI_path_name_size_c + 1]            
    );


extern DMI_API int DMI_store_markup_file2 (
    tag_t          markup,                                        
    const char     *markup_file_name,                             
    const char     *path_name                                     
    );

extern DMI_API int DMI_revise_image (
    tag_t          image,                                          
    const char     image_file_name [DMI_file_name_size_c + 1],     
    const char     path_name [DMI_path_name_size_c + 1],           
    tag_t*         new_image_rev                                   
    );


extern DMI_API int DMI_revise_image2 (
    tag_t          image,                                          
    const char     *image_file_name ,                              
    const char     *path_name ,                                    
    tag_t*         new_image_rev                                   
    );


extern DMI_API int DMI_revise_thumbnail (
    tag_t          image,                                          
    const char     thumbnail_file_name [DMI_file_name_size_c + 1], 
    const char     path_name [DMI_path_name_size_c + 1],           
    tag_t*         new_image_rev                                   
    );


extern DMI_API int DMI_revise_thumbnail2 (
    tag_t          image,                                          
    const char     *thumbnail_file_name ,                          
    const char     *path_name ,                                    
    tag_t*         new_image_rev                                   
    );

extern DMI_API int DMI_revise_markup (
    tag_t          markup,                                         
    const char     markup_file_name [DMI_file_name_size_c + 1],    
    const char     path_name [DMI_path_name_size_c + 1],           
    tag_t*         new_markup_rev                                  
    );


extern DMI_API int DMI_revise_markup2 (
    tag_t          markup,                                         
    const char     *markup_file_name ,                             
    const char     *path_name ,                                    
    tag_t*         new_markup_rev                                  
    );

extern DMI_API int DMI_delete_image_named_ref (
    tag_t          image           
    );

extern DMI_API int DMI_delete_markup_named_ref (
    tag_t          markup          
    );

extern DMI_API int DMI_delete_thumbnail_named_ref (
    tag_t          image           
    );

extern DMI_API int DMI_ask_markup_types (
    const char     image_type_name[WSO_name_size_c + 1],    
    int*           markuptypes_count,                       
    char***        markuptypes_names                        
    );


extern DMI_API int DMI_ask_markup_types2 (
    const char     *image_type_name,                        
    int*           markuptypes_count,                       
    char***        markuptypes_names                        
    );


extern DMI_API int DMI_ask_tempmarkup_type (
    const char     markup_type_name[WSO_name_size_c + 1],        
    char**         tempmarkup_type_name                          
    );


extern DMI_API int DMI_ask_tempmarkup_type2 (
    const char     *markup_type_name,                            
    char**         tempmarkup_type_name                          
    );

extern DMI_API int DMI_ask_mapping_types_count (
    int*           count         
    );

extern DMI_API int DMI_ask_dataset_ref (
    tag_t          dataset,         
    char**         named_ref        
    );

extern DMI_API int DMI_init_module (void);

#ifdef __cplusplus
}
#endif

#include <dmi/libdmi_undef.h>
#endif