GTXclient C++ API  GTXserver-18.0.4
GTXFileInfo.hpp
1 /*****************************************************************************
2 
3  Copyright (c)2007 Geovariances, Avon, France.
4 
5  In consideration of payment of the license fee, which is a part of
6  the price you paid for this product, Geovariances (GV) as licensor,
7  grants you, the licensee, a non-exclusive right to use this copy of a
8  GV software product.
9  GV reserves all rights not expressly granted to licensee. GV retains
10  titleship and ownership of software. This license is not a sale of
11  the original software or any copy. GV also retains titleship and
12  ownership of any modifications or derivations of this software. Any
13  modifications of this software must be clearly marked as such. This
14  copyright message must appear in its entirety in this software, or
15  any modifications or derivations thereof.
16 
17  Geovariances welcomes any comments, suggestions, bug reports, etc. At
18  the discretion of Geovariances, any customer supplied bug fixes,
19  enhancements, or utility codes will be distributed in future software
20  releases (the contributor will of course be credited).
21 
22  Geovariances
23  49bis, Avenue Franklin Roosevelt
24  77210 Avon, FRANCE
25 
26  Phone: +33-(0)-160.749.100
27  Fax: +33-(0)-164.228.728
28  e-mail: support@geovariances.fr
29 
30  All Rights Reserved
31 
32 *****************************************************************************/
33 
34 #ifndef __GTXFileInfo_hpp__
35 #define __GTXFileInfo_hpp__
36 
37 #define __USING_GTXSERVER_CPP_API__
38 
39 #ifdef DOXYGEN
40 #define SWIG_OR_DOXYGEN
41 #endif //DOXYGEN
42 
43 #ifdef SWIG
44 #define GLOBAL_CLASS
45 #define SWIG_OR_DOXYGEN
46 #else //SWIG
47 #include <GTXClient.h>
48 
49 class GTXFaultInfo;
50 #endif //SWIG
51 
55 class GLOBAL_CLASS GTXFileInfo
56 {
57 public:
59  GTXFileInfo();
61  GTXFileInfo(const GTXFileInfo &in_finfo);
62 
68  enum FileType
69  {
70  FILE_TYPE_ANY = -1,
75  FILE_TYPE_INVALID
76  };
77 
79  FileType GetFileType();
81  const char *GetLinkedFileName();
83  bool GetFaultedFlag();
85  bool GetPolygonFlag();
87  bool GetWireframeFlag();
89  int GetDimension();
91  gtx_long GetSampleNumber();
93  int GetItemNumber();
95  double GetGridX0();
97  double GetGridY0();
99  double GetGridZ0();
101  double GetGridDX();
103  double GetGridDY();
105  double GetGridDZ();
107  int GetGridNX();
109  int GetGridNY();
111  int GetGridNZ();
113  bool GetGridRotatedFlag();
115  double GetGridAngleAroundZ();
117  double GetGridAngleAroundY();
119  double GetGridAngleAroundX();
120 
122  const char *GetSampleNumberVariableName();
124  const char *GetLineNameVariableName();
126  const char *GetLineNumberVariableName();
128  const char *GetRelativeNumberVariableName();
130  const char *GetXCoordinateVariableName();
132  const char *GetYCoordinateVariableName();
134  const char *GetZCoordinateVariableName();
135 
137  const char *GetXCoreBeginVariableName();
139  const char *GetYCoreBeginVariableName();
141  const char *GetZCoreBeginVariableName();
143  const char *GetXCoreEndVariableName();
145  const char *GetYCoreEndVariableName();
147  const char *GetZCoreEndVariableName();
148 
150  GTXFaultInfo GetFaultInfo();
151 
152 private:
153  GTXFileInfo_C _cinfo;
154  friend class GTXClient;
155 };
156 
159 {
160 }
161 
163 inline GTXFileInfo::GTXFileInfo(const GTXFileInfo &in_finfo)
164 {
165  _cinfo = in_finfo._cinfo;
166 }
167 
169 {
170  return (GTXFileInfo::FileType)_cinfo.type;
171 }
172 
173 inline const char *GTXFileInfo::GetLinkedFileName()
174 {
175  return _cinfo.linked_file;
176 }
177 
179 {
180  return _cinfo.faulted != 0;
181 }
182 
184 {
185  return _cinfo.polygon_file != 0;
186 }
187 
189 {
190  return _cinfo.wireframe_file != 0;
191 }
192 
194 {
195  return _cinfo.dimension;
196 }
197 
199 {
200  return _cinfo.s_number;
201 }
202 
204 {
205  return _cinfo.item_number;
206 }
207 
208 inline double GTXFileInfo::GetGridX0()
209 {
210  return _cinfo.X0;
211 }
212 
213 inline double GTXFileInfo::GetGridY0()
214 {
215  return _cinfo.Y0;
216 }
217 
218 inline double GTXFileInfo::GetGridZ0()
219 {
220  return _cinfo.Z0;
221 }
222 
223 inline double GTXFileInfo::GetGridDX()
224 {
225  return _cinfo.DX;
226 }
227 
228 inline double GTXFileInfo::GetGridDY()
229 {
230  return _cinfo.DY;
231 }
232 
233 inline double GTXFileInfo::GetGridDZ()
234 {
235  return _cinfo.DZ;
236 }
237 
239 {
240  return _cinfo.NX;
241 }
242 
244 {
245  return _cinfo.NY;
246 }
247 
249 {
250  return _cinfo.NZ;
251 }
252 
254 {
255  return _cinfo.rotation != 0;
256 }
257 
259 {
260  return _cinfo.angle_z;
261 }
262 
264 {
265  return _cinfo.angle_y;
266 }
267 
269 {
270  return _cinfo.angle_x;
271 }
272 
274 {
275  return _cinfo.sn_var_name;
276 }
277 
279 {
280  return _cinfo.lname_var_name;
281 }
282 
284 {
285  return _cinfo.ln_var_name;
286 }
287 
289 {
290  return _cinfo.rn_var_name;
291 }
292 
294 {
295  return _cinfo.xg_var_name;
296 }
297 
299 {
300  return _cinfo.yg_var_name;
301 }
302 
304 {
305  return _cinfo.zg_var_name;
306 }
307 
309 {
310  return _cinfo.xb_var_name;
311 }
313 {
314  return _cinfo.yb_var_name;
315 }
317 {
318  return _cinfo.zb_var_name;
319 }
321 {
322  return _cinfo.xe_var_name;
323 }
325 {
326  return _cinfo.ye_var_name;
327 }
329 {
330  return _cinfo.ze_var_name;
331 }
332 
333 #endif // __GTXFileInfo_hpp__