collabctx.h

Go to the documentation of this file.

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

/*  */

#ifndef COLLABCTX_H
#define COLLABCTX_H

#include <unidefs.h>

#include <collabctx/libcollabctx_exports.h>

#define COLLABCTX_CCObject_class_name_c             "CCObject"
#define COLLABCTX_StructureContext_class_name_c     "StructureContext"
#define COLLABCTX_context_relation_name             "IMAN_CCContext"
#define COLLABCTX_structure_content_relation_name   "IMAN_StructureContent"
#define COLLABCTX_study_relation_name               "IMAN_CCStudy"
#define COLLABCTX_context_lov_name                  "Context Names"
#define COLLABCTX_ConfigurationContext_class_name_c "ConfigurationContext"
#define COLLABCTX_SCTypeData_class_name_c           "SCTypeData"
#define COLLABCTX_ref_context_relation_name         "IMAN_CCReferenceContext"
#define COLLABCTX_PrivateContext_class_name_c       "PrivateContext"
#define COLLABCTX_SCTypeData_relation_name          "IMAN_SCTypeData"

#define COLLABCTX_ccobject_type_name_c              "CCObject"
#define COLLABCTX_me_ccobject_type_name_c           "MECollaborationContext"
#define COLLABCTX_product_structure_type_name_c     "MEProductContext"
#define COLLABCTX_factory_structure_type_name_c     "MEPlantContext"
#define COLLABCTX_process_structure_type_name_c     "MEProcessContext"
#define COLLABCTX_resource_structure_type_name_c    "MEResourceContext"
#define COLLABCTX_private_structure_type_name_c     "PrivateContext"
#define COLLABCTX_composition_structure_type_name_c "CompositionContext"
#define COLLABCTX_configuration_context_type_name_c "ConfigurationContext"
#define COLLABCTX_sctypedata_type_name_c            "SCTypeData"

#define COLLABCTX_content_rel_any_stype             0
#define COLLABCTX_content_rel_background            ( 1 << 0 )
#define COLLABCTX_content_rel_target                ( 1 << 1 )

