ITK Function Reference
(V10000.1.0.60_20160308.00)
subscmpl.h
Go to the documentation of this file.
1 /*
2  Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
3  ==================================================
4  Copyright 2014.
5  Siemens Product Lifecycle Management Software Inc.
6  All Rights Reserved.
7  ==================================================
8  Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
9 */
10 
22 #ifndef SUBSCMPL__SUBSCMPLITK_HXX
23 #define SUBSCMPL__SUBSCMPLITK_HXX
24 
25 /****************************************************************************/
26 /* I N C L U D E F I L E S */
27 /****************************************************************************/
28 #include <unidefs.h>
29 #include <scp0subscmpl/libscp0subscmpl_exports.h>
30 
31 #ifdef __cplusplus
32  extern "C"{
33 #endif
34 
38 typedef struct MSD_import_errors_s
39 {
40  char* input_msd_file;
41  int number_of_errors;
42  char** errors;
43 } MSD_import_errors_t;
44 
45 
51 typedef struct SUBSCMPL_import_out_s
52 {
53  char* input_file_fmsticket;
55  char* verdict;
56  int n_errors;
57  char** errors;
59  int n_log_file_fmstickets;
60  char** log_file_fmstickets;
61 }SUBSCMPL_import_out_t;
62 
79 extern SCP0SUBSCMPL_API int SUBSCMPL_ask_result(
80  tag_t input_tag,
81  int *n_results,
82  tag_t **results
83  );
84 
85 
96 extern SCP0SUBSCMPL_API int SUBSCMPL_ask_exemption(
97  tag_t result_tag,
98  int *n_relations,
99  tag_t **p_relations,
100  int *n_exemptions,
101  tag_t **p_exemptions
102  );
103 
113 extern SCP0SUBSCMPL_API int SUBSCMPL_ask_status(
114  tag_t input_tag,
115  int status,
116  tag_t regulation,
117  int *n_parts,
118  char **status_desc
119  );
120 
121 
131 extern SCP0SUBSCMPL_API int SUBSCMPL_ask_latest_result(
132  tag_t input_tag,
133  tag_t regulation,
134  tag_t* latest_result
135  );
136 
137 
181 extern SCP0SUBSCMPL_API int SUBSCMPL_ask_all_results(
182  tag_t input_tag,
183  int *n_items,
184  tag_t **items,
185  int *n_regulations,
186  tag_t **regulations,
187  int *n_results,
188  tag_t **results
189  );
190 
191 
201 extern SCP0SUBSCMPL_API int SUBSCMPL_ask_failed_data(
202  tag_t input_result_tag,
203  tag_t *failed_item,
204  char** failure_reason
205  );
206 
215 extern SCP0SUBSCMPL_API int SUBSCMPL_ask_regulations(
216  int* n_regulations,
217  tag_t** regulations
218  );
219 
234 extern SCP0SUBSCMPL_API int SUBSCMPL_msd_import(
235  const char* ipc_file_name,
236  const char* xsl_file_name,
237  const char* transfer_mode,
238  const char* option_set_name,
239  int master_site,
240  const char* directory_path,
241  const char* mode,
242  int* imported_files_count,
243  MSD_import_errors_t** output_data
244  );
261 extern SCP0SUBSCMPL_API int SUBSCMPL_validate_declarations(
262  const char* declaration_type,
263  const char* xsl_file_fmsticket,
264  int num_input_file_fms_tickets,
266  const char** input_file_fms_tickets,
267  const char* mode,
268  tag_t* session_digest_object
271 );
272 
288 extern SCP0SUBSCMPL_API int SUBSCMPL_import_declarations(
289  const char* decl_type,
290  const char* xsl_file_fmsticket,
291  const char* transfer_mode,
292  const char* option_set_name,
296  int num_input_file_fms_tickets,
298  const char** input_file_fms_tickets,
299  const char* mode,
300  int* num_output_data,
301  SUBSCMPL_import_out_t** output_data
305 );
306 
309 #ifdef __cplusplus
310 }
311 #endif
312 
313 #include <scp0subscmpl/libscp0subscmpl_undef.h>
314 
315 #endif