idm.h

Go to the documentation of this file.

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

/*  */

#ifndef IDM_H
#define IDM_H

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

#ifdef __cplusplus
extern "C"
{
#endif

extern TCCORE_API int IDM_init_module(void);

extern TCCORE_API int IDM_exit_module(void);

extern TCCORE_API int IDM_create_item(
    const char*         item_id,            
    const char*         item_name,          
    const char*         item_description,   
    const char*         revision_id,        
    const char*         revision_name,      
    tag_t*              new_item,           
    tag_t*              new_item_revision   
    );

extern TCCORE_API int IDM_initialize_item(
    tag_t               item,               
    const char*         item_id,            
    const char*         item_name,          
    const char*         item_description,   
    const char*         revision_id,        
    const char*         revision_name       
    );

extern TCCORE_API int IDM_item_extent(
    int*                n_instances,    
    tag_t**             instances       
    );

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

extern TCCORE_API int IDM_ask_item_id(
    tag_t               item,                           
    char                item_id[WSO_name_size_c + 1]    
    );

#ifdef __cplusplus
}
#endif

#define IDM_item_master_rel     1
#define IDM_manifestation_rel   2
#define IDM_requirements_rel    3
#define IDM_revisions_rel       4
#define IDM_specification_rel   5
#define IDM_attachment_rel      6
#define IDM_bom_view_rel        7

#define IDM_bvr_rel             8

#ifdef __cplusplus
extern "C"
{
#endif

extern TCCORE_API int IDM_ask_item_related(
    tag_t               item,               
    int                 relation,           
    int*                count,              
    tag_t**             related_objects     
    );

extern TCCORE_API int IDM_add_item_related(
    tag_t               item,           
    int                 relation,       
    tag_t               related_object  
    );

extern TCCORE_API int IDM_remove_item_related(
    tag_t               item,               
    int                 relation,           
    tag_t               related_object      
    );

extern TCCORE_API int IDM_initialize_item_revision(
    tag_t               item_revision,  
    const char*         revision_id,    
    const char*         revision_name,  
    const char*         revision_desc,  
    tag_t               item            
    );

extern TCCORE_API int IDM_item_revision_extent(
    int*                n_instances,    
    tag_t**             instances       
    );

extern TCCORE_API int IDM_find_item_revision(
    const char*         item_id,        
    const char*         revision_id,    
    tag_t*              item_revision   
    );

extern TCCORE_API int IDM_copy_item_revision(
    tag_t               item_revision,      
    const char*         new_revision_id,    
    tag_t*              new_item_revision   
    );

extern TCCORE_API int IDM_ask_revision_id(
    tag_t               item_revision,                      
    char                revision_id[WSO_name_size_c + 1]    
    );

extern TCCORE_API int IDM_ask_item(
    tag_t               item_revision,  
    tag_t*              item            
    );

extern TCCORE_API int IDM_ask_revision_related(
    tag_t               item_revision,      
    int                 relation,           
    int*                count,              
    tag_t**             related_objects     
    );

extern TCCORE_API int IDM_add_revision_related(
    tag_t               item_revision,      
    int                 relation,           
    tag_t               related_object      
    );

extern TCCORE_API int IDM_remove_revision_related(
    tag_t               item_revision,      
    int                 relation,           
    tag_t               related_object      
    );

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif