Teamcenter/STEP Translator Functions

Macros
#define	STEP_file_size   100

Typedefs
typedef enum OBJIO_df_e	OBJIO_df_t

Enumerations
enum	OBJIO_df_e { OBJIO_STEP_AP203, OBJIO_STEP_AP214, OBJIO_STEP_IMAN }

Functions
STEP_API int	OBJIO_STEP_create (int operation_type, const char *path_name, tag_t *manager_tag)
STEP_API int	OBJIO_STEP_delete (tag_t manager_tag)
STEP_API int	OBJIO_STEP_exclude_relation_types (int n_type_tags, tag_t *type_tags, tag_t manager_tag)
STEP_API int	OBJIO_STEP_export (tag_t manager_tag, const char *filename, int n_objects, tag_t *object_tags)
STEP_API int	OBJIO_STEP_get_log_file_path (tag_t manager_tag, char **log_file_path)
STEP_API int	OBJIO_STEP_import (tag_t manager_tag, const char *filename, int *n_new_objects, tag_t **new_object_tags, int *n_modified_objects, tag_t **modified_object_tags)
STEP_API int	OBJIO_STEP_set_comments (tag_t manager_tag, const char *comments)
STEP_API int	OBJIO_STEP_set_data_format (tag_t manager_tag, OBJIO_df_t data_format)
STEP_API int	OBJIO_STEP_set_dataset_all_vers (tag_t manager_tag, logical ds_all_vers)
STEP_API int	OBJIO_STEP_set_full_assembly (tag_t manager_tag, logical full_assy)
int	OBJIO_STEP_set_geo_config_file (tag_t manager_tag, const char *geo_confg_file)
STEP_API int	OBJIO_STEP_set_log_file_path (tag_t manager_tag, const char *log_file_path)

Detailed Description

Macro Definition Documentation

#define STEP_file_size   100

Definition at line 28 of file objio_step.h.

Typedef Documentation

typedef enum OBJIO_df_e OBJIO_df_t

Enumeration Type Documentation

enum OBJIO_df_e

Enumerator
OBJIO_STEP_AP203
OBJIO_STEP_AP214
OBJIO_STEP_IMAN

Definition at line 30 of file objio_step.h.

Function Documentation

STEP_API int OBJIO_STEP_create	(	int	operation_type,
		const char *	path_name,
		tag_t *	manager_tag
	)

Creates a new STEP manager object.

Parameters

operation_type	(I) Either OBJIO_export_type or OBJIO_import_type
path_name	(I) Complete directory path (to write to for OBJIO_export_type and to read from for OBJIO_import_type)
manager_tag	(O) Returned tag of the newly created manager object

STEP_API int OBJIO_STEP_delete

(

tag_t

manager_tag

)

Deletes an existing STEP manager object.

Parameters

manager_tag

(I) Tag of an existing STEP manager object

STEP_API int OBJIO_STEP_exclude_relation_types	(	int	n_type_tags,
		tag_t *	type_tags,
		tag_t	manager_tag
	)

Sets the tags of excluded relation types and the number of excluded relation types during a STEP export.

Parameters

n_type_tags	(I) Number of excluded relation types
type_tags	(I) Tags of excluded relation types
manager_tag	(I) Tag of an existing STEP manager object

STEP_API int OBJIO_STEP_export	(	tag_t	manager_tag,
		const char *	filename,
		int	n_objects,
		tag_t *	object_tags
	)

Exports specified objects to the specified location in the specified format.

Parameters

manager_tag	(I) Tag of an existing STEP manager object
filename	(I) Name of the output file (10303-21 format) with .stp extension
n_objects	(I) Number of exported objects
object_tags	(I) Tags of exported objects. In the case of datasets, we will supply an ImanRelation tag to help uniquely identify the dataset.

STEP_API int OBJIO_STEP_get_log_file_path	(	tag_t	manager_tag,
		char **	log_file_path
	)

Parameters

manager_tag	(I)
log_file_path	(O)

STEP_API int OBJIO_STEP_import	(	tag_t	manager_tag,
		const char *	filename,
		int *	n_new_objects,
		tag_t **	new_object_tags,
		int *	n_modified_objects,
		tag_t **	modified_object_tags
	)

Imports data from the specified part-21 file.

Parameters

manager_tag	(I) Tag of an existing STEP manager object
filename	(I) Name of the input file (10303-21 format)
n_new_objects	(O) Number of new WorkspaceObjects created
new_object_tags	(OF) n_new_objects Tags of newly created WorkspaceObjects
n_modified_objects	(O) Number of WorkspaceObjects modified
modified_object_tags	(OF) n_modified_objects Tags of WorkspaceObjects modified

STEP_API int OBJIO_STEP_set_comments	(	tag_t	manager_tag,
		const char *	comments
	)

Sets STEP data exchange comments.

Parameters

manager_tag	(I) Tag of an existing STEP manager object
comments	(I) Comments placed into the STEP Part 21 file FILE_DESCRIPTION section

STEP_API int OBJIO_STEP_set_data_format	(	tag_t	manager_tag,
		OBJIO_df_t	data_format
	)

Sets the STEP data format for exported data.

Parameters

manager_tag	(I) Tag of an existing STEP manager object
data_format	(I) Enumeration identifying the output data format. Allowable values are: OBJIO_STEP_AP203 OBJIO_STEP_AP214 OBJIO_STEP_IMAN

STEP_API int OBJIO_STEP_set_dataset_all_vers	(	tag_t	manager_tag,
		logical	ds_all_vers
	)

Sets whether to export all versions of a dataset.

Parameters

manager_tag	(I) Tag of an existing STEP manager object
ds_all_vers	(I) TRUE = export all dataset versions. FALSE = export only dataset version-0.

STEP_API int OBJIO_STEP_set_full_assembly	(	tag_t	manager_tag,
		logical	full_assy
	)

Sets whether to export only the top-level or whole assembly.

Parameters

manager_tag	(I) Tag of an existing STEP manager object
full_assy	(I) TRUE = export entire assembly with all sub-parts/assemblies. FALSE = export only the top-level of the assembly.

int OBJIO_STEP_set_geo_config_file	(	tag_t	manager_tag,
		const char *	geo_confg_file
	)

Parameters

manager_tag	(I)
geo_confg_file	(I)

STEP_API int OBJIO_STEP_set_log_file_path	(	tag_t	manager_tag,
		const char *	log_file_path
	)

Parameters

manager_tag	(I)
log_file_path	(I)