ITK Function Reference

(V10000.1.0.60_20160308.00)
Macros | Enumerations | Functions
pdi_external.h File Reference
#include <unistd.h>
#include <common/emh_const.h>
#include <nxmgr_im/libnxmgr_im_exports.h>
#include <nxmgr_im/iman_pdi_external.h>
#include <nxmgr_im/libnxmgr_im_undef.h>

Go to the source code of this file.

Macros

#define PDI_access_denied   EMH_API_error_base + 4
 
#define PDI_attr_has_no_value   EMH_API_error_base + 25
 
#define PDI_call_block   EMH_API_error_base + 13
 
#define PDI_cancel_export_fail   EMH_API_error_base + 18
 
#define PDI_copy_appdata_fail   EMH_API_error_base + 20
 
#define PDI_fail   EMH_API_error_base
 
#define PDI_foreign_object   EMH_API_error_base + 32
 
#define PDI_im_no_nx_view_type   PDI_tc_error_base + 1
 
#define PDI_import_files_fail   EMH_API_error_base + 17
 
#define PDI_invalid_date_format   EMH_API_error_base + 29
 
#define PDI_invalid_mapping_for_object   EMH_API_error_base + 26
 
#define PDI_invalid_pref_scope   EMH_API_error_base + 34
 
#define PDI_invalid_role   EMH_API_error_base + 14
 
#define PDI_invalid_tag   EMH_API_error_base + 3
 
#define PDI_item_already_registered   EMH_API_error_base + 38
 
#define PDI_login_failed   EMH_API_error_base + 6
 
#define PDI_modified_elsewhere   EMH_API_error_base + 27
 
#define PDI_more_than_one_objects   EMH_API_error_base + 33
 
#define PDI_no_clipboard   EMH_API_error_base + 24
 
#define PDI_no_export_directory   EMH_API_error_base + 16
 
#define PDI_not_implemented   EMH_API_error_base + 8
 
#define PDI_not_licensed   EMH_API_error_base + 28
 
#define PDI_not_locker   EMH_API_error_base + 11
 
#define PDI_not_remote   EMH_API_error_base + 36
 
#define PDI_null   EMH_API_error_base + 2
 
#define PDI_null_input_string   EMH_API_error_base + 21
 
#define PDI_object_already_added   EMH_API_error_base + 30
 
#define PDI_object_deleted   EMH_API_error_base + 23
 
#define PDI_object_exists   EMH_API_error_base + 5
 
#define PDI_object_locked   EMH_API_error_base + 10
 
#define PDI_object_not_locked   EMH_API_error_base + 12
 
#define PDI_ok   0
 
#define PDI_pdm_internal   EMH_API_error_base + 7
 
#define PDI_rdbms_error   EMH_API_error_base + 31
 
#define PDI_read_only   EMH_API_error_base + 9
 
#define PDI_remote_item_not_co   EMH_API_error_base + 35
 
#define PDI_remove_export_dir_fail   EMH_API_error_base + 19
 
#define PDI_return_code_t   int
 
#define PDI_rpc_fail   EMH_API_error_base + 1
 
#define PDI_server_disconnected   EMH_API_error_base + 37
 
#define PDI_tc_error_base   EMH_API_error_base + 1000
 
#define PDI_tcfs_error   PDI_tc_error_base + 3
 
#define PDI_unable_to_create_dir   EMH_API_error_base + 15
 
#define PDI_unused_error   EMH_API_error_base + 39
 
#define PDI_user_exit_failure   EMH_API_error_base + 22
 
#define PDI_volume_full   PDI_tc_error_base + 2
 
PDI equivalents

For values used when calling the unix access function

#define PDI_W_OK   2
 
#define PDI_R_OK   4
 
Class IDs
#define PDI_class_t   int
 
#define PDI_class_p_t   int*
 
#define PDI_none_class   0
 
#define PDI_part_class   1
 
#define PDI_partrev_class   2
 
#define PDI_rep_class   3
 
#define PDI_reprev_class   4
 
#define PDI_appdata_class   5
 
#define PDI_appver_class   6
 
#define PDI_container_class   7
 
#define PDI_component_class   8
 
#define PDI_attribute_class   9
 
#define PDI_apptype_class   10
 
#define PDI_reltype_class   11
 
#define PDI_parttype_class   12
 
#define PDI_attr_mapping_class   13
 
#define PDI_lov_class   14
 
#define PDI_opaque_object_class   15
 
#define PDI_unused_class   16
 
#define PDI_CLASS_COUNT   17
 
File formats in Application Data Versions
#define PDI_appver_format_t   int
 
#define PDI_appver_format_p_t   int*
 
#define PDI_none_format   0
 
#define PDI_ascii_format   1
 
#define PDI_binary_format   2
 
#define PDI_unused_format   3
 
#define PDI_APPVER_FORMAT_COUNT   4
 
Supported Machine types
#define PDI_machine_type_t   int
 
#define PDI_none_machine_type   0
 
#define PDI_unix   1
 
#define PDI_wnt   3
 
#define PDI_unused_machine_type   4
 
#define PDI_MACHINE_TYPE_COUNT   5
 
Network Transports supported by RPC
#define PDI_transport_t   int
 
#define PDI_none_transport   0
 
#define PDI_sys5_msg   1
 
#define PDI_tcpip   2
 
#define PDI_sockets   3
 
