ITK Function Reference
(V10000.1.0.60_20160308.00)
ssr.h
Go to the documentation of this file.
1 //Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
2 //==================================================
3 //Copyright $2010.
4 //Siemens Product Lifecycle Management Software Inc.
5 //All Rights Reserved.
6 //==================================================
7 //Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.
8 
9 /* */
10 
11 #ifndef SSR_H
12 #define SSR_H
13 
14 #include <tc/tc_startup.h>
15 
16 #include <qry/libqry_exports.h>
17 
27 /* Supported value types in reports */
28 typedef enum SSR_value_types_e {
29  SSR_UNKNOWN,
30  SSR_BOOLEAN,
31  SSR_STRING,
32  SSR_CHARACTER,
33  SSR_DATE,
34  SSR_DOUBLE,
35  SSR_INTEGER,
36  SSR_TYPEDREFERENCE,
37  SSR_UNTYPEDREFERENCE,
38  SSR_EXTERNALREFERENCE,
39  SSR_LONGSTRING,
40  SSR_TYPEDRELEATION,
41  SSR_UNTYPEDRELEATION
42 }SSR_value_types_t;
43 
44 /* Separator for property values in SSR_property_data_s.*/
45 #define VR_Split_String "{;}"
46 
47 /*********************************************/
48 /* Input Structures for custom methods.*/
49 /*********************************************/
50 
51 /* Parameter descriptors.*/
52 typedef struct parameter_descriptors_s
53 {
54  char parameter_name[80];
55  char parameter_display_name[80];
56  char parameter_default_value[240];
57  SSR_value_types_t valueType; /* enum value */
58 } parameter_descriptors_t;
59 
60 /*********************************************/
61 
62 #ifdef __cplusplus
63 extern "C"{
64 #endif
65 
66 // ITK functions
70 extern QRY_API int SSR_get_property_descriptors (
71  tag_t visual_report_tag,
72  const char* report_descriptor,
73  int *num_parameter_descriptors,
74  parameter_descriptors_t **pd
75  );
76 
81 extern QRY_API int SSR_create_visual_report_objects(
82  tag_t *ctx_tags,
83  int num_ctx_tags,
84  tag_t **visual_report_obj_tags
85  );
86 
91 extern QRY_API int SSR_create_report_property_objects(
92  tag_t visual_report_obj_tag,
93  int num_props,
94  tag_t **report_property_obj_tags
95  );
99 extern QRY_API int SSR_set_report_property_data(
100  tag_t report_property_obj_tag,
101  const char *name,
102  const char *displayName,
103  SSR_value_types_t valueType,
104  int numValues,
105  const char *values,
106  const char *relatedUID,
107  const char *source,
108  const char *propertyGroup,
109  const char *unit,
110  const char *accessURL
111  );
112 
117 extern QRY_API int SSR_create_related_objects(
118  tag_t parent_tag,
119  int num_related_objs,
120  tag_t *obj_tags,
121  tag_t **related_obj_tags
122  );
123 
128 extern QRY_API int SSR_set_related_object_data(
129  tag_t related_obj_tag,
130  const char *typeOfRelation
131  );
132 
137 extern QRY_API int SSR_create_property_objects(
138  tag_t parent_tag,
139  int num_props,
140  tag_t **property_obj_tags
141  );
142 
146 extern QRY_API int SSR_set_property_data(
147  tag_t property_obj_tag,
148  const char *name,
149  const char *displayName,
150  SSR_value_types_t valueType,
151  int numValues,
152  const char *values,
153  const char *relatedUID,
154  const char *source,
155  const char *propertyGroup,
156  const char *unit,
157  const char *accessURL
158  );
159 
166 extern QRY_API int SSR_create_external_related_objects(
167  tag_t parent_tag,
168  int num_related_objs,
169  tag_t **related_obj_tags
170  );
171 
177 extern QRY_API int SSR_set_external_related_object_data(
178  tag_t related_obj_tag,
179  const char *extObjectID,
180  const char *extObjectSource,
181  const char *extObjectName,
182  const char *extObjectType,
183  const char *extObjectaccessURL,
184  const char *typeOfRelation
185  );
186 
187 
197 extern QRY_API int SSR_log_error(
198  tag_t object_tag,
199  int severity,
200  int ifail,
201  const char* s1,
203  const char* s2,
205  const char* s3,
207  const char* s4,
209  const char* s5,
211  const char* s6,
213  const char* s7
215  );
216 
217 /* ******************************************************************************************
218 * Report Definition functions
219 * *****************************************************************************************
220 */
221 
222 /* Signature of custom function *
223 
224 int my_custom_method (METHOD_message_t *msg, va_list args)
225 {
226  (I) int numObjects
227  (I) tag_t *objects
228 
229  (I) int num_reporting_property
230  (I) parameter_descriptors_t *rpd
231 
232  (I) int num_search_parameter
233  (I) parameter_descriptors_t *spd
234 
235  (I) int num_general_parameter;
236  (I) parameter_descriptors_t *gpd;
237 
238  (I) int num_additional_parameter;
239  (I) parameter_descriptors_t *apd;
240 
241  tag_t reportDef = msg->object_tag;
242 }
243  */
244 
246 #ifdef __cplusplus
247 }
248 #endif
249 
250 #include <qry/libqry_undef.h>
251 
252 #endif