CAE

Data Structures
struct	CAE_tool_launch_export_config_runtime_overrides_s
struct	CAE_tool_launch_import_config_runtime_overrides_s

Typedefs
typedef struct CAE_tool_launch_export_config_runtime_overrides_s	CAE_tool_launch_export_config_runtime_overrides_t
typedef struct CAE_tool_launch_import_config_runtime_overrides_s	CAE_tool_launch_import_config_runtime_overrides_t

Functions
CAE_API int	CAE_execute_datamap (tag_t rootIR, tag_t snapshotFolder, tag_t revRule, tag_t variantRule, char *domain, const char **processLog, tag_t *outputRoot)
CAE_API int	CAE_execute_derive_structures (tag_t source_ir, tag_t struct_cntxt, const char *selected_rule, const char *optional_rootname, const char *optional_index, int struct_count, const char **process_log)
CAE_API int	CAE_execute_simulation_tool_launch (tag_t tool_tag, int num_inputs, const tag_t *input_objects_tags, const tag_t *configuration_context_tags, const char *working_directory, const char *launch_type, const CAE_tool_launch_export_config_runtime_overrides_t *export_config_overrides, const CAE_tool_launch_import_config_runtime_overrides_t *import_config_overrides)
CAE_API int	CAE_execute_simulation_tool_launch2 (tag_t tool_tag, int num_inputs, const tag_t *input_objects_tags, const tag_t *configuration_context_tags, const char *working_directory, const char *launch_type, const CAE_tool_launch_export_config_runtime_overrides_t *export_config_overrides, const CAE_tool_launch_import_config_runtime_overrides_t *import_config_overrides, int pedigree_info_size, const tag_t *pedigree_capture_info_array)
CAE_API int	CAE_execute_structuremap (tag_t rootIR, tag_t snapshotFolder, tag_t revRule, tag_t variantRule, tag_t structureMapIR, const char **processLog, tag_t *outputRoot)
CAE_API int	CAE_launch_simulation_tool (tag_t ***input_objects_array, int array_count, int *objects_count, const char *tool_name, const char *launch_type, const char *item_creation, const char *dataset_creation, const char *plmxml_name, const char *working_directory, char **runtime_arguments, int argument_count)
CAE_API int	CAE_launch_simulation_tool_asynchronous (int array_count, const int *objects_count, const tag_t ***input_objects_array, const tag_t ***cntx_objects_array, const char *tool_name, const char *launch_type, const char *item_creation, const char *dataset_creation, const char *plmxml_name, const char *working_directory, int argument_count, const char **runtime_arguments)

Detailed Description

This module provides implementation for all the ITKs to be used by the customers of Teamcenter for Simulation.

To use these ITK functions, include the cae_itk.h file in the source code.

Typedef Documentation

typedef struct CAE_tool_launch_export_config_runtime_overrides_s CAE_tool_launch_export_config_runtime_overrides_t

Data struture defined to save runtime overrides for export configuration of Simulation Tool

typedef struct CAE_tool_launch_import_config_runtime_overrides_s CAE_tool_launch_import_config_runtime_overrides_t

Data struture defined to save runtime overrides for import configuration of Simulation Tool

Function Documentation

CAE_API int CAE_execute_datamap	(	tag_t	rootIR,
		tag_t	snapshotFolder,
		tag_t	revRule,
		tag_t	variantRule,
		char *	domain,
		const char **	processLog,
		tag_t *	outputRoot
	)

Executes Data Mapping rules on a Input Structure and creates a Simulation Structure.

Parameters

rootIR	(I) Root Item Revision tag of the Input Structure.
snapshotFolder	(I) Snapshot folder tag.
revRule	(I) Revision rule tag of the input structure.
variantRule	(I) Variant Rule tag for the Input Structure.
domain	(I) Domain for datamapping.
processLog	(OF) Process log.
outputRoot	(OF) Root Item Revision tag of the Output Structure.

CAE_API int CAE_execute_derive_structures	(	tag_t	source_ir,
		tag_t	struct_cntxt,
		const char *	selected_rule,
		const char *	optional_rootname,
		const char *	optional_index,
		int	struct_count,
		const char **	process_log
	)

CAE_execute_derive_structures This ITK would be used to create variants of the Input Structure by applying Derivative Rule.

Note

The optional rootname, if not provided the source rootname is taken as input.

The optional index, if not provided the multiple derived structures will have no index suffices.

Returns

• ITK_ok on success
• CAE_derive_operation_error.

Parameters

source_ir	(I) Root Item Revision tag of the Input Structure.
struct_cntxt	(I) Structure context object tag.
selected_rule	(I) Derivative Rule to be applied.
optional_rootname	(I) Optional root name for output structure.
optional_index	(I) Optional index for output structure.
struct_count	(I) Number of structures to be created
process_log	(O) Process log.