#ifdef __cplusplus
    extern "C"{
#endif

extern COLLABCTX_API int COLLABCTX_init_module();
extern COLLABCTX_API int COLLABCTX_create_ccobject(
    const char*          type,         
    const char*          name,         
    const char*          desc,         
    tag_t*               cc            
    );

extern COLLABCTX_API int COLLABCTX_create_structure_context(
    const char*          type,       
    const char*          name,       
    const char*          desc,       
    tag_t*               context     
    );

extern COLLABCTX_API int COLLABCTX_create_configuration_context(
    const char*          type,       
    const char*          name,       
    const char*          desc,       
    tag_t*               rule        
    );

extern COLLABCTX_API int COLLABCTX_create_config_context_based_on_ref(
    const char*         type,       
    const char*         name,       
    const char*         desc,       
    tag_t*              ref_obj_tag,
    tag_t*              context     
    );

extern COLLABCTX_API int COLLABCTX_add_structure_context(
    tag_t                cc,           
    tag_t                context       
    );

extern COLLABCTX_API int COLLABCTX_remove_structure_context(
    tag_t                cc,       
    tag_t                context   
    );

extern COLLABCTX_API int COLLABCTX_ask_structure_contexts(
    tag_t                cc,         
    int*                 number,     
    tag_t**              contexts    
    );

extern COLLABCTX_API int COLLABCTX_ask_working_context(
    tag_t                cc,       
    tag_t*               context   
    );

extern COLLABCTX_API int COLLABCTX_set_working_context(
    tag_t                cc,       
    tag_t                context   
    );

extern COLLABCTX_API int COLLABCTX_ccobj_ask_config_context(
    tag_t                cc,           
    tag_t*               config        
    );

extern COLLABCTX_API int COLLABCTX_ccobj_set_config_context(
    tag_t                cc,           
    tag_t                config        
    );
extern COLLABCTX_API int COLLABCTX_context_ask_config_context(
    tag_t                context,      
    tag_t*               config        
    );

extern COLLABCTX_API int COLLABCTX_context_set_config_context(
    tag_t                context,       
    tag_t                config         
    );

extern COLLABCTX_API int COLLABCTX_context_add_content(
    tag_t                context,      
    tag_t                comp,         
    int                  subType       
    );

extern COLLABCTX_API int COLLABCTX_context_remove_content(
    tag_t                context,      
    tag_t                comp          
    );

extern COLLABCTX_API int COLLABCTX_context_ask_contents(
    tag_t                context,    
    int*                 number,     
    tag_t**              contents,   
    int                  subType     
    );

extern COLLABCTX_API int COLLABCTX_context_is_composition(
    tag_t                context,       
    logical*             isComp         
    );

extern COLLABCTX_API int COLLABCTX_context_single_end_item(
    tag_t                context,       
    logical*             isSingle       
    );
extern COLLABCTX_API int COLLABCTX_configuration_set_closurerule(
    tag_t                context,      
    tag_t                rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_chg_closurerule(
    tag_t                context,      
    tag_t                rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_ask_closurerule(
    tag_t                context,      
    tag_t*               rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_set_revisionrule(
    tag_t                context,      
    tag_t                rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_chg_revisionrule(
    tag_t                context,      
    tag_t                rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_ask_revisionrule(
    tag_t                context,      
    tag_t*               rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_set_arrangement(
    tag_t                context,      
    tag_t                arrangement   
    );

extern COLLABCTX_API int COLLABCTX_configuration_chg_arrangement(
    tag_t                context,      
    tag_t                arrangement   
    );

extern COLLABCTX_API int COLLABCTX_configuration_ask_arrangement(
    tag_t                context,      
    tag_t*               arrangement   
    );

extern COLLABCTX_API int COLLABCTX_configuration_set_variantrule(
    tag_t                context,      
    tag_t                rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_chg_variantrule(
    tag_t                context,      
    tag_t                rule          
    );

extern COLLABCTX_API int COLLABCTX_configuration_ask_variantrule(
    tag_t                context,     
    tag_t*               rule         
    );
extern COLLABCTX_API int COLLABCTX_sctype_ask_is_composition(
    tag_t                scType,     
    logical*             is_comp     
    );

extern COLLABCTX_API int COLLABCTX_sctype_ask_single_end_item(
    tag_t                scType,      
    logical*             is_single    
    );

extern COLLABCTX_API int COLLABCTX_copy_ccobject(
    tag_t                baseCC,  
    const char*          name,    
    const char*          desc,    
    tag_t*               newCC    
    );

extern COLLABCTX_API int COLLABCTX_copy_structure_context(
    tag_t                baseSC,  
    const char*          name,    
    const char*          desc,    
    tag_t*               newSC    
    );

extern COLLABCTX_API int COLLABCTX_copy_configuration_context(
    tag_t                baseConfig,    
    const char*          name,          
    const char*          desc,          
    tag_t*               newConfig      
    );

extern COLLABCTX_API int COLLABCTX_acctability_check(
    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 COLLABCTX_API int COLLABCTX_clear_acctability_check(
    tag_t* windows,     
    int num_win         
    );

extern COLLABCTX_API int  COLLABCTX_alignment_check(
    tag_t       source_line,                     
    tag_t       target_line,                     
    int         *count,                          
    tag_t       **source_lines,                  
    tag_t       **target_lines,                  
    int         **n_mismatched_properties,       
    int         **mismatched_properties,         
    int         *n_properties,                   
    char        ***properties                    
    );

extern COLLABCTX_API int  COLLABCTX_sync_aligned_occurrences(
    tag_t       source_line,                     
    tag_t       target_line                     
    );

extern COLLABCTX_API int COLLABCTX_configuration_ask_variant_rules(
    tag_t                context,            
    int*                 num_variant_rules,  
    tag_t**              variant_rules       
    );

extern COLLABCTX_API int COLLABCTX_configuration_set_variant_rules(
    tag_t               context,            
    int                 num_variant_rules,  
    tag_t*              variant_rules       
    );

extern COLLABCTX_API int COLLABCTX_configuration_change_variant_rules(
    tag_t               context,            
    int                 num_variant_rules,  
    tag_t*              variant_rules       
    ); 

#ifdef __cplusplus
}
#endif

#include <collabctx/libcollabctx_undef.h>

#endif