ITK Function Reference
(V10000.1.0.60_20160308.00)
tcfile_cache.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 TCFILE_CACHE_H
9 #define TCFILE_CACHE_H
10 
11 #include <pom/pom/pom.h>
12 #include <ss/ss_const.h>
13 #include <ss/ss_types.h>
14 #include <sa/libsa_exports.h>
15 
22 #define NO_SECURITY 0
23 #define SOCKET_MODE 1
24 
25 enum file_location_type{
26  FC_cache,
27  FC_temp,
28  FC_volume
29 };
30 
31 typedef struct IMF_file_data_s{
32  tag_t fileTag;
33  tag_t volumeTag;
34  char* pathName;
35  enum file_location_type file_loc;
36  char* osfile_name;
37  char* read_ticket;
38  logical is_transient;
39  char* orig_file_name;
40 }IMF_file_data_t;
41 
42 typedef struct IMF_file_data_s* IMF_file_data_p_t;
43 
44 #ifdef __cplusplus
45 extern "C"{
46 #endif
47 
48 extern SA_API int IMF_get_cache_size (
49  float* cache_size
50  );
51 
52 extern SA_API int IMF_update_cache_size (
53  float bytes_to_add,
54  float* cache_size
55  );
56 
57 extern SA_API void IMF_initialize_file_cache( );
58 
68 extern SA_API int IMF_get_file_access(
69  tag_t file_tag,
70  int date_offset,
71  IMF_file_data_p_t* file_data
72  );
73 
77 extern SA_API int IMF_fms_get_file_access(
78  tag_t file_tag,
79  int date_offset,
80  logical using_fms,
81  IMF_file_data_p_t* file_data
82  );
83 
88 extern SA_API int IMF_get_filename(
89  IMF_file_data_p_t file_data,
90  char** osfilename
91  );
92 
96 extern SA_API int IMF_fms_get_filename(
97  IMF_file_data_p_t file_data,
98  logical using_fms,
99  char** osfilename,
100  char** read_ticket,
101  logical* is_transient,
102  char** orig_file_name
103  );
104 
111 extern SA_API int IMF_release_file_access(
112  IMF_file_data_p_t* file_data
113  );
114 
117 #ifdef __cplusplus
118 }
119 #endif
120 
121 #include <sa/libsa_undef.h>
122 
123 #endif