idc.h File Reference

#include <fclasses/tc_basic.h>
#include <ai/libai_exports.h>
#include <ai/libai_undef.h>

Go to the source code of this file.

Functions
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

This file contains methods related to Application Interface module.

A state of an object can be captured using the Application Interface & Request object APIs.

Intermediate Data Capture module basically provides APIs to view the captured state of an
object in the form of a tree structure.

To view the captured state of an object, a user needs to create IDCWindow, set the context on
window as "BOM" for a structure, "Attachment" for attachments of bomline, "Activity" for activities
of an operation. Open the request object or snapshot that store plmxml file or plmxml file itself in
IDCwindow. The Root of the PLMXML file is set as the root of the IDCWindow.

IDC also uses an alias file which basically determines what needs to be displayed in the window.
The alias file will basically have three alias, Root, Children & Properties in the format
<Context.aliasname>. The Root alias will determine the root of the window, children alias will
determine the children for each line and the property alias determine the properties for each
line in the window.

Definition in file idc.h.