TCTRUSHAPE

Functions
TCTRUSHAPE_API int	TCTRUSHAPE_ask_appearance_occupancy_data_exists (tag_t appearanceRoot, tag_t appearance, logical *exists)
TCTRUSHAPE_API int	TCTRUSHAPE_ask_occupancy_cache_exists (tag_t appearanceRoot, logical *exists)
TCTRUSHAPE_API int	TCTRUSHAPE_ask_occupancy_cache_extents (tag_t appearanceRoot, double bbox[6])
TCTRUSHAPE_API int	TCTRUSHAPE_close_occupancy_cache (tag_t appearanceRoot)
TCTRUSHAPE_API int	TCTRUSHAPE_create_end_item_search_result_object (tag_t appearanceRoot, tag_t revisionRule, tag_t bomWindow, int numMappedAttributes, char **mappedAttributeNames, char **mappedAttributeValues, int numInClassClassNames, char **inClassClassNames, int numInClassAttributes, int *inClassAttributeIDs, char **inClassAttributeValues, tag_t savedQuery, int numEntries, char **entries, char **values, int numTargets, tag_t *targets, double distance, logical includeSubTree, int boxPlaneRelativePosition, VEC3_t planeNormals[6], double planeDisplacements[6], tag_t *searchResultObject)
TCTRUSHAPE_API int	TCTRUSHAPE_create_occupancy_cache (tag_t appearanceRoot)
TCTRUSHAPE_API int	TCTRUSHAPE_delete_occupancy_cache (tag_t appearanceRoot)
TCTRUSHAPE_API int	TCTRUSHAPE_end_item_search_result_ask_all_apprs (tag_t searchResultObject, int *numApprs, tag_t **apprs)
TCTRUSHAPE_API int	TCTRUSHAPE_end_item_search_result_ask_all_bom_lines (tag_t searchResultObject, int *numBOMLines, tag_t **bomLines)
TCTRUSHAPE_API int	TCTRUSHAPE_end_item_search_result_ask_bom_line_number (tag_t searchResultObject, int *numBOMLines)
TCTRUSHAPE_API int	TCTRUSHAPE_end_item_search_result_ask_next_apprs (tag_t searchResultObject, int groupNumber, int *numApprs, tag_t *bomwindow, tag_t **apprs)
TCTRUSHAPE_API int	TCTRUSHAPE_end_item_search_result_ask_next_bom_lines (tag_t searchResultObject, int groupNumber, int *numBOMLines, tag_t **bomLines)
TCTRUSHAPE_API int	TCTRUSHAPE_init_module (void)
TCTRUSHAPE_API int	TCTRUSHAPE_is_occupancy_cache_open (tag_t appearanceRoot, logical *open)
TCTRUSHAPE_API int	TCTRUSHAPE_open_occupancy_cache_for_read (tag_t appearanceRoot)
TCTRUSHAPE_API int	TCTRUSHAPE_open_occupancy_cache_for_write (tag_t appearanceRoot)
TCTRUSHAPE_API int	TCTRUSHAPE_spatial_3d_box_search (tag_t appearanceRoot, int boxRelativePosition, VEC3_t planeNormals[6], double planeDisplacements[6], int *numAppearances, tag_t **appearances)
TCTRUSHAPE_API int	TCTRUSHAPE_spatial_3d_plane_search (tag_t appearanceRoot, int planeRelativePosition, VEC3_p_t planeNormal, double planeDisplacement, int *numAppearances, tag_t **appearances)
TCTRUSHAPE_API int	TCTRUSHAPE_spatial_filtered_proximity_search (tag_t appearanceRoot, int numTargets, tag_t *targets, int numFilterTargets, tag_t *filterTargets, double distance, int *numAppearances, tag_t **appearances)
TCTRUSHAPE_API int	TCTRUSHAPE_spatial_proximity_search (tag_t appearanceRoot, int numTargets, tag_t *targets, double distance, int *numAppearances, tag_t **appearances)
TCTRUSHAPE_API int	TCTRUSHAPE_write_appearance_occupancy_data (tag_t appearanceRoot, tag_t appearance)
TCTRUSHAPE_API int	TRUSHAPE__extract_bbox_nosave (tag_t directmodel_dataset, double bbox[6])
TCTRUSHAPE_API int	TRUSHAPE__extract_bbox_trushape (tag_t directmodel_dataset, int conversion_mode, double bbox[6])
TCTRUSHAPE_API int	TRUSHAPE__generate_bbox_trushape_from_jt (int num_datasets, tag_t *directmodel_datasets, int conversion_mode, int *num_out_datasets, tag_t **out_datasets, int *num_error_datasets, tag_t **error_datasets, int **error_codes)

