pff.h

Go to the documentation of this file.

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

/*  */

#ifndef PFF_H
#define PFF_H

#include <unidefs.h>

#define PFF_name_size_c               128
#define PFF_desc_size_c               240
#define PFF_class_size_c               32
#define PFF_clause_size_c             240

#include <qry/libqry_exports.h>

typedef int (* REPORT_user_column_function_t) (
    tag_t   pff_tag,
    tag_t*  obj_tags,
    int     n_tags,
    char**  output
    );

typedef struct REPORT_user_column_entry_s
{
    char*                           column_name;
    REPORT_user_column_function_t   user_method;
} REPORT_user_column_entry_t;

#ifdef __cplusplus
    extern "C"{
#endif


extern QRY_API int PFF_ask_name(
    tag_t          pff_tag,                     
    char           qname[PFF_name_size_c + 1]   
    );

extern QRY_API int PFF_ask_name2(
    tag_t          pff_tag,                     
    char           **qname                      
    );

extern QRY_API int PFF_set_name(
    tag_t          pff_tag,                     
    const char     qname[PFF_name_size_c + 1]   
    );


extern QRY_API int PFF_set_name2(
    tag_t          pff_tag,                     
    const char     *qname                       
    );


extern QRY_API int PFF_ask_description(
    tag_t          pff_tag,                     
    char           qdesc[PFF_desc_size_c + 1]   
    );


extern QRY_API int PFF_ask_description2(
    tag_t          pff_tag,                     
    char           **qdesc                      
    );


extern QRY_API int PFF_set_description(
    tag_t          pff_tag,                     
    const char     qdesc[PFF_desc_size_c + 1]   
    );


extern QRY_API int PFF_set_description2(
    tag_t          pff_tag,                     
    const char     *qdesc                       
    );


extern QRY_API int PFF_ask_class(
    tag_t          pff_tag,                     
    char           qclass[PFF_class_size_c + 1] 
    );


extern QRY_API int PFF_ask_class2(
    tag_t          pff_tag,                     
    char           **qclass                     
    );


extern QRY_API int PFF_set_class(
    tag_t          pff_tag,                     
    const char     qclass[PFF_class_size_c + 1] 
    );


extern QRY_API int PFF_set_class2(
    tag_t          pff_tag,                     
    const char     *qclass                      
    );

extern QRY_API int PFF_ask_clauses(
    tag_t          pff_tag,     
    char**         qclauses     
    );

extern QRY_API int PFF_set_clauses(
    tag_t          pff_tag,     
    const char*    qclauses     
    );


extern QRY_API int PFF_find(
    const char     name[PFF_name_size_c + 1],   
    tag_t*         pff_tag                      
    );


extern QRY_API int PFF_find2(
    const char     *name,                       
    tag_t*         pff_tag                      
    );

extern QRY_API int PFF_extent(
    int*           pff_count,   
    tag_t**        pff_tag      
    );

extern QRY_API int PFF_write_xml(
    tag_t          pff_tag,             
    int            num_tuples,          
    int            num_tags_per_tuple,  
    tag_t*         tuples,              
    char*          output_file_name     
    );

extern QRY_API int PFF_write_xml_with_clauses(
    tag_t          pff_tag,             
    int            num_tuples,          
    int            num_tags_per_tuple,  
    tag_t*         tuples,              
    int            num_clauses,         
    char**         clauses,             
    char*          output_file_name     
    );

extern QRY_API int PFF_describe_pff(
    tag_t          pff_tag,             
    int*           num_clauses,         
    char***        column_names,        
    char***        relation_to_base     
    );


extern QRY_API int PFF_create(
    const char     name[PFF_name_size_c + 1],       
    const char     qdesc[PFF_desc_size_c + 1],      
    const char     qclass[PFF_class_size_c + 1],    
    const char*    qclauses,                        
    tag_t*         pff_tag                          
    );


extern QRY_API int PFF_create2(
    const char     *name,                           
    const char     *qdesc,                          
    const char     *qclass,                         
    const char*    qclauses,                        
    tag_t*         pff_tag                          
    );

extern QRY_API void PFF_register_user_columns (
    int                         n_columns,      
    REPORT_user_column_entry_t* column_methods  
    );

#ifdef __cplusplus
}
#endif

#include <qry/libqry_undef.h>

#endif