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

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

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

AE_API int	AE_ask_tool_install_date (tag_t tool_tag, date_t *install_date)

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

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

AE_API int	AE_ask_tool_shell (tag_t tool_tag, tag_t *shell_tool)

AE_API int	AE_ask_tool_shell_flag (tag_t tool_tag, logical *shell_flag)

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

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

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

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

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

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

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

AE_API int	AE_find_tool2 (const char tool_name, tag_t tool_tag)

AE_API int	AE_tool_extent (int n_instances, tag_t *instances)

Constants used in setting tool load method
#define	AE_LOAD_AS_PROCESS 1

#define	AE_LOAD_AS_MODULE 2

#define	AE_MAX_LOAD_METHOD 2

Detailed Description

Macro Definition Documentation

#define AE_LOAD_AS_MODULE 2

Definition at line 35 of file tool.h.

#define AE_LOAD_AS_PROCESS 1

Definition at line 34 of file tool.h.

#define AE_MAX_LOAD_METHOD 2

Definition at line 37 of file tool.h.

Function Documentation

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

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_tool_classification2

Gets or sets the string stored for the tool's site classification.

Parameters

tool_tag	(I)
site_classification	(O)

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

Gets or sets the string stored for the tool's site classification.

Parameters

tool_tag	(I)
site_classification	(OF)

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

Manipulates the lists of input and output formats that are understood by this tool. The user is responsible to free each string returned in the array formats individually before freeing up the formats array itself.

Use MEM_free to free up the memory used by the format arrays.

Parameters

tool_tag	(I)
format_count	(O)
input_formats	(OF) format_count

AE_API int AE_ask_tool_install_date	(	tag_t	tool_tag,
		date_t *	install_date
	)

Gets or changes the installation date. This should only be needed if the date is found to be wrong after registration with Teamcenter Engineering.

Parameters

tool_tag	(I)
install_date	(O)

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

Manipulates the lists of input and output formats that are understood by this tool. Use MEM_free to free up the memory used by the format arrays.

Parameters

tool_tag	(I)
format_count	(O)
output_formats	(OF) format_count

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

Manipulates the list of parameter names and default values attached to the input tool.

Parameters

tool_tag	(I)
parameter_count	(O)
parameters	(OF) parameter_count
default_values	(OF) parameter_count

AE_API int AE_ask_tool_shell	(	tag_t	tool_tag,
		tag_t *	shell_tool
	)

Reads the shell tool value for the input tool. This means that when the input tool is invoked through AE, the shell tool is started first.

Parameters

tool_tag	(I)
shell_tool	(O)

AE_API int AE_ask_tool_shell_flag	(	tag_t	tool_tag,
		logical *	shell_flag
	)

Reads the value which indicates whether a particular tool may function as a shell for another tool. Set shell_flag to true if the tool should be used as a shell.

Parameters

tool_tag	(I)
shell_flag	(O)

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

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_tool_symbol_name2

Gets the string stored for the symbol name.

Parameters

tool_tag	(I)
symbol_name	(O)

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

Gets the string stored for the symbol name.

Parameters

tool_tag	(I)
symbol_name	(OF)

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

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_tool_vendor2

Gets or changes the tool's vendor value.

Parameters

tool_tag	(I)
tool_vendor	(O)

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

Gets or changes the tool's vendor value.

Parameters

tool_tag	(I)
tool_vendor	(OF)

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

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_ask_tool_version2

Gets the current value for the version of a tool.

Parameters

tool_tag	(I)
tool_version	(O)

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

Gets the current value for the version of a tool.

Parameters

tool_tag	(I)
tool_version	(OF)

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

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use AE_find_tool2

Returns a tag to a tool in the database with the input tool name. An error code not equal to ITK_ok means that some error occurred while searching for the tool with the name specified. A return of ITK_ok means that there was no error. It does not mean that a tool was found. The value of tool must be compared with NULLTAG using tags_equal to determine if a tool was actually found.

{ 
    int stat;
    tag_t a_tool;
    char tool_name[WSO_name_size_c + 1];
    strcpy (tool_name, "some_tool_to_find"); 
    
    stat = AE_find_tool (tool_name, &tool);
    if( stat != ITK_ok )
        printf ("Error %d finding tool %s./n", stat, tool_name); 
    else
    {
        if (tool, NULLTAG) printf (" tool %s does not exist./n", tool_name); 
    }
}

Parameters

tool_name	(I)
tool_tag	(O)

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

Returns a tag to a tool in the database with the input tool name. An error code not equal to ITK_ok means that some error occurred while searching for the tool with the name specified. A return of ITK_ok means that there was no error. It does not mean that a tool was found. The value of tool must be compared with NULLTAG using tags_equal to determine if a tool was actually found.

{ 
    int stat;
    tag_t a_tool;
    char tool_name[WSO_name_size_c + 1];
    strcpy (tool_name, "some_tool_to_find"); 
    
    stat = AE_find_tool (tool_name, &tool);
    if( stat != ITK_ok )
        printf ("Error %d finding tool %s./n", stat, tool_name); 
    else
    {
        if (tool, NULLTAG) printf (" tool %s does not exist./n", tool_name); 
    }
}

Parameters

tool_name	(I)
tool_tag	(O)

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

Returns the tags to all of the tools in the database. Free up the memory for tool_tags with MEM_free .

Parameters

n_instances	(O)
instances	(OF) n_instances

Functions

Constants used in setting tool load method

Detailed Description

Macro Definition Documentation

Function Documentation