Defines for spatial zone relative positions
#define	TCTRUSHAPE_no_zone_criteria   (0)
#define	TCTRUSHAPE_inside_box   (1)
#define	TCTRUSHAPE_outside_box   (2)
#define	TCTRUSHAPE_interferes_with_box   (3)
#define	TCTRUSHAPE_above_plane   (4)
#define	TCTRUSHAPE_below_plane   (5)
#define	TCTRUSHAPE_interferes_with_plane   (6)
#define	TCTRUSHAPE_interferes_outside_box   (7)
#define	TCTRUSHAPE_interferes_inside_box   (8)
#define	TCTRUSHAPE_interferes_above_plane   (9)
#define	TCTRUSHAPE_interferes_below_plane   (10)

Defines for bounding box and trushape extraction options
#define	TRUSHAPE_extract_bbox   1
#define	TRUSHAPE_extract_tso   2
#define	TRUSHAPE_extract_bbox_tso   3

Detailed Description

Macro Definition Documentation

#define TCTRUSHAPE_above_plane   (4)

Definition at line 35 of file tctrushape.h.

#define TCTRUSHAPE_below_plane   (5)

Definition at line 36 of file tctrushape.h.

#define TCTRUSHAPE_inside_box   (1)

Definition at line 32 of file tctrushape.h.

#define TCTRUSHAPE_interferes_above_plane   (9)

Definition at line 41 of file tctrushape.h.

#define TCTRUSHAPE_interferes_below_plane   (10)

Definition at line 42 of file tctrushape.h.

#define TCTRUSHAPE_interferes_inside_box   (8)

Definition at line 39 of file tctrushape.h.

#define TCTRUSHAPE_interferes_outside_box   (7)

Definition at line 38 of file tctrushape.h.

#define TCTRUSHAPE_interferes_with_box   (3)

Definition at line 34 of file tctrushape.h.

#define TCTRUSHAPE_interferes_with_plane   (6)

Definition at line 37 of file tctrushape.h.

#define TCTRUSHAPE_no_zone_criteria   (0)

Definition at line 31 of file tctrushape.h.

#define TCTRUSHAPE_outside_box   (2)

Definition at line 33 of file tctrushape.h.

#define TRUSHAPE_extract_bbox   1

Definition at line 50 of file tctrushape.h.

#define TRUSHAPE_extract_bbox_tso   3

Definition at line 52 of file tctrushape.h.

#define TRUSHAPE_extract_tso   2

Definition at line 51 of file tctrushape.h.

Function Documentation

TCTRUSHAPE_API int TCTRUSHAPE_ask_appearance_occupancy_data_exists	(	tag_t	appearanceRoot,
		tag_t	appearance,
		logical *	exists
	)

Checks if occupancy data exists for this appearance. Occupancy cache must be opened for reading or writing.

Parameters

appearanceRoot	(I)
appearance	(I)
exists	(O)

TCTRUSHAPE_API int TCTRUSHAPE_ask_occupancy_cache_exists	(	tag_t	appearanceRoot,
		logical *	exists
	)

Checks if occupancy cache exists for this appearance set. Occupancy cache can be opened or closed.

Parameters

appearanceRoot	(I)
exists	(O)

TCTRUSHAPE_API int TCTRUSHAPE_ask_occupancy_cache_extents	(	tag_t	appearanceRoot,
		double	bbox[6]
	)

Returns union of extents of all appearances in this occupancy cache. Occupancy cache has to be opened for reading or writing. Note that this function takes into account all appearances ever existed in the occupancy cache.

Parameters

appearanceRoot	(I)
bbox	(O)

