ITK Function Reference
(V10000.1.0.60_20160308.00)
lov.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 LOV_H
9 #define LOV_H
10 
11 #include <pom/pom/pom_tokens.h>
12 #include <unidefs.h>
13 #include <property/prop.h>
14 #include <property/propdesc.h>
15 #include <tccore/tc_msg.h>
16 #include <lov/liblov_exports.h>
17 
41 #define LOV_root_class_name_c "ListOfValues"
42 #define LOV_integer_class_name_c "ListOfValuesInteger"
43 #define LOV_double_class_name_c "ListOfValuesDouble"
44 #define LOV_char_class_name_c "ListOfValuesChar"
45 #define LOV_string_class_name_c "ListOfValuesString"
46 #define LOV_date_class_name_c "ListOfValuesDate"
47 #define LOV_tag_class_name_c "ListOfValuesTag"
48 #define LOV_filter_class_name_c "ListOfValuesFilter"
49 #define LOV_dynamic_class_name_c "Fnd0ListOfValuesDynamic"
50 
51 #define LOV_name_size_c 32
52 #define LOV_desc_size_c 240
53 #define LOV_type_size_c 32
54 #define LOV_value_desc_size_c 256
55 #define LOV_classification_name_size_c 32
56 
57 #define LOV_integer_c PROP_int
58 #define LOV_double_c PROP_double
59 #define LOV_char_c PROP_char
60 #define LOV_string_c PROP_string
61 #define LOV_date_c PROP_date
62 #define LOV_tag_c PROP_untyped_reference
63 
67 typedef enum LOV_usage_e
68 {
69  LOV_Unknown,
70  LOV_Exhaustive_list,
71  LOV_Suggestions,
72  LOV_Ranges,
73  LOV_Upper_bound
74 } LOV_usage_t;
75 
79 typedef enum LOV_attached_type_e
80 {
81  LOV_Unused,
82  LOV_Attribute,
83  LOV_Property
84 } LOV_attached_type_t;
85 
86 #ifdef __cplusplus
87  extern "C"{
88 #endif
89 
93 extern LOV_API int LOV_extent(
94  int* n_lovs,
95  tag_t** lov
96  );
97 
101 extern LOV_API int LOV_find(
102  const char* lov_name,
103  int* n_lovs,
104  tag_t** lov
105  );
106 
111 extern LOV_API int LOV_find_attached_prop(
112  const char* type_name,
113  const char* prop_name,
114  tag_t* lov
115  );
116 
123 extern LOV_API int LOV_ask_name(
124  tag_t lov,
125  char lov_name[LOV_name_size_c + 1]
126  );
127 
128 
132 extern LOV_API int LOV_ask_name2(
133  tag_t lov,
134  char **lov_name
135  );
136 
143 extern LOV_API int LOV_ask_description(
144  tag_t lov,
145  char lov_desc[LOV_desc_size_c + 1]
146  );
147 
148 
152 extern LOV_API int LOV_ask_description2(
153  tag_t lov,
154  char **lov_desc
155  );
156 
163 extern LOV_API int LOV_ask_type(
164  tag_t lov,
165  char lov_type[LOV_type_size_c + 1]
166  );
167 
171 extern LOV_API int LOV_ask_type2(
172  tag_t lov,
173  char **lov_type
174  );
175 
179 extern LOV_API int LOV_ask_usage(
180  tag_t lov_tag,
181  LOV_usage_t* usage
185  );
186 
190 extern LOV_API int LOV_ask_value_type(
191  tag_t lov_tag,
192  PROP_value_type_t* value_type
207  );
208 
212 extern LOV_API int LOV_ask_num_of_values(
213  tag_t lov,
214  int* length
215  );
216 
225 extern LOV_API int LOV_is_value_valid_int(
226  tag_t lov,
227  int value,
228  logical* answer
229  );
230 
234 extern LOV_API int LOV_ask_range_lower_int(
235  tag_t lov,
236  int* value,
237  logical* is_it_null,
238  logical* is_it_empty
239  );
240 
244 extern LOV_API int LOV_ask_range_upper_int(
245  tag_t lov,
246  int* value,
247  logical* is_it_null,
248  logical* is_it_empty
249  );
250 
254 extern LOV_API int LOV_ask_values_int(
255  tag_t lov,
256  int* n_values,
257  int** values
258  );
259 
267 extern LOV_API int LOV_ask_lov_int(
268  tag_t lov,
269  LOV_usage_t* lov_usage,
270  int* n_values,
271  int** values,
272  logical** is_null,
273  logical** is_empty
274  );
275 
276 extern LOV_API int LOV_ask_lov_int_without_evaluation(
277  tag_t lov,
278  LOV_usage_t* lov_usage,
279  int* n_values,
280  int** values,
281  logical** is_null,
282  logical** is_empty
283  );
284 
292 extern LOV_API int LOV_ask_disp_values_int(
293  tag_t lov,
294  LOV_usage_t lov_usage,
295  int n_values,
296  const int* values,
297  const logical* is_null,
298  const logical* is_empty,
299  char*** disp_values
300  );
301 
312 extern LOV_API int LOV_is_value_valid_double(
313  tag_t lov,
314  double value,
315  logical* answer
316  );
317 
321 extern LOV_API int LOV_ask_range_lower_double(
322  tag_t lov,
323  double* value,
324  logical* is_it_null,
325  logical* is_it_empty
326  );
327 
331 extern LOV_API int LOV_ask_range_upper_double(
332  tag_t lov,
333  double* value,
334  logical* is_it_null,
335  logical* is_it_empty
336  );
337 
341 extern LOV_API int LOV_ask_values_double(
342  tag_t lov,
343  int* n_values,
344  double** values
345  );
346 
350 extern LOV_API int LOV_ask_values_double_without_evaluation(
351  tag_t lov,
352  int* n_values,
353  double** values
354  );
355 
356 
364 extern LOV_API int LOV_ask_lov_double(
365  tag_t lov,
366  LOV_usage_t* lov_usage,
367  int* n_values,
368  double** values,
369  logical** is_null,
370  logical** is_empty
371  );
372 
373 extern LOV_API int LOV_ask_lov_double_without_evaluation(
374  tag_t lov,
375  LOV_usage_t* lov_usage,
376  int* n_values,
377  double** values,
378  logical** is_null,
379  logical** is_empty
380  );
381 
389 extern LOV_API int LOV_ask_disp_values_double(
390  tag_t lov,
391  LOV_usage_t lov_usage,
392  int n_values,
393  const double* values,
394  const logical* is_null,
395  const logical* is_empty,
396  char*** disp_values
397  );
398 
409 extern LOV_API int LOV_is_value_valid_char(
410  tag_t lov,
411  char value,
412  logical* answer
413  );
414 
418 extern LOV_API int LOV_ask_range_lower_char(
419  tag_t lov,
420  char* value,
421  logical* is_it_null,
422  logical* is_it_empty
423  );
424 
428 extern LOV_API int LOV_ask_range_upper_char(
429  tag_t lov,
430  char* value,
431  logical* is_it_null,
432  logical* is_it_empty
433  );
434 
438 extern LOV_API int LOV_ask_values_char(
439  tag_t lov,
440  int* n_values,
441  char** values
442  );
443 
448 extern LOV_API int LOV_ask_values_char_without_evaluation(
449  tag_t lov,
450  int* n_values,
451  char** values
452  );
453 
454 
462 extern LOV_API int LOV_ask_lov_char(
463  tag_t lov,
464  LOV_usage_t* lov_usage,
465  int* n_values,
466  char** values,
467  logical** is_null,
468  logical** is_empty
469  );
470 
471 extern LOV_API int LOV_ask_lov_char_without_evaluation(
472  tag_t lov,
473  LOV_usage_t* lov_usage,
474  int* n_values,
475  char** values,
476  logical** is_null,
477  logical** is_empty
478  );
479 
487 extern LOV_API int LOV_ask_disp_values_char(
488  tag_t lov,
489  LOV_usage_t lov_usage,
490  int n_values,
491  const char* values,
492  const logical* is_null,
493  const logical* is_empty,
494  char*** disp_values
495  );
496 
507 extern LOV_API int LOV_is_value_valid_string(
508  tag_t lov,
509  const char* value,
510  logical* answer
511  );
512 
516 extern LOV_API int LOV_ask_range_lower_string(
517  tag_t lov,
518  char** value,
519  logical* is_it_null,
520  logical* is_it_empty
521  );
522 
526 extern LOV_API int LOV_ask_range_upper_string(
527  tag_t lov,
528  char** value,
529  logical* is_it_null,
530  logical* is_it_empty
531  );
532 
536 extern LOV_API int LOV_ask_values_string(
537  tag_t lov,
538  int* n_values,
539  char*** values
540  );
541 
542 
546 extern LOV_API int LOV_ask_values_string_without_evaluation(
547  tag_t lov,
548  int* n_values,
549  char*** values
550  );
551 
555 extern LOV_API int LOV_ask_values_int_without_evaluation(
556  tag_t lov_tag,
557  int* n_values,
558  int** values
559  );
560 
568 extern LOV_API int LOV_ask_lov_string(
569  tag_t lov,
570  LOV_usage_t* lov_usage,
571  int* n_values,
572  char*** values,
573  logical** is_null,
574  logical** is_empty
575  );
576 
577 extern LOV_API int LOV_ask_lov_string_without_evaluation(
578  tag_t lov,
579  LOV_usage_t* lov_usage,
580  int* n_values,
581  char*** values,
582  logical** is_null,
583  logical** is_empty
584  );
585 
589 extern LOV_API int LOV_ask_values_display_string(
590  tag_t lov,
591  LOV_usage_t* lov_usage,
592  int* n_values,
593  char*** display_values,
594  char*** values
595  );
596 
604 extern LOV_API int LOV_ask_disp_values_string(
605  tag_t lov,
606  LOV_usage_t lov_usage,
607  int n_values,
608  const char** values,
609  const logical* is_null,
610  const logical* is_empty,
611  char*** disp_values
612  );
613 
624 extern LOV_API int LOV_is_value_valid_date(
625  tag_t lov,
626  date_t value,
627  logical* answer
628  );
629 
633 extern LOV_API int LOV_ask_range_lower_date(
634  tag_t lov,
635  date_t* value,
636  logical* is_it_null,
637  logical* is_it_empty
638  );
639 
643 extern LOV_API int LOV_ask_range_upper_date(
644  tag_t lov,
645  date_t* value,
646  logical* is_it_null,
647  logical* is_it_empty
648  );
649 
653 extern LOV_API int LOV_ask_values_date(
654  tag_t lov,
655  int* n_values,
656  date_t** values
657  );
658 
662 extern LOV_API int LOV_ask_values_date_without_evaluation(
663  tag_t lov,
664  int* n_values,
665  date_t** values
666  );
667 
675 extern LOV_API int LOV_ask_lov_date(
676  tag_t lov,
677  LOV_usage_t* lov_usage,
678  int* n_values,
679  date_t** values,
680  logical** is_null,
681  logical** is_empty
682  );
683 
684 extern LOV_API int LOV_ask_lov_date_without_evaluation(
685  tag_t lov,
686  LOV_usage_t* lov_usage,
687  int* n_values,
688  date_t** values,
689  logical** is_null,
690  logical** is_empty
691  );
692 
700 extern LOV_API int LOV_ask_disp_values_date(
701  tag_t lov,
702  LOV_usage_t lov_usage,
703  int n_values,
704  const date_t* values,
705  const logical* is_null,
706  const logical* is_empty,
707  char*** disp_values
708  );
709 
720 extern LOV_API int LOV_is_value_valid_tag(
721  tag_t lov,
722  tag_t value,
723  logical* answer
724  );
725 
729 extern LOV_API int LOV_ask_values_tag(
730  tag_t lov,
731  int* n_values,
732  tag_t** values
733  );
734 
742 extern LOV_API int LOV_ask_lov_tag(
743  tag_t lov,
744  LOV_usage_t* lov_usage,
745  int* n_values,
746  tag_t** values,
747  logical** is_null,
748  logical** is_empty
749  );
750 
758 extern LOV_API int LOV_ask_reference(
759  tag_t lov,
760  char** class_name,
761  char** attr_name
762  );
763 
767 extern LOV_API int LOV_ask_values_display_tag(
768  tag_t lov,
769  LOV_usage_t* lov_usage,
770  int* n_values,
771  char*** display_values,
772  tag_t** values
773  );
774 
782 extern LOV_API int LOV_ask_disp_values_tag(
783  tag_t lov,
784  LOV_usage_t lov_usage,
785  int n_values,
786  const tag_t* values,
787  const logical* is_null,
788  const logical* is_empty,
789  char*** disp_values
790  );
791 
796 extern LOV_API int LOV_ask_disp_values(
797  tag_t lov_tag,
798  LOV_usage_t* usage,
799  int* n_values,
800  logical** is_null,
801  logical** is_empty,
802  char*** value_strings
803  );
804 
805 extern LOV_API int LOV_ask_disp_values_without_evaluation(
806  tag_t lov_tag,
807  LOV_usage_t* usage,
808  int* n_values,
809  logical** is_null,
810  logical** is_empty,
811  char*** value_strings
812  );
813 
817 extern LOV_API int LOV_ask_attached_properties(
818  tag_t lov_tag,
819  int* n_attach,
820  char*** type_names,
821  char*** prop_names
822  );
823 
824 
831 extern LOV_API int LOV_ask_value_descriptions(
832  tag_t lov_tag,
833  LOV_usage_t* usage,
834  int* n_values,
835  char*** desc_strings,
836  logical** is_null,
837  logical** is_empty
838 );
839 
843 extern LOV_API int LOV_ask_value_filters(
844  tag_t lov_tag,
845  int* n_list_of_filters,
846  int** list_of_filter_indices,
847  tag_t** list_of_filters
848 );
849 
853 extern LOV_API int LOV_ask_based_on_lov_shown_indexes(
854  tag_t lov_tag,
855  tag_t* based_on_lov,
856  logical* all_shown,
858  int* n_shown_indices,
859  int** shown_indices
860  );
861 
862 extern LOV_API int LOV_ask_attached_properties_info(
863  tag_t lov_tag,
864  int* n_attach,
865  char*** type_names,
867  char*** prop_names,
868  int** orders,
869  int** n_parents,
870  logical** desc_attach
871 );
872 
873 extern LOV_API int LOV_ask_attached_properties_info_with_conditions(
874  tag_t lov_tag,
875  int* n_attach,
876  char*** type_names,
878  char*** prop_names,
879  int** orders,
880  int** n_parents,
881  logical** desc_attach,
882  tag_t** conditions,
883  logical** overrides
885 );
886 
890 extern LOV_API int LOV_ask_attached_dependency_orders(
891  tag_t lov_tag,
892  int* n_attached,
893  int** orders
894 );
895 
899 extern LOV_API int LOV_ask_attached_description_logicals(
900  tag_t lov_tag,
901  int* n_attached,
902  logical** desc_attach
903 );
904 
908 extern LOV_API int LOV_ask_attached_parent_numbers(
909  tag_t lov_tag,
910  int* n_attached,
911  int** n_parents
912 );
913 
918 extern LOV_API int LOV_ask_attached_dependency_order(
919  const char* type_name,
920  const char* prop_name,
921  int* order
922  );
923 
928 extern LOV_API int LOV_ask_attached_description_logical(
929  const char* type_name,
930  const char* prop_name,
931  logical* descAttach
932  );
933 
938 extern LOV_API int LOV_ask_attached_parent_number(
939  const char* type_name,
940  const char* prop_name,
941  int* n_parent
942  );
943 
944 
949 extern LOV_API int LOV_ask_value_classifications(
950  tag_t lov_tag,
951  int* n_classifications,
952  char*** classifications
953 );
954 
958 extern LOV_API int LOV_ask_disp_value_descriptions(
959  tag_t lov_tag,
960  int* n_desc_strings,
961  char*** desc_strings,
962  logical** is_null,
963  logical** is_empty
964 );
965 
974 extern LOV_API int LOV_ask_values_from_disp_values_string(
975  tag_t pd_tag,
976  int n_values,
977  const char** disp_values,
978  int* n_internal_values,
979  char*** internal_values
980 );
981 
987 extern LOV_API int LOV_ask_column_names(
988  tag_t lov_tag,
989  tag_t *lov_value_prop_desc_tag,
990  tag_t *lov_descr_prop_desc_tag,
991  int *num_filter_props,
992  tag_t *filter_prop_desc_tags[]
993 );
994 
1000 extern LOV_API int LOV_execute_dynamic_lov(
1001  const tag_t lov_tag,
1002  const tag_t object_tag,
1003  const char *prop_name,
1004  const char *filter_string,
1005  const int max_results,
1006  const char *sort_property_name,
1007  const int order,
1008  int *num_results,
1009  tag_t **results
1010  );
1011 
1014 #ifdef __cplusplus
1015 }
1016 #endif
1017 
1018 #include <lov/liblov_undef.h>
1019 
1020 #endif