grm.h

Go to the documentation of this file.

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

/*  */

#ifndef GRM_H
#define GRM_H

#include <tccore/grm_errors.h>
#include <fclasses/tc_basic.h>
#include <stdarg.h>
#include <tccore/libtccore_exports.h>

#define GRM_class_name_c               "ImanRelation"
#define GRM_relationtype_name_size_c   32

typedef struct GRM_relation_s
{
    tag_t the_relation;
    tag_t primary;
    tag_t secondary;
    tag_t relation_type;
    tag_t user_data;
} GRM_relation_t, *GRM_relation_p_t;

typedef struct GRM_list_relation_input_s
{
    int     object_count;           
    tag_t*  objects;                
    int     relation_type_count;    
    tag_t*  relation_types;         
} GRM_list_relation_input_t, *GRM_list_relation_input_p_t;


#ifdef __cplusplus
 extern "C"{
#endif

extern TCCORE_API int GRM_create_relation(
    tag_t               primary_object,     
    tag_t               secondary_object,   
    tag_t               relation_type,      
    tag_t               user_data,          
    tag_t*              relation            
    );

extern TCCORE_API int GRM_save_relation(
    tag_t               relation    
    );

extern TCCORE_API int GRM_delete_relation(
    tag_t               relation    
    );

extern TCCORE_API int GRM_find_relation(
    tag_t               primary_object,     
    tag_t               secondary_object,   
    tag_t               relation_type,      
    tag_t*              relation            
    );

extern TCCORE_API int GRM_list_relations(
    tag_t               primary_object,     
    tag_t               secondary_object,   
    tag_t               relation_type,      
    tag_t               user_data,          
    int*                count,              
    tag_t**             relation_list       
    );

extern TCCORE_API int GRM_list_secondary_objects(
    tag_t               primary_object,         
    tag_t               relation_type,          
    int*                count,                  
    GRM_relation_t**    secondary_list          
    );

extern TCCORE_API int GRM_list_secondary_objects_in_bulk(
    int                         input_count,    
    const GRM_list_relation_input_t*  inputs,   
    int*                        count,          
    GRM_relation_t**            secondary_list  
    );

extern TCCORE_API int GRM_list_secondary_objects_only(
    tag_t               primary_object,     
    tag_t               relation_type,      
    int*                count,              
    tag_t**             secondary_objects   
    );

extern TCCORE_API int GRM_list_primary_objects(
    tag_t               secondary_object,   
    tag_t               relation_type,      
    int*                count,              
    GRM_relation_t**    primary_list        
   );

extern TCCORE_API int GRM_list_primary_objects_in_bulk(
    int                         input_count,    
    const GRM_list_relation_input_t*  inputs,   
    int*                        count,          
    GRM_relation_t**            primary_list    
    );

extern TCCORE_API int GRM_list_primary_objects_only(
    tag_t               secondary_object,   
    tag_t               relation_type,      
    int*                count,              
    tag_t**             primary_objects    
    );

extern TCCORE_API int GRM_list_primary_objects_with_primary_object_type_only(
    tag_t               secondary_object,   
    tag_t               relation_type,      
    const char*         primary_type_name,  
    int*                count,              
    tag_t**             primary_objects     
    );

extern TCCORE_API int GRM_list_all_related_objects(
    tag_t               match_object,           
    int*                count,                  
    GRM_relation_t**    related_object_list     
    );

extern TCCORE_API int GRM_list_all_related_objects_only(
    tag_t               match_object,       
    int*                count,              
    tag_t**             related_objects     
    );

extern TCCORE_API int GRM_ask_primary(
    tag_t               relation,       
    tag_t*              primary_object  
    );

extern TCCORE_API int GRM_ask_secondary(
    tag_t               relation,           
    tag_t*              secondary_object    
    );

extern TCCORE_API int GRM_ask_relation_type(
    tag_t               relation,       
    tag_t*              relation_type   
    );

extern TCCORE_API int GRM_ask_user_data(
    tag_t               relation,   
    tag_t*              user_data   
    );

extern TCCORE_API int GRM_set_user_data(
    tag_t               relation,       
    tag_t               new_user_data   
    );

extern TCCORE_API int GRM_list_relation_types(
    int*                count,              
    tag_t**             relation_type_list  
    );

extern TCCORE_API int GRM_find_relation_type(
    const char*         relation_type_name,     
    tag_t*              relation_type           
    );

extern TCCORE_API int GRM_create_relation_type(
    const char*         relation_type_name,     
    tag_t*              relation_type           
    );

extern TCCORE_API int GRM_delete_relation_type(
    tag_t               relation_type   
    );

#ifdef __cplusplus
}
#endif

#include <tccore/libtccore_undef.h>

#endif