|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
|
ITK Function Reference
(V10000.1.0.60_20160308.00) |
#include <dispatcher/libdispatcher_exports.h>#include <dispatcher/dispatcher_errors.h>#include <time.h>#include <dispatcher/libdispatcher_undef.h>Go to the source code of this file.
Macros | |
| #define | DISPATCHER_PREF_INPROCESS_STATES "TS_inprocess_states"; |
| #define | DISPATCHER_PREF_SUCCESSFUL_STATES "TS_successful_states"; |
| #define | DISPATCHER_PREF_UNSUCCESSFUL_STATES "TS_unsuccessful_states"; |
| #define | DISPATCHER_UPDATE_EXISTING "ETSUpdOvr" |
| #define | ETS_TRANSLATION_ARG_MIN_SIZE 3 |
| #define | ETS_TRANSLATION_ARG_NAME_TRIGGER "ETSTrigger" |
| #define | ETS_TRANSLATION_ARG_NAME_UPDATE_OVR "ETSUpdOvr" |
| #define | ETS_TRANSLATION_ARG_NV_SEP "=" |
| #define | ETS_translation_arg_size_c 255 |
| #define | ETS_TRANSLATION_ARG_VALUE_FALSE "false" |
| #define | ETS_TRANSLATION_ARG_VALUE_TRUE "true" |
Functions | |
| int DISPATCHER_API | DISPATCHER_add_files_to_request (const tag_t request, const int numFiles, const char **fileKeys, const char **files) |
| int DISPATCHER_API | DISPATCHER_create_request (const char *provider_name, const char *service_name, const int priority, const time_t start_time, const time_t end_time, const int interval, const int num_objs, const tag_t *primary_objs, const tag_t *secondary_objs, const int num_args, const char **request_args, const char *type, const int num_datafiles, const char **data_file_keys, const char **datafiles, tag_t *request) |
| int DISPATCHER_API | DISPATCHER_delete_request (tag_t requestToDelete, int ignoreState) |
| int DISPATCHER_API | DISPATCHER_find_request_by_tag (const tag_t requestTag, char **task_id, char **providerName, char **serviceName, int *priority, char **currentState, char **type, int *numObjs, tag_t **primaryObjs, tag_t **secondaryObjs, int *numArgs, char ***argKeys, char ***argData) |
| int DISPATCHER_API | DISPATCHER_get_files_from_request (const tag_t request, const int numKeys, const char **keys, const char *path) |
| int DISPATCHER_API | DISPATCHER_is_final_state (const tag_t request, int *isFinalState) |
| int DISPATCHER_API | DISPATCHER_query_requests (const int num_providers, const char **providers, const int num_services, const char **services, const int num_states, const char **states, const int num_priorities, const int *priorities, const int num_users, const char **owning_users, const int num_taskids, const char **task_ids, int *num_requests, tag_t **queried_requests) |
| int DISPATCHER_API | DISPATCHER_wait_for_request (tag_t request, int interval, int time_to_wait, logical *is_final) |
| int DISPATCHER_API | ETS_create_request (const int num_objs, const tag_t *primary_objs, const tag_t *secondary_objs, const int sched_priority, const char *provider_name, const char *translator_name, const char *trigger, tag_t *request) |
| int DISPATCHER_API | ETS_create_request2 (const int num_objs, const tag_t *primary_objs, const tag_t *secondary_objs, const int priority, const char *provider_name, const char *translator_name, const char *trigger, const int num_translation_args, const char **translation_args, tag_t *request) |
| int DISPATCHER_API | ETS_find_request_by_tag (const tag_t requestTag, char **task_id, char **state, int *num_objs, tag_t **primary_objs, tag_t **secondary_objs, int *priority, char **provider_name, char **translator_name, int *num_trans_args, char ***translation_args) |
| int DISPATCHER_API | ETS_is_final_state (const tag_t request, int *isFinalState) |
| int DISPATCHER_API | ETS_query_requests (const char *translationRequestState, int *numTranslationRequests, tag_t **translationRequests) |
This file contains the different ITK methods available for the Dispatcher Management application for Teamcenter.
Definition in file dispatcher_itk.h.
| #define DISPATCHER_PREF_INPROCESS_STATES "TS_inprocess_states"; |
Definition at line 40 of file dispatcher_itk.h.
| #define DISPATCHER_PREF_SUCCESSFUL_STATES "TS_successful_states"; |
Definition at line 38 of file dispatcher_itk.h.
| #define DISPATCHER_PREF_UNSUCCESSFUL_STATES "TS_unsuccessful_states"; |
Definition at line 39 of file dispatcher_itk.h.
| #define DISPATCHER_UPDATE_EXISTING "ETSUpdOvr" |
Definition at line 35 of file dispatcher_itk.h.
| #define ETS_TRANSLATION_ARG_MIN_SIZE 3 |
Definition at line 53 of file dispatcher_itk.h.
| #define ETS_TRANSLATION_ARG_NAME_TRIGGER "ETSTrigger" |
Definition at line 56 of file dispatcher_itk.h.
| #define ETS_TRANSLATION_ARG_NAME_UPDATE_OVR "ETSUpdOvr" |
Definition at line 62 of file dispatcher_itk.h.
| #define ETS_TRANSLATION_ARG_NV_SEP "=" |
Definition at line 52 of file dispatcher_itk.h.
| #define ETS_translation_arg_size_c 255 |
Definition at line 51 of file dispatcher_itk.h.
| #define ETS_TRANSLATION_ARG_VALUE_FALSE "false" |
Definition at line 68 of file dispatcher_itk.h.
| #define ETS_TRANSLATION_ARG_VALUE_TRUE "true" |
Definition at line 67 of file dispatcher_itk.h.
| int DISPATCHER_API DISPATCHER_add_files_to_request | ( | const tag_t | request, |
| const int | numFiles, | ||
| const char ** | fileKeys, | ||
| const char ** | files | ||
| ) |
| request | (I) tag of the request |
| numFiles | (I) number of files to upload |
| fileKeys | (I) file keys to associate to files |
| files | (I) ABSOLUTE paths to file to upload |
| int DISPATCHER_API DISPATCHER_create_request | ( | const char * | provider_name, |
| const char * | service_name, | ||
| const int | priority, | ||
| const time_t | start_time, | ||
| const time_t | end_time, | ||
| const int | interval, | ||
| const int | num_objs, | ||
| const tag_t * | primary_objs, | ||
| const tag_t * | secondary_objs, | ||
| const int | num_args, | ||
| const char ** | request_args, | ||
| const char * | type, | ||
| const int | num_datafiles, | ||
| const char ** | data_file_keys, | ||
| const char ** | datafiles, | ||
| tag_t * | request | ||
| ) |
| provider_name | (I) provider name |
| service_name | (I) service name |
| priority | (I) priority |
| start_time | (I) start time |
| end_time | (I) end time |
| interval | (I) repeating interval |
| num_objs | (I) number of primary/secondary objects |
| primary_objs | (I) primary objects |
| secondary_objs | (I) secondary objects |
| num_args | (I) number of request arguments |
| request_args | (I) request arguments |
| type | (I) request type string |
| num_datafiles | (I) number of datafiles to attach |
| data_file_keys | (I) keys for data files to attach |
| datafiles | (I) data files to attach absolute path |
| request | (O) created request |
| int DISPATCHER_API DISPATCHER_delete_request | ( | tag_t | requestToDelete, |
| int | ignoreState | ||
| ) |
| requestToDelete | (I) tag of the request to delete |
| ignoreState | (I) should state be checked, 1=YES, 0=NO |
| int DISPATCHER_API DISPATCHER_find_request_by_tag | ( | const tag_t | requestTag, |
| char ** | task_id, | ||
| char ** | providerName, | ||
| char ** | serviceName, | ||
| int * | priority, | ||
| char ** | currentState, | ||
| char ** | type, | ||
| int * | numObjs, | ||
| tag_t ** | primaryObjs, | ||
| tag_t ** | secondaryObjs, | ||
| int * | numArgs, | ||
| char *** | argKeys, | ||
| char *** | argData | ||
| ) |
| requestTag | (I) tag of the request |
| task_id | (OF) task id |
| providerName | (OF) provider name |
| serviceName | (OF) service name |
| priority | (O) priority of the request |
| currentState | (OF) current state |
| type | (OF) type |
| numObjs | (O) number of primary/secondary object references |
| primaryObjs | (OF) numObjs an array of primary object tags |
| secondaryObjs | (OF) numObjs an array of secondary object tags |
| numArgs | (O) number of arguments |
| argKeys | (OF) numArgs array of argument keys |
| argData | (OF) numArgs array of argument data |
| int DISPATCHER_API DISPATCHER_get_files_from_request | ( | const tag_t | request, |
| const int | numKeys, | ||
| const char ** | keys, | ||
| const char * | path | ||
| ) |
| request | (I) tag of the request |
| numKeys | (I) number of keys for files to get |
| keys | (I) keys for files to get |
| path | (I) folder to output files |
| int DISPATCHER_API DISPATCHER_is_final_state | ( | const tag_t | request, |
| int * | isFinalState | ||
| ) |
| request | (I) tag of the request |
| isFinalState | (O) 0 - not final state, 1 - final state |
| int DISPATCHER_API DISPATCHER_query_requests | ( | const int | num_providers, |
| const char ** | providers, | ||
| const int | num_services, | ||
| const char ** | services, | ||
| const int | num_states, | ||
| const char ** | states, | ||
| const int | num_priorities, | ||
| const int * | priorities, | ||
| const int | num_users, | ||
| const char ** | owning_users, | ||
| const int | num_taskids, | ||
| const char ** | task_ids, | ||
| int * | num_requests, | ||
| tag_t ** | queried_requests | ||
| ) |
| num_providers | (I) number of provider |
| providers | (I) providers array |
| num_services | (I) number of services |
| services | (I) services array |
| num_states | (I) number of states |
| states | (I) states array |
| num_priorities | (I) number of priorities |
| priorities | (I) priority array |
| num_users | (I) number of users |
| owning_users | (I) user array |
| num_taskids | (I) number of task ids |
| task_ids | (I) task id array |
| num_requests | (O) number of requests |
| queried_requests | (OF) num_requests number of requests found |
| int DISPATCHER_API DISPATCHER_wait_for_request | ( | tag_t | request, |
| int | interval, | ||
| int | time_to_wait, | ||
| logical * | is_final | ||
| ) |
| request | (I) tag of the request to wait |
| interval | (I) interval defining how often the request state should be checked |
| time_to_wait | (I) time in seconds to continue checking, 0 = no time limit |
| is_final | (O) boolean specifying if the request was complete or not |
| int DISPATCHER_API ETS_create_request | ( | const int | num_objs, |
| const tag_t * | primary_objs, | ||
| const tag_t * | secondary_objs, | ||
| const int | sched_priority, | ||
| const char * | provider_name, | ||
| const char * | translator_name, | ||
| const char * | trigger, | ||
| tag_t * | request | ||
| ) |
| int DISPATCHER_API ETS_create_request2 | ( | const int | num_objs, |
| const tag_t * | primary_objs, | ||
| const tag_t * | secondary_objs, | ||
| const int | priority, | ||
| const char * | provider_name, | ||
| const char * | translator_name, | ||
| const char * | trigger, | ||
| const int | num_translation_args, | ||
| const char ** | translation_args, | ||
| tag_t * | request | ||
| ) |
| int DISPATCHER_API ETS_find_request_by_tag | ( | const tag_t | requestTag, |
| char ** | task_id, | ||
| char ** | state, | ||
| int * | num_objs, | ||
| tag_t ** | primary_objs, | ||
| tag_t ** | secondary_objs, | ||
| int * | priority, | ||
| char ** | provider_name, | ||
| char ** | translator_name, | ||
| int * | num_trans_args, | ||
| char *** | translation_args | ||
| ) |
| requestTag | (I) tag of the request |
| task_id | (OF) task id |
| state | (OF) current state |
| num_objs | (O) number of primary/secondary object references |
| primary_objs | (OF) num_objs an array of primary object tags |
| secondary_objs | (OF) num_objs an array of secondary object tags |
| priority | (O) priority of the request |
| provider_name | (OF) provider name |
| translator_name | (OF) service name |
| num_trans_args | (O) number of translator arguments |
| translation_args | (OF) num_trans_args array of translator arguments |
| int DISPATCHER_API ETS_is_final_state | ( | const tag_t | request, |
| int * | isFinalState | ||
| ) |
| request | (I) tag of the request |
| isFinalState | (O) 0 - not final state, 1 - final state |
| int DISPATCHER_API ETS_query_requests | ( | const char * | translationRequestState, |
| int * | numTranslationRequests, | ||
| tag_t ** | translationRequests | ||
| ) |