tool.h

Go to the documentation of this file.

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

/*  */

#ifndef TOOL_H
#define TOOL_H

#include <ae/ae_types.h>
#include <tccore/workspaceobject.h>
#include <ae/libae_exports.h>

#define AE_LOAD_AS_PROCESS  1
#define AE_LOAD_AS_MODULE   2

#define AE_MAX_LOAD_METHOD  2

#ifdef __cplusplus
    extern "C"{
#endif

extern AE_API int AE_tool_extent(
    int*          n_instances,        
    tag_t**       instances           
    );

extern AE_API int AE_find_tool(
    const char    tool_name[WSO_name_size_c + 1],      
    tag_t*        tool_tag                             
    );


extern AE_API int AE_find_tool2(
    const char    *tool_name,                          
    tag_t*        tool_tag                             
    );

extern AE_API int AE_ask_tool_symbol_name(
    tag_t         tool_tag,                            
    char          symbol_name[AE_symbol_size_c + 1]    
    );


extern AE_API int AE_ask_tool_symbol_name2(
    tag_t         tool_tag,                            
    char          **symbol_name                        
    );

extern AE_API int AE_ask_tool_version(
    tag_t         tool_tag,                                
    char          tool_version[AE_version_size_c + 1]      
    );

extern AE_API int AE_ask_tool_version2(
    tag_t         tool_tag,                                
    char          **tool_version                           
    );

extern AE_API int AE_ask_tool_classification(
    tag_t         tool_tag,                                      
    char          site_classification[AE_siteclass_size_c + 1]   
    );


extern AE_API int AE_ask_tool_classification2(
    tag_t         tool_tag,                                      
    char          **site_classification                          
    );

extern AE_API int AE_ask_tool_vendor(
    tag_t         tool_tag,                                  
    char          tool_vendor[AE_vendor_name_size_c + 1]     
    );


extern AE_API int AE_ask_tool_vendor2(
    tag_t         tool_tag,                                  
    char          **tool_vendor                              
    );

extern AE_API int AE_ask_tool_install_date(
    tag_t         tool_tag,        
    date_t*       install_date     
    );

extern AE_API int AE_ask_tool_shell(
    tag_t         tool_tag,        
    tag_t*        shell_tool       
    );

extern AE_API int AE_ask_tool_input_formats(
    tag_t         tool_tag,                               
    int*          format_count,                           
    char***       input_formats                           
    );

extern AE_API int AE_ask_tool_output_formats(
    tag_t         tool_tag,                               
    int*          format_count,                           
    char***       output_formats                          
    );

extern AE_API int AE_ask_tool_parameters(
    tag_t         tool_tag,                               
    int*          parameter_count,                        
    char***       parameters,                             
    char***       default_values                          
    );

extern AE_API int AE_ask_tool_shell_flag(
    tag_t         tool_tag,      
    logical*      shell_flag     
    );

#ifdef __cplusplus
}
#endif

#include <ae/libae_undef.h>
#endif