ic.h

Go to the documentation of this file.

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

/*  */

#ifndef IC_H
#define IC_H

#include <fclasses/tc_basic.h>

typedef enum IC_change_type_e
{
    IC_add = 1,    
    IC_remove
} IC_change_type_t;

/*
** IC_list_type_t is used to describe the types of incremental changes
** made to an affected object.
** Currently not used by any IC ITK
*/
typedef enum IC_list_type_e
{
    IC_list_none = 0,
    IC_list_adds = 1,
    IC_list_removes = 2,
    IC_list_both = 3        /* IC_list_adds |  IC_list_removes */
} IC_list_type_t;


#define IC_PRT_folder_contents "Folder::contents"

#define IC_PRT_occ_predecessor "PSOccurrence::pred_list"

#include <ecm/libecm_exports.h>

#ifdef __cplusplus
    extern "C"{
#endif

extern ECM_API int IC_create_ice(
    tag_t            ic_rev_tag,      
    tag_t            affected_obj,    
    IC_change_type_t change_type,     
    tag_t*           ice              
    );

extern ECM_API int IC_create_ice_pr(
    tag_t            ic_rev_tag,          
    tag_t            child_obj,           
    tag_t            parent_obj,          
    const char*      pseudo_reln_type,    
    IC_change_type_t change_type,         
    tag_t*           ice                  
    );

extern ECM_API int IC_delete_ice(
    tag_t          ice    
    );

extern ECM_API int IC_ask_ice_affected_object(
    tag_t          ice,                
    tag_t*         affected_obj,       
    tag_t*         parent_obj,         
    char**         pseudo_reln_type    
    );

extern ECM_API int IC_ask_ice_change_type(
    tag_t             ice,           
    IC_change_type_t* change_type    
    );

extern ECM_API int IC_find_ice(
    tag_t          ic_rev_tag,      
    tag_t          affected_obj,    
    tag_t*         ice              
    );

extern ECM_API int IC_find_ice_pr(
    tag_t          ic_rev_tag,          
    tag_t          child_obj,           
    tag_t          parent_obj,          
    const char*    pseudo_reln_type,    
    tag_t*         ice                  
    );

extern ECM_API int IC_list_ices_of_ic_rev(
    tag_t          ic_rev_tag,    
    int*           n_ices,        
    tag_t**        ices           
    );

extern ECM_API int IC_find_ices_affecting_obj(
    tag_t          affected_obj,    
    int*           n_ices,          
    tag_t**        ices             
    );

extern ECM_API int IC_find_ices_affecting_pr(
    tag_t          child_obj,           
    tag_t          parent_obj,          
    const char*    pseudo_reln_type,    
    int*           n_ices,              
    tag_t**        ices                 
    );

extern ECM_API int IC_is_configured(
    tag_t          affected_obj,    
    tag_t          rev_rule,        
    logical*       is_configured    
    );

extern ECM_API int IC_is_configured_pr(
    tag_t          child_obj,           
    tag_t          parent_obj,          
    const char*    pseudo_reln_type,    
    tag_t          rev_rule,            
    logical*       is_configured        
    );

extern ECM_API int IC_how_configured(
    tag_t          affected_obj,     
    tag_t          rev_rule,         
    logical*       is_configured,    
    tag_t*         how_configured    
    );

extern ECM_API int IC_how_configured_pr(
    tag_t          child_obj,           
    tag_t          parent_obj,          
    const char*    pseudo_reln_type,    
    tag_t          rev_rule,            
    logical*       is_configured,       
    tag_t*         how_configured       
    );

extern ECM_API int IC_split_ic(
    tag_t          ic_rev,             
    int            n_ices,             
    tag_t*         ices,               
    tag_t          ic_rev_target       
    );

#ifdef __cplusplus
}
#endif

#include <ecm/libecm_undef.h>
#endif