File: CigiBaseEnvRgnCtrl.h

package info (click to toggle)
cigi-ccl 3.3.3a%2Bsvn818-10
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 7,332 kB
  • sloc: cpp: 62,566; makefile: 541; ruby: 400; ansic: 313; sh: 68
file content (492 lines) | stat: -rw-r--r-- 15,494 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
/** <pre>
 *  The SDK is used to create and format CIGI compliant messages.
 *  Copyright (c) 2001-2005 The Boeing Company
 *  
 *  This library is free software; you can redistribute it and/or modify it 
 *  under the terms of the GNU Lesser General Public License as published by 
 *  the Free Software Foundation; either version 2.1 of the License, or (at 
 *  your option) any later version.
 *  
 *  This library is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
 *  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser Public License for more 
 *  details.
 *  
 *  You should have received a copy of the GNU Lesser General Public License 
 *  along with this library; if not, write to the Free Software Foundation, 
 *  Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *  
 *  FILENAME:   CigiBaseEnvRgnCtrl.h
 *  LANGUAGE:   C++
 *  CLASS:      UNCLASSIFIED
 *  PROJECT:    Common Image Generator Interface (CIGI) SDK
 *  
 *  PROGRAM DESCRIPTION: 
 *  ...
 *  
 *  MODIFICATION NOTES:
 *  DATE     NAME                                SCR NUMBER
 *  DESCRIPTION OF CHANGE........................
 *  
 *  09/17/2003 Greg Basler                       CIGI_CR_DR_1
 *  Initial Release.
 *  
 *  01/21/2005 Greg Basler                       Version 1.5
 *  Added the CIGI_SPEC modifier to the class declaration for exporting the 
 *  class in a Windows DLL.
 *  
 *  01/21/2005 Greg Basler                       Version 1.5
 *  Changed native C++ types in function declarations to CCL-defined types.
 *  
 *  06/23/2006 Greg Basler                       Version 1.7.1
 *  Changed native char and unsigned char types to CIGI types Cigi_int8 and 
 *  Cigi_uint8.
 *  
 *  11/20/2007 Greg Basler                       Version 2.0.0
 *  Added new version conversion method.
 *  Moved Packet information to base packet.
 *  
 * </pre>
 *  Author: The Boeing Company
 *
 */


#if !defined(_CIGI_BASE_ENV_RGN_CTRL_INCLUDED_)
#define _CIGI_BASE_ENV_RGN_CTRL_INCLUDED_

#include "CigiBasePacket.h"

// ====================================================================
// preprocessor definitions
// ====================================================================

#define CIGI_ENV_RGN_CTRL_PACKET_ID_V3 11
#define CIGI_ENV_RGN_CTRL_PACKET_SIZE_V3 48


class CigiEnvRgnCtrlV3;


class CIGI_SPEC CigiBaseEnvRgnCtrl : public CigiBasePacket
{

friend class CigiEnvRgnCtrlV3;

public:

   //=========================================================
   //! The enumeration for the CigiBaseEnvRgnCtrl Group
   //!
   enum RgnStateGrp
   {
      Inactive=0,
      Active=1,
      Destroyed=2
   };

   //=========================================================
   //! The enumeration for the CigiBaseEnvRgnCtrl Group
   //!
   enum MergeCtrlGrp
   {
      UseLast=0,
      Merge=1
   };




   //==> Management

   //=========================================================
   //! General Constructor
   //!
   CigiBaseEnvRgnCtrl();

   //=========================================================
   //! General Destructor
   //!
   virtual ~CigiBaseEnvRgnCtrl();


   //==> Buffer Packing/Unpacking

   //=========================================================
   //! A pure virtual Pack function.  
   //! This function is not implemented in this class.
   //! \param Base - A pointer to the instance of the packet 
   //!          to be packed. (Downcast to CigiBasePacket)
   //! \param Buff - A pointer to the current pack point.
   //! \param Spec - A pointer to special data.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   virtual int Pack(CigiBasePacket * Base, Cigi_uint8 * Buff, void *Spec) const=0;