CAE_API int CAE_execute_simulation_tool_launch	(	tag_t	tool_tag,
		int	num_inputs,
		const tag_t *	input_objects_tags,
		const tag_t *	configuration_context_tags,
		const char *	working_directory,
		const char *	launch_type,
		const CAE_tool_launch_export_config_runtime_overrides_t *	export_config_overrides,
		const CAE_tool_launch_import_config_runtime_overrides_t *	import_config_overrides
	)

Launches external simulation tool as per the pre-defined configuration.
The configuration can be defined through the External Simulation Process framework.
A valid configuration for the tool must be created in CAEManager by Simulation Administrator or user with dba privileges, before this ITK is called.

Returns

• ITK_ok on success.
• CAE_sim_process_launch_log_file_not_created, if the log file cannot be created.
• CAE_sim_process_launch_working_dir_not_created, if the working directory cannot be created.
• CAE_sim_process_launch_process_input_types_undefined, if the primary input types are not defined.
• CAE_sim_process_launch_process_input_rule_undefined, if the primary input rule is not defined.
• CAE_sim_process_launch_script_not_specified, if the launch script is not defined.
• CAE_sim_process_launch_no_file_to_export, if the input files for the tool are not found.
• CAE_sim_process_workingdir_empty_space, if the working directory path cannot contain spaces.
• CAE_sim_process_launch_workflow_min_max_error, if the number of inputs to the tool is not between the minimum criteria and maximum criteria defined for the simulation tool.
• CAE_sim_process_launch_script_space_error, if the input launch script path contains spaces, and cannot, therefore, be executed.

Parameters

tool_tag	(I) Tag of Simulation Tool
num_inputs	(I) Number of inputs to the Simulation Tool
input_objects_tags	(I) Array of input object tags
configuration_context_tags	(I) Array of configuration context tags
working_directory	(I) Simulation Tool working directory
launch_type	(I) Simulation Tool launch type. It could be "LOCAL", "REMOTE", "SERVER, "LOCAL_DETACHED"
export_config_overrides	(I) Runtime overrides for export configuration of Simulation Tool
import_config_overrides	(I) Runtime overrides for import configuration of Simulation Tool

CAE_API int CAE_execute_simulation_tool_launch2	(	tag_t	tool_tag,
		int	num_inputs,
		const tag_t *	input_objects_tags,
		const tag_t *	configuration_context_tags,
		const char *	working_directory,
		const char *	launch_type,
		const CAE_tool_launch_export_config_runtime_overrides_t *	export_config_overrides,
		const CAE_tool_launch_import_config_runtime_overrides_t *	import_config_overrides,
		int	pedigree_info_size,
		const tag_t *	pedigree_capture_info_array
	)

Launches external simulation tool as per the pre-defined configuration.
The configuration can be defined through the External Simulation Process framework.
A valid configuration for the tool must be created in CAEManager by Simulation Administrator or user with dba privileges, before this ITK is called.

Returns

• ITK_ok on success.
• CAE_sim_process_launch_log_file_not_created, if the log file cannot be created.
• CAE_sim_process_launch_working_dir_not_created, if the working directory cannot be created.
• CAE_sim_process_launch_process_input_types_undefined, if the primary input types are not defined.
• CAE_sim_process_launch_process_input_rule_undefined, if the primary input rule is not defined.
• CAE_sim_process_launch_script_not_specified, if the launch script is not defined.
• CAE_sim_process_launch_no_file_to_export, if the input files for the tool are not found.
• CAE_sim_process_workingdir_empty_space, if the working directory path cannot contain spaces.
• CAE_sim_process_launch_workflow_min_max_error, if the number of inputs to the tool is not between the minimum criteria and maximum criteria defined for the simulation tool.
• CAE_sim_process_launch_script_space_error, if the input launch script path contains spaces, and cannot, therefore, be executed.

Parameters

tool_tag	(I) Tag of Simulation Tool
num_inputs	(I) Number of inputs to the Simulation Tool
input_objects_tags	(I) Array of input object tags
configuration_context_tags	(I) Array of configuration context tags
working_directory	(I) Simulation Tool working directory
launch_type	(I) Simulation Tool launch type. It could be "LOCAL", "REMOTE", "SERVER, "LOCAL_DETACHED"
export_config_overrides	(I) Runtime overrides for export configuration of Simulation Tool
import_config_overrides	(I) Runtime overrides for import configuration of Simulation Tool
pedigree_info_size	(I) Size of capture pedigree info for import configuration of Simulation Tool
pedigree_capture_info_array	(I) Array of capture pedigree info for import configuration of Simulation Tool

CAE_API int CAE_execute_structuremap	(	tag_t	rootIR,
		tag_t	snapshotFolder,
		tag_t	revRule,
		tag_t	variantRule,
		tag_t	structureMapIR,
		const char **	processLog,
		tag_t *	outputRoot
	)

This ITK would be used to execute a StructureMap rules on a Input Structure and create a Simulation Structure as an output.

Parameters