TCTRUSHAPE_API int TCTRUSHAPE_close_occupancy_cache

(

tag_t

appearanceRoot

)

Flushes any unwritten data and closes occupancy cache. MUST be called before exiting application.

Parameters

appearanceRoot

(I)

TCTRUSHAPE_API int TCTRUSHAPE_create_end_item_search_result_object	(	tag_t	appearanceRoot,
		tag_t	revisionRule,
		tag_t	bomWindow,
		int	numMappedAttributes,
		char **	mappedAttributeNames,
		char **	mappedAttributeValues,
		int	numInClassClassNames,
		char **	inClassClassNames,
		int	numInClassAttributes,
		int *	inClassAttributeIDs,
		char **	inClassAttributeValues,
		tag_t	savedQuery,
		int	numEntries,
		char **	entries,
		char **	values,
		int	numTargets,
		tag_t *	targets,
		double	distance,
		logical	includeSubTree,
		int	boxPlaneRelativePosition,
		VEC3_t	planeNormals[6],
		double	planeDisplacements[6],
		tag_t *	searchResultObject
	)

Create end item search result object which can be queried for result BOM lines matching all the given criteria, i.e. the individual criteria are ANDed together with spatial criteria which are mutually exclusive.

Possible box or plane zone relative positions are:

• TCTRUSHAPE_no_zone_criteria
• TCTRUSHAPE_inside_box
• TCTRUSHAPE_outside_box
• TCTRUSHAPE_interferes_with_box
• TCTRUSHAPE_above_plane
• TCTRUSHAPE_below_plane
• TCTRUSHAPE_interferes_with_plane

Restrictions:

Spatial criteria (proximity, plane and box zones) are mutually exclusive. If more than one spatial criteria is specified, function fails and returns an error condition.

Parameters

appearanceRoot	(I) Appearance set tag against which search is performed
revisionRule	(I) Revision rule tag (includes release date or effectivity date and/or number). If NULLTAG, context free (or "all history") search is performed.
bomWindow	(I) Receiving BOM Window object for result BOM Lines
numMappedAttributes	(I)
mappedAttributeNames	(I) List of name/value pairs of attribute mapped to appearance objects (currently limited to the occurrence note strings), e.g. ATA number
mappedAttributeValues	(I)
numInClassClassNames	(I)
inClassClassNames	(I) Classification class names, e.g. find all the Bolts and Brackets.
numInClassAttributes	(I)
inClassAttributeIDs	(I)
inClassAttributeValues	(I) List of name/value pairs of Classification attributes. Applicable only if exactly one Classification class name is specified. E.g. give me all the Bolts longer than 6 millimeters.
savedQuery	(I) Item or item revision saved query tag
numEntries	(I)
entries	(I) List of name/value pairs of saved query entries attributes. Entry names should be a subset of attribute names defined in saved query.
values	(I)
numTargets	(I)
targets	(I) Proximity search BOM line target tags
distance	(I) Proximity search distance
includeSubTree	(I) Add all descendents of target BOMlines to proximity target list. This option is not compatible with "all history" search.
boxPlaneRelativePosition	(I) Plane/box zone spatial relative position to the products components
planeNormals	(I)
planeDisplacements	(I) Coordinates of 3d plane or box zone. Only one proximity criteria (target or zone) can be specified. If both of them are specified, then only target proximity search is performed. If plane zone searching is requested, only first element of normal and displacement array is used.
searchResultObject	(O) Tag of the search result object which can be used to query for the number of found BOM lines and for the groups of the BOM lines satisfying provided criteria.

TCTRUSHAPE_API int TCTRUSHAPE_create_occupancy_cache

(

tag_t

appearanceRoot

)

Creates occupancy cache for the appearance root and opens it for writing.

Parameters

appearanceRoot

(I)

TCTRUSHAPE_API int TCTRUSHAPE_delete_occupancy_cache

(

tag_t

appearanceRoot

)

Deletes occupancy cache data associated with the appearance set

Parameters

appearanceRoot

(I)

TCTRUSHAPE_API int TCTRUSHAPE_end_item_search_result_ask_all_apprs	(	tag_t	searchResultObject,
		int *	numApprs,
		tag_t **	apprs
	)