#define PDI_tc_ss   4
 
#define PDI_unused_transport   6
 
#define PDI_TRANSPORT_COUNT   7
 
Possible values for lock status

Returned by PDI_ask_appdata_lock_status()

#define PDI_lock_status_t   int
 
#define PDI_not_locked   0
 
#define PDI_locked_by_caller   1
 
#define PDI_locked_by_other   2
 
#define PDI_locked_and_exported   3
 
#define PDI_checked_out   4
 
States of part number validity

Returned from PDI_validate_part_rev_id()

#define PDI_partno_validity_t   int
 
#define PDI_partno_valid   0
 
#define PDI_partno_invalid   1
 
#define PDI_partno_modified   2
 
#define PDI_partno_override   3
 
Constants for use by the operations functions and their callers
#define PDI_operation_ok   0
 
#define PDI_operation_failed   1
 
#define PDI_nx_load_operation   "Unigraphics Part Load"
 
#define PDI_nx_load_operation_NX3   "Part Load"
 
Bitmask for PDI_forget_var_configs
#define PDI_DISPLAYED_PART_ROLE   ( 1 << 0 )
 
#define PDI_PROD_ASSY_ROLE   ( 1 << 1 )
 
Tokens for the PDI search functions
#define PDI_SEARCH_FIND_MORE   0
 
#define PDI_SEARCH_FIND_ALL   -1
 
#define PDI_SEARCH_CONTEXT_ALL   0
 
#define PDI_SEARCH_CONTEXT_INFO   1
 
Flags

Indicate which mass properties are actually specified for AppData objects

#define PDI_masspr_accuracy_defined   (1 << 0)
 
#define PDI_masspr_mass_defined   (1 << 1)
 
#define PDI_masspr_volume_defined   (1 << 2)
 
#define PDI_masspr_density_defined   (1 << 3)
 
#define PDI_masspr_area_defined   (1 << 4)
 
#define PDI_masspr_com_defined   (1 << 5)
 
#define PDI_masspr_inertia_defined   (1 << 6)
 
#define PDI_masspr_min_mass_defined   (1 << 7)
 
#define PDI_masspr_max_mass_defined   (1 << 8)
 
Indexes

For the order in which the Mass Property values are passed

#define PDI_masspr_accuracy_index   0
 
#define PDI_masspr_mass_index   1
 
#define PDI_masspr_mass_err_index   2
 
#define PDI_masspr_volume_index   3
 
#define PDI_masspr_volume_err_index   4
 
#define PDI_masspr_area_index   5
 
#define PDI_masspr_area_err_index   6
 
#define PDI_masspr_density_index   7
 
#define PDI_masspr_com_x_index   8
 
#define PDI_masspr_com_y_index   9
 
#define PDI_masspr_com_z_index   10
 
#define PDI_masspr_com_err_index   11
 
#define PDI_masspr_moi_xx_index   12
 
#define PDI_masspr_moi_yy_index   13
 
#define PDI_masspr_moi_zz_index   14
 
#define PDI_masspr_poi_xy_index   15
 
#define PDI_masspr_poi_xz_index   16
 
#define PDI_masspr_poi_yz_index   17
 
#define PDI_masspr_inertia_err_index   18
 
#define PDI_masspr_min_mass_index   19
 
#define PDI_masspr_max_mass_index   20
 
#define PDI_MASSPR_ARRAY_SIZE   21
 

Enumerations

enum  PDI_LOV_usage_t { PDI_LOV_unknown, PDI_LOV_exhaustive, PDI_LOV_suggested, PDI_LOV_bounded }
 
enum  PDI_value_t {
  PDI_int_value, PDI_double_value, PDI_string_value, PDI_date_value,
  PDI_tag_value, PDI_logical_value, PDI_unknown_value, PDI_unsupported_value,
  PDI_strings_value
}
 

Functions

NXMGR_IM_API char * PDI_format_name (int format)
 

Prototypes and global variables

For error handling system in PDI module interface

typedef PDI_return_code_t(* PDI_error_handler_t )(const char *function_name, const PDI_return_code_t code)
 
NXMGR_IM_API void PDI_set_error_handler (PDI_error_handler_t handler)
 
NXMGR_IM_API void PDI_allow_no_errors (void)
 
NXMGR_IM_API void PDI_allow_selected_errors (const int error_count, const PDI_return_code_t errors[])
 
NXMGR_IM_API void PDI_allow_all_errors (void)
 

Initialization routines for client and server processes

typedef void(* PDI_input_callback_proc )(void *, int *, void **)
 
typedef void *(* PDI_add_input_func_t )(void *, int, void *, PDI_input_callback_proc, void *)
 
typedef void(* PDI_remove_input_func_t )(void *)
 
NXMGR_IM_API PDI_return_code_t PDI_init_server (char *process_id, void *ctxt, PDI_transport_t transport, char *ipcdata, PDI_add_input_func_t AppAddInput, PDI_remove_input_func_t RemoveInput)
 
NXMGR_IM_API PDI_return_code_t PDI_server_shutdown (void)
 
NXMGR_IM_API PDI_return_code_t PDI_init_client (char *process_id)
 
NXMGR_IM_API void PDI_version (char **letters, int *major_number, int *minor_number)
 

Detailed Description

External header file containing constants and data structures for Product Data Interface (PDI) module. This file is included by pdi.h

Definition in file pdi_external.h.