te.h File Reference

#include <tc/tc_startup.h>
#include <tccore/tctype.h>
#include <tccore/item.h>
#include <sa/tcfile.h>
#include <itk/libitk_exports.h>
#include <itk/libitk_undef.h>

Go to the source code of this file.

Macros
#define	TE_CFG_FILE   "te.cfg"
#define	TE_LOG_FILE   "te.log"
#define	TE_LW   "Latest Working"
#define	TE_MAXLINELEN   256
#define	TE_PACK   0
#define	TE_PACK_PREF   2
#define	TE_UNPACK   1

Typedefs
typedef TE_decision(*	TE_handler_t )(char *, tag_t, int)

Enumerations
enum	HandlerTypes {   TE_NODE_SELECTOR, TE_REG_HANDLER, TE_ROOT_ENTRY, TE_ROOT_EXIT,   TE_AT_NODE, TE_FORWARD_ENTRY, TE_FORWARD_EXIT, TE_REVERSE_ENTRY,   TE_REVERSE_EXIT }
enum	Output { TE_LOG, TE_STDOUT, TE_LOGANDSTDOUT }
enum	TE_decision {   TE_CONTINUE, TE_STOP, TE_SKIPCHILDREN, TE_GOBACK,   TE_SKIP }

Functions
ITK_API int	TE_exit_module (void)
ITK_API int	TE_get_preference (const char *sym, char **pref)
ITK_API int	TE_get_preference_list (const char *sym, int *nofound, char ***stlist)
ITK_API int	TE_get_statistics (int *warn_cnt, int *skipchild_cnt, int *skip_cnt, int *total_cnt)
ITK_API int	TE_init_module ()
ITK_API int	TE_node_get_data (int *childnodes, char type[ITEM_desc_size_c])
ITK_API int	TE_node_get_data2 (int *childnodes, char **type)
ITK_API int	TE_node_set_type (const char *ntype)
ITK_API int	TE_parentnode_get_data (int *childnodes, char *type, tag_t *tag, int *depth)
ITK_API int	TE_parentnode_set_type (const char *ntype)
ITK_API int	TE_PS_fill_and_traverse_tree ()
ITK_API int	TE_PS_fill_tree ()
ITK_API int	TE_PS_get_config_params (char **viewtype, char **variant, char **revrule, char **sub)
ITK_API int	TE_PS_get_config_params_with_pack (char **viewtype, char **variant, char **revrule, char **alt, int *packstate)
ITK_API int	TE_PS_initialize (const char *itemid, const char *rev)
ITK_API int	TE_PS_set_config (const char *viewtype, const char *variant, const char *revrule, const char *sub)
ITK_API int	TE_PS_set_config_with_pack (const char *viewtype, const char *variant, const char *revrule, const char *alt, int packstate)
ITK_API int	TE_PS_traverse_tree ()
ITK_API int	TE_PS_ui_get_data (char itemid[ITEM_id_size_c+1], char itemrev[ITEM_id_size_c+1], char logfile[IMF_filename_size_c+1], char configfile[IMF_filename_size_c+1])
ITK_API int	TE_PS_ui_get_data2 (char **itemid, char **itemrev, char **logfile, char **configfile)
ITK_API int	TE_register_node_handler (int handlertype, TE_handler_t afun)
ITK_API int	TE_table_get_float (const char *key, float *afloat)
ITK_API int	TE_table_store_float (const char *key, float sfloat)
ITK_API int	TE_ui_get_logfile_pointer (FILE **logfileptr)
ITK_API int	TE_ui_increment_warnings ()
ITK_API int	TE_ui_print_message (int output, int warn, int ifail, const char *msg)
ITK_API int	TE_ui_set_configfile (const char *fname)
ITK_API int	TE_ui_set_logfile (const char *fname)
ITK_API int	TE_ui_set_validate_args ()

Detailed Description

This file contains function prototypes for traversal engine module. The traverse module attempts to present an interface that allow to develop programs that do traversal of Teamcenter structures. Presently this can be done only for product structure.

Calls are provided for the following:

• Initializing/Terminating TE.
• Registering Handlers and Selector
• Setting revrule, bomview type and variant name to configure PS
• Filling a tree by running a Selector that determines whether a branch needs to be skipped or not
• Traversing the tree and executing different handlers
• Storing/retreiving float value with a key
• Funciton calls to write to log file, read from config file, report statistics etc.

Definition in file te.h.