rootIR	(I) Root Item Revision tag of the Input Structure.
snapshotFolder	(I) Snapshot folder tag.
revRule	(I) Revision rule tag of the input structure.
variantRule	(I) Variant Rule tag for the Input Structure.
structureMapIR	(I) Structure Map Item Revision.
processLog	(OF) Process log.
outputRoot	(OF) Root Item Revision tag of the Output Structure.

CAE_API int CAE_launch_simulation_tool	(	tag_t ***	input_objects_array,
		int	array_count,
		int *	objects_count,
		const char *	tool_name,
		const char *	launch_type,
		const char *	item_creation,
		const char *	dataset_creation,
		const char *	plmxml_name,
		const char *	working_directory,
		char **	runtime_arguments,
		int	argument_count
	)

Launches external simulation tool as per the pre-defined configuration. The configuration can be defined through the External Simulation Process Framework. A valid configuration for the tool must exists before this ITK is called. Returns integer code.

Parameters

input_objects_array	(I) Array of array (two-dimensional array) of tags of Item Revisions. Each one-dimensional array is taken as an input for the specified process. Thus the specified tool can be launched multiple times using a two-dimensional array.
array_count	(I) Number of one-dimensional arrays in input_objects_array
objects_count	(I) Array of integers each representing the length of each one-dimensional array in input_objects_array
tool_name	(I) Name of the configured tool which will be launched by this ITK
launch_type	(I) Launch type for the process. It could be "LOCAL" or "REMOTE"
item_creation	(I) Item creation options for the process. It could be either "As Needed", "Always" or "Never"
dataset_creation	(I) Dataset creation options for the process. It could be either "As Needed", "Always" or "Never"" @param plmxml_name (I) PLMXML Export file name @param working_directory (I) Path to the working directory @param runtime_arguments (I) List of runtime arguments and their values. The argument and values are represented by a single string seperated by token "::" Example: To pass -fem -dat=blk as an argument, the user should pass [fem::<empty string>, dat::blk] as a string vector
argument_count	(I) Number of arguments

CAE_API int CAE_launch_simulation_tool_asynchronous	(	int	array_count,
		const int *	objects_count,
		const tag_t ***	input_objects_array,
		const tag_t ***	cntx_objects_array,
		const char *	tool_name,
		const char *	launch_type,
		const char *	item_creation,
		const char *	dataset_creation,
		const char *	plmxml_name,
		const char *	working_directory,
		int	argument_count,
		const char **	runtime_arguments
	)

Launches external simulation tool as per the pre-defined configuration.
The configuration can be defined through the External Simulation Process framework.
A valid configuration for the tool must be created in CAEManager by Simulation Administrator or user with dba privileges, before this ITK is called.

Returns

• ITK_ok on success.
• CAE_sim_process_launch_log_file_not_created, if the log file cannot be created.
• CAE_sim_process_launch_working_dir_not_created, if the working directory cannot be created.
• CAE_sim_process_launch_process_not_specified, if the simulation tool is not specified.
• CAE_sim_process_launch_process_input_types_undefined, if the primary input types are not defined.
• CAE_sim_process_launch_process_input_rule_undefined, if the primary input rule is not defined.
• CAE_sim_process_launch_script_not_specified, if the launch script is not defined.
• CAE_sim_process_launch_no_file_to_export, if the input files for the tool are not found.
• CAE_sim_process_workingdir_empty_space, if the working directory path cannot contain spaces.
• CAE_error_in_xerces_c_initialization, if an error occurred while initializing the parser.
• CAE_error_while_parsing_file, if an error occurred while parsing the configuration file.
• CAE_sim_process_launch_workflow_min_max_error, if the number of inputs to the tool is not between the minimum criteria and maximum criteria defined for the simulation tool.
• CAE_sim_process_launch_script_space_error, if the input launch script path contains spaces, and cannot, therefore, be executed.

Parameters

array_count	(I) First dimension of the arrays #input_objects_array and #cntx_objects_array.
objects_count	(I) Second dimension of the arrays #input_objects_array and #cntx_objects_array.
input_objects_array	(I) Array of array (two-dimensional array) of tags of business objects passed as reference.
cntx_objects_array	(I) Corresponding array of array (two-dimensional array) of tags of configuration context objects passed as reference.
tool_name	(I) Name of the configured tool to be launched.
launch_type	(I) Launch type for the process. It could be "LOCAL" or "REMOTE"
item_creation	(I) Item creation options for the process. It could be either "As Needed", "Always" or "Never"
dataset_creation	(I) Dataset creation options for the process. It could be either "As Needed", "Always" or "Never"" @param plmxml_name (I) PLMXML Export file name @param working_directory (I) Path to the specified working directory in tool configuration, where the input data will be exported. @param argument_count (I) Number of arguments @param runtime_arguments (I) List of runtime arguments and their values. <br>Each argument and values are represented by a single string separated by the token "::" <br>E.g. "-fem" argument translates as "fem::". <br>E.g. "-dat=blk" argument translates as "dat::blk".