Modules
	GDE Errors

	GDE Link Type

	GDE Type Functions

Functions
TCCOREEXT_API int	GDE_ask_gde_bvr (tag_t gde_tag, tag_t *gde_bvr_tag)

TCCOREEXT_API int	GDE_ask_item_rev_of_bvr (tag_t gde_bvr_tag, tag_t *item_rev_tag)

TCCOREEXT_API int	GDE_ask_occurrence_child (tag_t gde_occ_tag, tag_t *gde_child_tag)

TCCOREEXT_API int	GDE_ask_occurrence_name (tag_t gde_occ_tag, char **gde_occ_name)

TCCOREEXT_API int	GDE_ask_occurrence_note_text (tag_t gde_occ_tag, tag_t note_type, char **note_text)

TCCOREEXT_API int	GDE_ask_occurrence_type (tag_t gde_occ_tag, tag_t *gde_occ_type)

TCCOREEXT_API int	GDE_ask_view_type (tag_t gde_bvr_tag, tag_t *view_type_tag)

TCCOREEXT_API int	GDE_create (const char gde_name, const char description, const char gde_type, tag_t gde_obj_tag)

TCCOREEXT_API int	GDE_create_gde_bvr (tag_t gde_tag, tag_t view_type, tag_t *gde_bvr_tag)

TCCOREEXT_API int	GDE_create_occurrence (tag_t gde_bvr_tag, tag_t child_gde_tag, tag_t child_view_type, tag_t occurrence_type, double quantity, int instance_no, tag_t *gde_occ_tag)

TCCOREEXT_API int	GDE_delete_occurrence_note (tag_t gde_occ_tag, tag_t note_type)

TCCOREEXT_API int	GDE_list_occurrence_notes (tag_t gde_occ_tag, int notes_count, tag_t *note_types)

TCCOREEXT_API int	GDE_list_occurrences_of_bvr (tag_t gde_bvr_tag, int occ_count, tag_t *gde_occs)

TCCOREEXT_API int	GDE_remove_occurrences (tag_t gde_bvr_tag, int occ_count, tag_t *gde_occs)

TCCOREEXT_API int	GDE_set_occurrence_child (tag_t gde_occ_tag, tag_t gde_child_tag)

TCCOREEXT_API int	GDE_set_occurrence_name (tag_t gde_occ_tag, const char *gde_occ_name)

TCCOREEXT_API int	GDE_set_occurrence_note_text (tag_t gde_occ_tag, tag_t note_type, const char *note_text)

TCCOREEXT_API int	GDE_set_occurrence_type (tag_t gde_occ_tag, tag_t gde_occ_type)

TCCOREEXT_API int	GDE_set_view_type (tag_t gde_bvr_tag, tag_t view_type_tag)

Detailed Description

This module defines the required ITK interface for GeneralDesignElement related operations.

Function Documentation

TCCOREEXT_API int GDE_ask_gde_bvr	(	tag_t	gde_tag,
		tag_t *	gde_bvr_tag
	)

This function will return the GDEBomViewRevision of the given GeneralDesignElement Object

Parameters

gde_tag	(I) Tag of the GeneralDesignElement
gde_bvr_tag	(O) Tag of the GDEbvr

TCCOREEXT_API int GDE_ask_item_rev_of_bvr	(	tag_t	gde_bvr_tag,
		tag_t *	item_rev_tag
	)

This function will return the parent Item Revision of a given GDEBomViewRevision.

Parameters

gde_bvr_tag	(I) Tag of the GDEBvr
item_rev_tag	(O) Tag of the Item Revision

TCCOREEXT_API int GDE_ask_occurrence_child	(	tag_t	gde_occ_tag,
		tag_t *	gde_child_tag
	)

This function will return the child GDE Object of a given GDEOccurrence.

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
gde_child_tag	(O) Tag of the child GeneralDesignElement referenced by the GDEOccurrence

TCCOREEXT_API int GDE_ask_occurrence_name	(	tag_t	gde_occ_tag,
		char **	gde_occ_name
	)

This function returns the Occurrence name of a given GDEOccurrence.

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
gde_occ_name	(OF) Occurrence name of the given GDEOccurrence

TCCOREEXT_API int GDE_ask_occurrence_note_text	(	tag_t	gde_occ_tag,
		tag_t	note_type,
		char **	note_text
	)

This function will return the Occurrence note text of a given GDEOccurrence.

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
note_type	(I) Tag of the Note Type
note_text	(OF) Returns the text of the specified note

TCCOREEXT_API int GDE_ask_occurrence_type	(	tag_t	gde_occ_tag,
		tag_t *	gde_occ_type
	)

This function will return the Occurrence type of a given GDEOccurrence.:

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
gde_occ_type	(O) Tag of the Occurrence Type

TCCOREEXT_API int GDE_ask_view_type	(	tag_t	gde_bvr_tag,
		tag_t *	view_type_tag
	)

This function will return the view type of a given GDEBomViewRevision

Parameters

gde_bvr_tag	(I) Tag of the GDEBvr
view_type_tag	(O) Tag of the View Type

TCCOREEXT_API int GDE_create	(	const char *	gde_name,
		const char *	description,
		const char *	gde_type,
		tag_t *	gde_obj_tag
	)

