ITK Function Reference
(V10000.1.0.60_20160308.00)
cmp.h
Go to the documentation of this file.
1 /*==============================================================================
2  Copyright (c) 2003-2005 UGS Corporation
3  Unpublished - All Rights Reserved
4  ==============================================================================*/
5 
6 /* */
7 
8 #ifndef CMP_H
9 #define CMP_H
10 
11 #include <fclasses/cmp_errors.h>
12 #include <fclasses/cmp_tokens.h>
13 #include <fclasses/tc_basic.h>
14 #include <fclasses/libfclasses_exports.h>
15 
16 #ifdef __cplusplus
17  extern "C" {
18 #endif
19 
25 extern FCLASSES_API const char* const CMP_std_descriptor_P_id_seq_A_rev_qty_name;
26 extern FCLASSES_API const char* const CMP_std_descriptor_P_id_A_rev_qty_name;
27 extern FCLASSES_API const char* const CMP_std_descriptor_appr_compare_name;
28 extern FCLASSES_API const char * const CMP_std_descriptor_LBOM_compare_name;
29 extern FCLASSES_API const char * const CMP_std_descriptor_LBOM_withocc_compare_name;
30 /* END OF HEADER */
31 
35 extern FCLASSES_API int CMP_create (
36  tag_t compare_desc,
37  tag_t* engine
38  );
39 
43 extern FCLASSES_API int CMP_find_desc (
44  const char* name,
45  tag_t* compare_desc
46  );
47 
53 extern FCLASSES_API int CMP_set_app_data (
54  tag_t engine,
55  void* app_data
56  );
57 
61 extern FCLASSES_API int CMP_cull_compare_sets (
62  tag_t engine
63  );
64 
68 extern FCLASSES_API int CMP_cull_compare_set (
69  tag_t set
70  );
71 
75 extern FCLASSES_API int CMP_ask_sets (
76  tag_t engine,
77  int* n,
78  tag_t** sets
79  );
80 
84 extern FCLASSES_API int CMP_ask_diff_sets (
85  tag_t engine,
86  int* n,
87  tag_t** diff_sets
88  );
89 
93 extern FCLASSES_API int CMP_ask_diff (
94  tag_t set,
95  logical* is_added,
97  int* added_to_side,
99  logical* is_changed
101  );
102 
106 extern FCLASSES_API int CMP_ask_diff_elements (
107  tag_t set,
108  int* n,
109  tag_t** elements
110  );
111 
115 extern FCLASSES_API int CMP_ask_element_value (
116  tag_t set,
117  int side,
118  tag_t element,
119  char** value
120  );
121 
130 extern FCLASSES_API int CMP_ask_element_value_char(
131  tag_t set,
132  int side,
133  tag_t element,
134  char* value
135  );
136 
145 extern FCLASSES_API int CMP_ask_element_value_date(
146  tag_t set,
147  int side,
148  tag_t element,
149  date_t* value
150  );
151 
160 extern FCLASSES_API int CMP_ask_element_value_double(
161  tag_t set,
162  int side,
163  tag_t element,
164  double* value
165  );
166 
175 extern FCLASSES_API int CMP_ask_element_value_int(
176  tag_t set,
177  int side,
178  tag_t element,
179  int* value
180  );
181 
190 extern FCLASSES_API int CMP_ask_element_value_logical(
191  tag_t set,
192  int side,
193  tag_t element,
194  logical* value
195  );
196 
207 extern FCLASSES_API int CMP_ask_element_value_string(
208  tag_t set,
209  int side,
210  tag_t element,
211  char** value
212  );
213 
222 extern FCLASSES_API int CMP_ask_element_value_tag(
223  tag_t set,
224  int side,
225  tag_t element,
226  tag_t* value
227  );
228 
237 extern FCLASSES_API int CMP_ask_element_value_char_array (
238  tag_t set,
239  int side,
240  tag_t element,
241  int* n,
242  char** value
243  );
244 
253 extern FCLASSES_API int CMP_ask_element_value_date_array (
254  tag_t set,
255  int side,
256  tag_t element,
257  int* n,
258  date_t** value
259  );
260 
269 extern FCLASSES_API int CMP_ask_element_value_tag_array (
270  tag_t set,
271  int side,
272  tag_t element,
273  int* n,
274  tag_t** value
275  );
276 
285 extern FCLASSES_API int CMP_ask_element_value_string_array (
286  tag_t set,
287  int side,
288  tag_t element,
289  int* n,
290  char*** value
291  );
292 
296 extern FCLASSES_API int CMP_ask_objects_in_set (
297  tag_t set,
298  int side,
299  int* n,
300  tag_t** objects
301  );
302 
306 extern FCLASSES_API int CMP_create_desc (
307  const char* name,
308  tag_t* desc
309  );
310 
314 extern FCLASSES_API int CMP_create_element (
315  tag_t desc,
316  int priority,
317  int cache_type,
318  const char* name,
319  logical suppress_value,
321  tag_t* element
322  );
323 
327 extern FCLASSES_API int CMP_create_prop_element (
328  tag_t desc,
329  int priority,
330  int cache_type,
333  const char* name,
335  logical suppress_value,
337  tag_t type_tag,
338  const char* prop_name,
339  const char* disp_prop_name,
342  tag_t* element
343  );
344 
355 extern FCLASSES_API int CMP_set_element_display_order (
356  tag_t desc,
357  int n,
358  tag_t* elements
359  );
360 
378 extern FCLASSES_API int CMP_set_aggregate_type (
379  tag_t prop_element,
380  int aggregate_type
381  );
382 
383 extern FCLASSES_API int CMP_set_prop_element_order (
384  tag_t prop_element,
385  int order
386  );
387 
392 extern FCLASSES_API int CMP_set_element_application_flag (
393  tag_t element,
394  int app_flag,
395  logical value
396  );
397 
398 
412 extern FCLASSES_API int CMP_register_compare_obj_method (
413  tag_t element,
414  CMP_compare_obj_method_t* method
415  );
416 
420 extern FCLASSES_API int CMP_register_compare_agg_method (
421  tag_t element,
422  CMP_compare_agg_method_t* method
423  );
424 
428 extern FCLASSES_API int CMP_register_update_cache_method (
429  tag_t element,
430  CMP_update_cache_method_t* method
431  );
432 
437 extern FCLASSES_API int CMP_register_uif_name_method (
438  tag_t element,
439  CMP_uif_name_method_t* method
440  );
441 
445 extern FCLASSES_API int CMP_register_uif_value_method (
446  tag_t element,
447  CMP_uif_value_method_t* method
448  );
449 
454 extern FCLASSES_API int CMP_register_free_cache_method (
455  tag_t element,
456  CMP_free_cache_method_t* method
457  );
458 
462 extern FCLASSES_API int CMP_ask_elements (
463  tag_t desc,
464  int* n,
465  tag_t** elements
466  );
467 
474 extern FCLASSES_API int CMP_ask_ordered_elements (
475  tag_t desc,
476  int* n,
477  tag_t** elements
478  );
479 
483 extern FCLASSES_API int CMP_ask_element_info (
484  tag_t element,
485  int* element_type,
487  int* priority,
488  int* cache_type,
489  char** uif_name,
490  logical* suppress_value
492  );
493 
502 extern FCLASSES_API int CMP_ask_prop_element_info (
503  tag_t prop_element,
504  int* aggregate_type,
505  char** prop_name,
506  char** disp_prop_name
509  );
510 
511 extern FCLASSES_API int CMP_ask_prop_element_order (
512  tag_t prop_element,
513  int* order
514  );
515 
519 extern FCLASSES_API int CMP_ask_element_methods (
520  tag_t element,
521  CMP_compare_obj_method_t** obj_method,
522  CMP_compare_agg_method_t** agg_method,
523  CMP_update_cache_method_t** cache_method,
525  CMP_uif_name_method_t** name_method,
526  CMP_uif_value_method_t** value_method,
527  CMP_free_cache_method_t** free_method
528  );
529 
530 
535 extern FCLASSES_API int CMP_ask_element_application_flag (
536  tag_t element,
537  int app_flag,
538  logical * value
539 );
540 
541 
545 extern FCLASSES_API int CMP_ask_engine_of_set (
546  tag_t set,
547  tag_t* engine
548  );
549 
555 extern FCLASSES_API int CMP_ask_app_data (
556  tag_t engine,
557  void** app_data
558  );
559 
564 extern FCLASSES_API int CMP_ask_data_cache (
565  tag_t set,
566  tag_t element,
567  int side,
568  int* cache_type,
570  tag_t* cache
571  );
572 
577 extern FCLASSES_API int CMP_ask_cached_char (
578  tag_t cache,
579  char* value
580  );
581 
586 extern FCLASSES_API int CMP_ask_cached_date (
587  tag_t cache,
588  date_t* value
589  );
590 
595 extern FCLASSES_API int CMP_ask_cached_double (
596  tag_t cache,
597  double* value
598  );
599 
604 extern FCLASSES_API int CMP_ask_cached_int (
605  tag_t cache,
606  int* value
607  );
608 
613 extern FCLASSES_API int CMP_ask_cached_logical (
614  tag_t cache,
615  logical* value
616  );
617 
622 extern FCLASSES_API int CMP_ask_cached_tag (
623  tag_t cache,
624  tag_t* value
625  );
626 
631 extern FCLASSES_API int CMP_ask_cached_pointer (
632  tag_t cache,
633  void** value
634  );
635 
640 extern FCLASSES_API int CMP_ask_cached_string (
641  tag_t cache,
642  char** value
643  );
644 
649 extern FCLASSES_API int CMP_ask_cached_char_array (
650  tag_t cache,
651  int* n,
652  char** value
653  );
654 
659 extern FCLASSES_API int CMP_ask_cached_date_array (
660  tag_t cache,
661  int* n,
662  date_t** value
663  );
664 
669 extern FCLASSES_API int CMP_ask_cached_tag_array (
670  tag_t cache,
671  int* n,
672  tag_t** value
673  );
674 
679 extern FCLASSES_API int CMP_ask_cached_string_array (
680  tag_t cache,
681  int* n,
682  char*** value
683  );
684 
689 extern FCLASSES_API int CMP_set_cached_char (
690  tag_t cache,
691  char value
692  );
693 
698 extern FCLASSES_API int CMP_set_cached_date (
699  tag_t cache,
700  date_t value
701  );
702 
707 extern FCLASSES_API int CMP_set_cached_double (
708  tag_t cache,
709  double value
710  );
711 
716 extern FCLASSES_API int CMP_set_cached_int (
717  tag_t cache,
718  int value
719  );
720 
725 extern FCLASSES_API int CMP_set_cached_logical (
726  tag_t cache,
727  logical value
728  );
729 
734 extern FCLASSES_API int CMP_set_cached_string (
735  tag_t cache,
736  char* value
737  );
738 
743 extern FCLASSES_API int CMP_set_cached_tag (
744  tag_t cache,
745  tag_t value
746  );
747 
752 extern FCLASSES_API int CMP_set_cached_pointer (
753  tag_t cache,
754  void* value
755  );
756 
761 extern FCLASSES_API int CMP_set_cached_char_array (
762  tag_t cache,
763  int n,
764  char* value
765  );
766 
771 extern FCLASSES_API int CMP_set_cached_date_array (
772  tag_t cache,
773  int n,
774  date_t* value
775  );
776 
781 extern FCLASSES_API int CMP_set_cached_tag_array (
782  tag_t cache,
783  int n,
784  tag_t* value
785  );
786 
791 extern FCLASSES_API int CMP_set_cached_string_array (
792  tag_t cache,
793  int n,
794  char** value
795  );
796 
806 extern FCLASSES_API int CMP_add_cached_char (
807  tag_t cache,
808  char value
809  );
810 
820 extern FCLASSES_API int CMP_add_cached_date (
821  tag_t cache,
822  date_t value
823  );
824 
834 extern FCLASSES_API int CMP_add_cached_double (
835  tag_t cache,
836  double value
837  );
838 
848 extern FCLASSES_API int CMP_add_cached_int (
849  tag_t cache,
850  int value
851  );
852 
862 extern FCLASSES_API int CMP_add_cached_logical (
863  tag_t cache,
864  logical value
865  );
866 
876 extern FCLASSES_API int CMP_add_cached_string (
877  tag_t cache,
878  char* value
879  );
880 
890 extern FCLASSES_API int CMP_add_cached_tag (
891  tag_t cache,
892  tag_t value
893  );
894 
902 /*================================================================================================*/
903 
904 #ifdef __cplusplus
905  }
906 #endif
907 
908 #include <fclasses/libfclasses_undef.h>
909 #endif