   //=========================================================
   //! A pure virtual Unpack function.
   //! This function is not implemented in this class.
   //! \param Buff - A pointer to the current pack point.
   //! \param Swap - N/A for V1 & V2
   //! \param Spec - A pointer to special data.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   virtual int Unpack(Cigi_uint8 * Buff, bool Swap, void *Spec) =0;

   //=========================================================
   //! A virtual Conversion Information function.
   //! This function provides conversion information for this
   //!  packet.
   //! \param CnvtVersion - The CIGI version to which this packet
   //!    is being converted.
   //! \param CnvtInfo - The information needed for conversion
   //!    
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	virtual int GetCnvt(CigiVersionID &CnvtVersion,
                       CigiCnvtInfoType::Type &CnvtInfo);



   //==> Accessing Member Variable Values functions

   //+> RegionID

   //=========================================================
   //! Sets the RegionID with bound checking control
   //! \param RegionIDIn - Region ID
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetRegionID(const Cigi_uint16 RegionIDIn, bool bndchk=true)
   {
      RegionID = RegionIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the RegionID value.
   //! \return the current RegionID.
   Cigi_uint16 GetRegionID(void) const { return(RegionID); }


   //+> RgnState

   //=========================================================
   //! Sets the RgnState with bound checking control
   //! \param RgnStateIn - Region state control<br>
   //!   Inactive=0<br>
   //!   Active=1<br>
   //!   Destroyed=2<br>
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetRgnState(const RgnStateGrp RgnStateIn, bool bndchk=true);

   //=========================================================
   //! Gets the RgnState value.
   //! \return the current RgnState.
   RgnStateGrp GetRgnState(void) const { return(RgnState); }


   //+> WeatherProp

   //=========================================================
   //! Sets the WeatherProp with bound checking control
   //! \param WeatherPropIn - Weather property
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetWeatherProp(const MergeCtrlGrp WeatherPropIn, bool bndchk=true);

   //=========================================================
   //! Gets the WeatherProp value.
   //! \return the current WeatherProp.
   MergeCtrlGrp GetWeatherProp(void) const { return(WeatherProp); }


   //+> Aerosol

   //=========================================================
   //! Sets the Aerosol with bound checking control
   //! \param AerosolIn - Aerosol concentration
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetAerosol(const MergeCtrlGrp AerosolIn, bool bndchk=true);

   //=========================================================
   //! Gets the Aerosol value.
   //! \return the current Aerosol.
   MergeCtrlGrp GetAerosol(void) const { return(Aerosol); }


   //+> MaritimeSurface

   //=========================================================
   //! Sets the MaritimeSurface with bound checking control
   //! \param MaritimeSurfaceIn - Maritime surface conditions
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetMaritimeSurface(const MergeCtrlGrp MaritimeSurfaceIn, bool bndchk=true);

   //=========================================================
   //! Gets the MaritimeSurface value.
   //! \return the current MaritimeSurface.
   MergeCtrlGrp GetMaritimeSurface(void) const { return(MaritimeSurface); }


   //+> TerrestrialSurface

   //=========================================================
   //! Sets the TerrestrialSurface with bound checking control
   //! \param TerrestrialSurfaceIn - Terrestrial surface conditions
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetTerrestrialSurface(const MergeCtrlGrp TerrestrialSurfaceIn, bool bndchk=true);

   //=========================================================
   //! Gets the TerrestrialSurface value.
   //! \return the current TerrestrialSurface.
   MergeCtrlGrp GetTerrestrialSurface(void) const { return(TerrestrialSurface); }


   //+> Lat

   //=========================================================
   //! Sets the Lat with bound checking control
   //! \param LatIn - Latitude
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetLat(const double LatIn, bool bndchk=true);

   //=========================================================
   //! Gets the Lat value.
   //! \return the current Lat.
   double GetLat(void) const { return(Lat); }


   //+> Lon

   //=========================================================
   //! Sets the Lon with bound checking control
   //! \param LonIn - Longitude
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetLon(const double LonIn, bool bndchk=true);

   //=========================================================
   //! Gets the Lon value.
   //! \return the current Lon.
   double GetLon(void) const { return(Lon); }


   //+> XSize

   //=========================================================
   //! Sets the XSize with bound checking control
   //! \param XSizeIn - X size of the region
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetXSize(const float XSizeIn, bool bndchk=true)
   {
      XSize = XSizeIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the XSize value.
   //! \return the current XSize.
   float GetXSize(void) const { return(XSize); }


   //+> YSize

   //=========================================================
   //! Sets the YSize with bound checking control
   //! \param YSizeIn - Y size of the region
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetYSize(const float YSizeIn, bool bndchk=true)
   {
      YSize = YSizeIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the YSize value.
   //! \return the current YSize.
   float GetYSize(void) const { return(YSize); }


   //+> CornerRadius

   //=========================================================
   //! Sets the CornerRadius with bound checking control
   //! \param CornerRadiusIn - Corner Radius
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetCornerRadius(const float CornerRadiusIn, bool bndchk=true)
   {
      CornerRadius = CornerRadiusIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the CornerRadius value.
   //! \return the current CornerRadius.
   float GetCornerRadius(void) const { return(CornerRadius); }


   //+> Rotation

   //=========================================================
   //! Sets the Rotation with bound checking control
   //! \param RotationIn - The rotation of the region from true north
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetRotation(const float RotationIn, bool bndchk=true);

   //=========================================================
   //! Gets the Rotation value.
   //! \return the current Rotation.
   float GetRotation(void) const { return(Rotation); }


   //+> Transition

   //=========================================================
   //! Sets the Transition with bound checking control
   //! \param TransitionIn - Width of the trasition band
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetTransition(const float TransitionIn, bool bndchk=true)
   {
      Transition = TransitionIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Gets the Transition value.
   //! \return the current Transition.
   float GetTransition(void) const { return(Transition); }



protected:

   //==> Member variables

   //=========================================================
   //! RegionID<br>
   //! Region ID
   //!
   Cigi_uint16 RegionID;

   //=========================================================
   //! RgnState<br>
   //! Region state control<br>
   //!  0-Inactive<br>
   //!  1-Active<br>
   //!  2-Destroyed
   //!
   RgnStateGrp RgnState;

   //=========================================================
   //! WeatherProp<br>
   //! Weather property merge control
   //!
   MergeCtrlGrp WeatherProp;

   //=========================================================
   //! Aerosol<br>
   //! Aerosol Concentration merge control
   //!
   MergeCtrlGrp Aerosol;

   //=========================================================
   //! MaritimeSurface<br>
   //! Maritime surface conditions merge control
   //!
   MergeCtrlGrp MaritimeSurface;

   //=========================================================
   //! TerrestrialSurface<br>
   //! Terrestrial surface conditions merge control
   //!
   MergeCtrlGrp TerrestrialSurface;

   //=========================================================
   //! Lat<br>
   //! Latitude
   //!
   double Lat;

   //=========================================================
   //! Lon<br>
   //! Longitude
   //!
   double Lon;

   //=========================================================
   //! XSize<br>
   //! X size of the region
   //!
   float XSize;

   //=========================================================
   //! YSize<br>
   //! Y size of the region
   //!
   float YSize;

   //=========================================================
   //! CornerRadius<br>
   //! Radius of the corners
   //!
   float CornerRadius;

   //=========================================================
   //! Rotation<br>
   //! Rotation of the region from true north
   //!
   float Rotation;

   //=========================================================
   //! Transition<br>
   //! Width of the transition band.
   //!
   float Transition;


};

#endif // #if !defined(_CIGI_BASE_ENV_RGN_CTRL_INCLUDED_)