Intermediate Data Capture

IDC Setup functions
AI_API int	IDC_init_module ()
AI_API int	IDC_exit_module ()

IDC Window Functions
AI_API int	IDC_create_window (const char *context, tag_t *window)
AI_API int	IDC_close_window (tag_t window)
AI_API int	IDC_set_window_top_line (tag_t window, const char *alias_file, const char *xml_file, tag_t *idc_top_line)
AI_API int	IDC_set_window_top_line_request (tag_t window, const char *preference_key, tag_t request, tag_t *idc_top_line)
AI_API int	IDC_set_window_top_line_snapshot (tag_t window, const char *preference_key, tag_t snapshot, tag_t *idc_top_line)
AI_API int	IDC_set_window_top_line_idcline (tag_t window, tag_t idc_line, const char *preference_key, tag_t *idc_top_line)
AI_API int	IDC_ask_window_top_line (tag_t window, tag_t *idc_top_line)
AI_API int	IDC_ask_window_roots (tag_t window, int *count, tag_t **roots)
AI_API int	IDC_change_window_top_line (tag_t window, tag_t idcLine)

IDC Line Functions
AI_API int	IDC_line_ask_child_lines (tag_t idc_line, int *count, tag_t **children)

Detailed Description

Function Documentation

AI_API int IDC_ask_window_roots	(	tag_t	window,
		int *	count,
		tag_t **	roots
	)

Returns all the roots of the window

Parameters

window	(I) Tag of the window
count	(O) Number of roots returned
roots	(OF) Returned root tags

AI_API int IDC_ask_window_top_line	(	tag_t	window,
		tag_t *	idc_top_line
	)

Returns the tag of the top line of the window

Parameters

window	(I) Tag of the window
idc_top_line	(O) Window's top line

AI_API int IDC_change_window_top_line	(	tag_t	window,
		tag_t	idcLine
	)

Replaces the root of the window with the specified line

Parameters

window	(I) Tag of window
idcLine	(I) Tag of the root idcline

AI_API int IDC_close_window

(

tag_t

window

)

Close IDC Window

Parameters

window

(I) Tag of the window

AI_API int IDC_create_window	(	const char *	context,
		tag_t *	window
	)

Creates a new IDC Window and returns the tag of the newly created window.

Parameters

context	(I) Context for the window
window	(O) Tag of the newly created window

AI_API int IDC_exit_module

(

)

Cleans up and exits the IDC module. This function will be called by the standard ITK exit code. The ITK programmer can ignore this function.

AI_API int IDC_init_module

(

)

Initializes the IDC module. This function must be called before using any other IDC functions. This function will be called by the standard ITK startup code. The ITK programmer can ignore this function.

AI_API int IDC_line_ask_child_lines	(	tag_t	idc_line,
		int *	count,
		tag_t **	children
	)

Returns the child lines of a specified parent line The first time this function is called it will load the lines

Parameters

idc_line	(I) Tag of parent line
count	(O) Number of child line returned
children	(OF) Tags of returned lines

AI_API int IDC_set_window_top_line	(	tag_t	window,
		const char *	alias_file,
		const char *	xml_file,
		tag_t *	idc_top_line
	)

Set the root of PLMXML structure as the top line of a given idc window. Any existing structure in this window is lost.

Parameters

window	(I) Tag of the window
alias_file	(I) Alias xml file
xml_file	(I) structure plmxml file
idc_top_line	(O) Tag of newly creted top line

AI_API int IDC_set_window_top_line_idcline	(	tag_t	window,
		tag_t	idc_line,
		const char *	preference_key,
		tag_t *	idc_top_line
	)

Set the idcline of one window as the topline of another window. This will use the plmxml file associated with the idcline window.

Parameters

window	(I) Tag of the window
idc_line	(I) Tag of the idcline of another window
preference_key	(I) Preference variable point to alias file
idc_top_line	(O) Tag of newly created top line

AI_API int IDC_set_window_top_line_request	(	tag_t	window,
		const char *	preference_key,
		tag_t	request,
		tag_t *	idc_top_line
	)

Set the top line of the structure stored with the request object for a given idc window.

Parameters

window	(I) Tag of the window
preference_key	(I) Preference variable pointing to alias file
request	(I) Tag of a request object
idc_top_line	(O) Tag of newly created top line

AI_API int IDC_set_window_top_line_snapshot	(	tag_t	window,
		const char *	preference_key,
		tag_t	snapshot,
		tag_t *	idc_top_line
	)

Set the top line of the structure stored with the snapshot dataset object for a given idc window.

Parameters

window	(I) Tag of the window
preference_key	(I) Preference variable pointing to alias file
snapshot	(I) Tag of snapshot dataset
idc_top_line	(O) Tag of newly created top line