Returns remaining Appearances from this search result object. Please note that after this call search result object is deleted and its tag is no longer valid.

Parameters

searchResultObject	(I)
numApprs	(O)
apprs	(O)

TCTRUSHAPE_API int TCTRUSHAPE_end_item_search_result_ask_all_bom_lines	(	tag_t	searchResultObject,
		int *	numBOMLines,
		tag_t **	bomLines
	)

Returns remaining BOM lines from this search result object. Please note that after this call search result object is deleted and its tag is no longer valid.

Parameters

searchResultObject	(I)
numBOMLines	(O)
bomLines	(O)

TCTRUSHAPE_API int TCTRUSHAPE_end_item_search_result_ask_bom_line_number	(	tag_t	searchResultObject,
		int *	numBOMLines
	)

Returns number of bom lines in this search result object.

Parameters

searchResultObject	(I)
numBOMLines	(O)

TCTRUSHAPE_API int TCTRUSHAPE_end_item_search_result_ask_next_apprs	(	tag_t	searchResultObject,
		int	groupNumber,
		int *	numApprs,
		tag_t *	bomwindow,
		tag_t **	apprs
	)

Returns the remaining appearances from this search result object. Please note that after this call search result object is deleted and its tag is no longer valid.

Parameters

searchResultObject	(I)
groupNumber	(I)
numApprs	(O)
bomwindow	(O)
apprs	(O)

TCTRUSHAPE_API int TCTRUSHAPE_end_item_search_result_ask_next_bom_lines	(	tag_t	searchResultObject,
		int	groupNumber,
		int *	numBOMLines,
		tag_t **	bomLines
	)

Returns next "numBOMLines" BOM lines from this search result object. Note that when last bom line is returned, search result object is deleted and its tag is no longer valid.

Parameters

searchResultObject	(I)
groupNumber	(I)
numBOMLines	(O)
bomLines	(O)

TCTRUSHAPE_API int TCTRUSHAPE_init_module

(

void

)

Initializes TCTRUSHAPE module. Please note that this functional is called internally during overall system initialization, and doesn't have effect if called after that.

If system has successfully initialized itself, this function always returns ITK_ok.

TCTRUSHAPE_API int TCTRUSHAPE_is_occupancy_cache_open	(	tag_t	appearanceRoot,
		logical *	open
	)

Checks if occupancy cache for this appearance root is open.

Parameters

appearanceRoot	(I)
open	(O)

TCTRUSHAPE_API int TCTRUSHAPE_open_occupancy_cache_for_read

(

tag_t

appearanceRoot

)

Opens occupancy cache for read only (i.e. no update is allowed when cache is open in this mode).

Parameters

appearanceRoot

(I)

TCTRUSHAPE_API int TCTRUSHAPE_open_occupancy_cache_for_write

(

tag_t

appearanceRoot

)

Opens occupancy cache for update. New appearance records can be added when occupancy cache is open in this mode.

Parameters

appearanceRoot

(I)

TCTRUSHAPE_API int TCTRUSHAPE_spatial_3d_box_search	(	tag_t	appearanceRoot,
		int	boxRelativePosition,
		VEC3_t	planeNormals[6],
		double	planeDisplacements[6],
		int *	numAppearances,
		tag_t **	appearances
	)

Returns all appearances inside, outside or interfering with the specified 3d box. Allowed box relative positions values are:

• TCTRUSHAPE_inside_box
• TCTRUSHAPE_outside_box
• TCTRUSHAPE_interferes_with_box

Parameters

appearanceRoot	(I) Appearance set tag against which search is performed
boxRelativePosition	(I) Box zone spatial relative position to products components
planeNormals	(I) Coordinates of 3d box zone. Note that no more than one proximity criteria (target proximity or zone) can be specified. If both of them are specified, then only target proximity search is performed.
planeDisplacements	(I)
numAppearances	(O)
appearances	(OF) numAppearances Array of appearances matching box zone criteria

TCTRUSHAPE_API int TCTRUSHAPE_spatial_3d_plane_search	(	tag_t	appearanceRoot,
		int	planeRelativePosition,
		VEC3_p_t	planeNormal,
		double	planeDisplacement,
		int *	numAppearances,
		tag_t **	appearances
	)

