attrmap.h

Go to the documentation of this file.

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

/*  */

#ifndef ATTRMAP_H
#define ATTRMAP_H

#include <unidefs.h>
#include <tc/preferences.h>
#include <property/libproperty_exports.h>

typedef enum ATTRMAP_mapping_type_e
{
    ATTRMAP_unknown,
    ATTRMAP_property,
    ATTRMAP_constant,
    ATTRMAP_preference,
    ATTRMAP_attribute
} ATTRMAP_mapping_type_t;

#ifdef __cplusplus
extern "C"{
#endif

extern PROPERTY_API int ATTRMAP_init_module ( void );

extern PROPERTY_API int ATTRMAP_refresh_mappings ( void );

extern PROPERTY_API int ATTRMAP_in_test_mode(
    logical*            verdict     
    );

extern PROPERTY_API int ATTRMAP_assert_in_test_mode(
    logical             state   
    );

extern PROPERTY_API int ATTRMAP_list_mappings(
    tag_t               obj,            
    tag_t               dataset_type,   
    tag_t               item_type,      
    logical             exact,          
    int*                num_mappings,   
    tag_t**             mappings        
    );

extern PROPERTY_API int ATTRMAP_list_all_mappings(
    int*                num_mappings,   
    tag_t**             mappings        
    );

extern PROPERTY_API int ATTRMAP_find_mapping(
    const char*         title,          
    tag_t               dataset_type,   
    tag_t               item_type,      
    tag_t*              mapping         
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_attr_title(
    tag_t               mapping,    
    char**              result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_dataset_type(
    tag_t               mapping,    
    tag_t*              result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_item_type(
    tag_t               mapping,    
    tag_t*              result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_cad_master(
    tag_t               mapping,    
    logical*            result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_iman_master(
    tag_t               mapping,    
    logical*            result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_freezable(
    tag_t               mapping,    
    logical*            result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_required(
    tag_t               mapping,    
    logical*            result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_write_once(
    tag_t               mapping,    
    logical*            result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_allow_null_value(
    tag_t               mapping,    
    logical*            result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_description(
    tag_t               mapping,    
    char**              result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_default_value(
    tag_t               mapping,    
    char**              result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_map_type(
    tag_t                   mapping,    
    ATTRMAP_mapping_type_t* result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_attr_all(
    tag_t                   mapping,        
    char**                  title,          
    tag_t*                  dataset_type,   
    tag_t*                  item_type,      
    logical*                cad_master,     
    logical*                iman_master,    
    logical*                freezable,      
    logical*                required,       
    logical*                write_once,     
    char**                  description,    
    char**                  default_value,  
    ATTRMAP_mapping_type_t* map_type        
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_whole_string(
    tag_t               mapping,    
    char**              result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_all_qualifiers(
    tag_t               mapping,    
    char**              result      
    );

extern PROPERTY_API int ATTRMAP_ask_mapping_hard_coded(
    tag_t               mapping,    
    logical*            result      
    );

extern PROPERTY_API int ATTRMAP_resolve_mapping(
    tag_t                   obj,                
    tag_t                   mapping,            
    ATTRMAP_mapping_type_t* type,               
    tag_t*                  obj_to_lock,        
    tag_t*                  actual_property     
    );

extern PROPERTY_API int ATTRMAP_resolve_mapping_with_ir(
    tag_t                   obj,                
    tag_t                   mapping,            
    tag_t                   itemRevTag,         
    ATTRMAP_mapping_type_t* type,               
    tag_t*                  obj_to_lock,        
    tag_t*                  actual_property     
    );


extern PROPERTY_API int ATTRMAP_ask_propdesc(
    tag_t               obj,        
    tag_t               mapping,    
    tag_t*              propdesc    
    );

extern PROPERTY_API int ATTRMAP_ask_propdesc_with_ir(
    tag_t               obj,            
    tag_t               mapping,        
    tag_t               itemRevTag,     
    tag_t*              propdesc        
    );

extern PROPERTY_API int ATTRMAP_ask_constant(
    tag_t               mapping,    
    char**              value       
    );

extern PROPERTY_API int ATTRMAP_ask_preference(
    tag_t                           mapping,    
    TC_preference_search_scope_t*   scope,      
    char**                          name        
    );

#ifdef __cplusplus
}
#endif

extern PROPERTY_API int ATTRMAP_resolve_mappings
(   tag_t                       obj,                
    tag_t *                     mappings,           
    int                         mappings_count,     
    ATTRMAP_mapping_type_t **   types,              
    tag_t **                    objs_to_lock,       
    tag_t **                    actual_properties,  
    int **                      xref                
);

#include <property/libproperty_undef.h>
#endif