Deprecated:: This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This function will create a GeneralDesignElement.

Parameters

gde_name	(I) Name of the GeneralDesignElement
description	(I) Description of the GeneralDesignElement
gde_type	(I) Type of the GeneralDesignElement to be created
gde_obj_tag	(O) Tag of the newly created GeneralDesignElement

TCCOREEXT_API int GDE_create_gde_bvr	(	tag_t	gde_tag,
		tag_t	view_type,
		tag_t *	gde_bvr_tag
	)

Deprecated:: This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This function will create a GDEBOMViewRevison

Restrictions:

There can be only one GDEBOMViewRevison for a given view type. If the GDEBOMViewRevison already exits for the given view type, this call returns the tag of the existing GDEBOMViewRevison.

Parameters

gde_tag	(I) Tag of the GeneralDesignElement
view_type	(I) Tag of the View Type
gde_bvr_tag	(O) Tag of the newly created or existing GDEBvr

TCCOREEXT_API int GDE_create_occurrence	(	tag_t	gde_bvr_tag,
		tag_t	child_gde_tag,
		tag_t	child_view_type,
		tag_t	occurrence_type,
		double	quantity,
		int	instance_no,
		tag_t *	gde_occ_tag
	)

Deprecated:: This function is deprecated and will be removed from Tc11. From Tc9.0 onwards, please use generic creation of BusinessObject(i.e createBusinessObject or TCTYPE_create_object ).

This function will create a GDEOccurrence.

Parameters

gde_bvr_tag	(I) Tag of the GDEBvr
child_gde_tag	(I) Tag of the GeneralDesignElement for which GDEOccurrence is to be created
child_view_type	(I) Tag of the view type
occurrence_type	(I) Tag of the GDEOccurrence Type
quantity	(I) Quantity to be set for the newly created GDEOccurrence
instance_no	(I) Instance number to be set for the newly created GDEOccurrence
gde_occ_tag	(O) Tag of the newly created GDEOccurrence

TCCOREEXT_API int GDE_delete_occurrence_note	(	tag_t	gde_occ_tag,
		tag_t	note_type
	)

This function will delete the Occurrence notes for a given GDEOccurrence.

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
note_type	(I) Tag of the textual note to be deleted

TCCOREEXT_API int GDE_list_occurrence_notes	(	tag_t	gde_occ_tag,
		int *	notes_count,
		tag_t **	note_types
	)

This function will list all the Occurrence notes for a given GDEOccurrence

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
notes_count	(O) Number of notes defined for the given GDEOccurrence
note_types	(OF) notes_count Tags of the note types defined for the given GDEOccurrence

TCCOREEXT_API int GDE_list_occurrences_of_bvr	(	tag_t	gde_bvr_tag,
		int *	occ_count,
		tag_t **	gde_occs
	)

This function is used to list the occurrences of a given GDEBomViewRevision

Parameters

gde_bvr_tag	(I) Tag of the GDEBvr
occ_count	(O) Number of GDEOccurrences for the given GDEBvr
gde_occs	(OF) occ_count Tags of the GDEOccurrences

TCCOREEXT_API int GDE_remove_occurrences	(	tag_t	gde_bvr_tag,
		int	occ_count,
		tag_t *	gde_occs
	)

This function will remove the specified GDEOccurrences from the given GDEbvr.

Parameters

gde_bvr_tag	(I) Tag of the GDEBvr
occ_count	(I) Number of the GDEOccurrences to be removed
gde_occs	(I) Tags of the GDEOccurrences to be removed

TCCOREEXT_API int GDE_set_occurrence_child	(	tag_t	gde_occ_tag,
		tag_t	gde_child_tag
	)

This function will set the Occurrence child of GDE occurrence.

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
gde_child_tag	(I) Tag of the child GeneralDesignElement referenced by the GDEOccurrence

TCCOREEXT_API int GDE_set_occurrence_name	(	tag_t	gde_occ_tag,
		const char *	gde_occ_name
	)

This function will set the Occurrence name of a given GDEOccurrence.

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
gde_occ_name	(I) Name to be set for the given GDEOccurrence

TCCOREEXT_API int GDE_set_occurrence_note_text	(	tag_t	gde_occ_tag,
		tag_t	note_type,
		const char *	note_text
	)

This function will set the Occurrence Note Text for a given GDEOccurrence

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
note_type	(I) Tag of the Note Type for which note text is to be set
note_text	(I) Note text to be set for the note type

TCCOREEXT_API int GDE_set_occurrence_type	(	tag_t	gde_occ_tag,
		tag_t	gde_occ_type
	)

This function will set the Occurrence type for a given GDEOccurrence.

Parameters

gde_occ_tag	(I) Tag of the GDEOccurrence
gde_occ_type	(I) Tag of the Occurrence Type to be set for the given GDEOccurrence

TCCOREEXT_API int GDE_set_view_type	(	tag_t	gde_bvr_tag,
		tag_t	view_type_tag
	)

This function will set the view type for a given GDEBomViewRevision.

Parameters

gde_bvr_tag	(I) Tag of the GDEBvr
view_type_tag	(I) Tag of the view type to be set for the GDEBvr

Modules

Functions

Detailed Description

Function Documentation