Returns all appearances above, below or interfering with the specified 3d plane. Allowed plane relative positions values are:

• TCTRUSHAPE_above_plane
• TCTRUSHAPE_below_plane
• TCTRUSHAPE_interferes_with_plane

Parameters

appearanceRoot	(I) Appearance set tag against which search is performed
planeRelativePosition	(I) Plane zone spatial relative position to products components
planeNormal	(I) Coordinates of 3d plane zone. Note that no more than one proximity criteria (target proximity or zone) can be specified. If both of them are specified, then only target proximity search is performed.
planeDisplacement	(I)
numAppearances	(O)
appearances	(OF) numAppearances Array of appearances matching plane zone criteria

TCTRUSHAPE_API int TCTRUSHAPE_spatial_filtered_proximity_search	(	tag_t	appearanceRoot,
		int	numTargets,
		tag_t *	targets,
		int	numFilterTargets,
		tag_t *	filterTargets,
		double	distance,
		int *	numAppearances,
		tag_t **	appearances
	)

Returns all appearances "distance" units away from "target" appearances. Note, that this search doesn't take into account configuration rule, so it returns all appearances ever located in proximity of the target appearances. It filters out filterTargets from the set returned.

Parameters

appearanceRoot	(I)
numTargets	(I)
targets	(I)
numFilterTargets	(I)
filterTargets	(I)
distance	(I)
numAppearances	(O)
appearances	(O)

TCTRUSHAPE_API int TCTRUSHAPE_spatial_proximity_search	(	tag_t	appearanceRoot,
		int	numTargets,
		tag_t *	targets,
		double	distance,
		int *	numAppearances,
		tag_t **	appearances
	)

Returns all appearances "distance" units away from "target" appearances. Note, that this search doesn't take into account configuration rule, so it returns all appearances ever located in proximity of the target appearances.

Parameters

appearanceRoot	(I)
numTargets	(I)
targets	(I)
distance	(I)
numAppearances	(O)
appearances	(O)

TCTRUSHAPE_API int TCTRUSHAPE_write_appearance_occupancy_data	(	tag_t	appearanceRoot,
		tag_t	appearance
	)

Adds occupancy data for this appearance to occupancy cache. Cache must be opened for writing. If corresponding item revision doesn't have occupancy data or occupancy data could not be generated, nothing will be written to occupancy cache.

Parameters

appearanceRoot	(I)
appearance	(I)

TCTRUSHAPE_API int TRUSHAPE__extract_bbox_nosave	(	tag_t	directmodel_dataset,
		double	bbox[6]
	)

Extracts the Bounding box information from the provided DirectModel dataset. The bounding box information is not persisted in the database.

The function returns:

• ITK_ok on success
• TCTRUSHAPE_translation_jt2tso_failed, if the bounding box extraction has failed due to any reason.

Parameters

directmodel_dataset	(I) tag value of the DirectModel dataset from which the bounding box will be extracted
bbox	(O) Bounding box values extracted from the DirectModel dataset

TCTRUSHAPE_API int TRUSHAPE__extract_bbox_trushape	(	tag_t	directmodel_dataset,
		int	conversion_mode,
		double	bbox[6]
	)

Extracts and saves Bounding box and Trushape from a given DirectModel dataset

Parameters

directmodel_dataset	(I)
conversion_mode	(I)
bbox	(O)

TCTRUSHAPE_API int TRUSHAPE__generate_bbox_trushape_from_jt	(	int	num_datasets,
		tag_t *	directmodel_datasets,
		int	conversion_mode,
		int *	num_out_datasets,
		tag_t **	out_datasets,
		int *	num_error_datasets,
		tag_t **	error_datasets,
		int **	error_codes
	)

Extracts and saves Bounding boxes and Trushape files, given DirectModel datasets.

Parameters

num_datasets	(I)
directmodel_datasets	(I)
conversion_mode	(I)
num_out_datasets	(O)
out_datasets	(OF) num_out_datasets
num_error_datasets	(O)
error_datasets	(OF) num_error_datasets
error_codes	(OF) num_error_datasets