This file is indexed.

/usr/include/cigicl/CigiOutgoingMsg.h is in libcigicl-dev 3.3.3a+svn818-10ubuntu2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
/** <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:   CigiOutgoingMsg.h
 *  LANGUAGE:   C++
 *  CLASS:      UNCLASSIFIED
 *  PROJECT:    Common Image Generator Interface (CIGI) SDK
 *  
 *  PROGRAM DESCRIPTION: 
 *  ...
 *  
 *  MODIFICATION NOTES:
 *  DATE     NAME                                SCR NUMBER
 *  DESCRIPTION OF CHANGE........................
 *  
 *  09/15/2003 James Durtschy                    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.
 *  
 *  02/20/2006 Greg Basler                       Version 1.6.0
 *  Added the PackageMsg, GetCurrentlyPackagedMsg, and FreeMsg methods to
 *  better update the frame the frame counter in the IG_Ctrl packet for hosts
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Granted friend access to the CigiVersionJumpTable class.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Added an overloaded UpdateSOF method without the LastIGCtrl parameter to 
 *  update the the start of frame packet's frame counter.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Deprecated the existing UpdateSOF method and modified it to call the new 
 *  implementation.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Added a protected Reset method to reset the buffer system.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Added the CurrentIGCtrl member variable to store the last IGCtrl packed 
 *  into a message.
 *  
 *  04/14/2006 Greg Basler                       Version 1.7.0
 *  Added the CurrentSOF member variable to store the last SOF packed into a 
 *  message.
 *  
 *  06/23/2006 Greg Basler                       Version 1.7.1
 *  Changed native char and unsigned char types to CIGI types Cigi_int8 and 
 *  Cigi_uint8.
 * </pre>
 *  Author: The Boeing Company
 *
 */

#if !defined(_CIGI_OUTGOING_MESSAGE_INCLUDED_)
#define _CIGI_OUTGOING_MESSAGE_INCLUDED_

#include <string>
#include <list>

#include "CigiMessage.h"
#include "CigiBasePacket.h"
#include "CigiBaseEntityCtrl.h"
#include "CigiBaseIGCtrl.h"
#include "CigiBaseSOF.h"
#include "CigiMessageBuffer.h"
#include "CigiBaseVariableSizePckt.h"
#include "CigiDefaultPacket.h"

class CigiSession;

//=========================================================
//! The class for the outgoing message
//!
class CIGI_SPEC CigiOutgoingMsg : public CigiMessage  
{

   friend class CigiSession;

public:
   //==> Management

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

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





   //==> Buffer Packing Operators with References

   //=========================================================
   //! Packs the buffer with the specifed IG Control packet.  
   //! \param refPacket - A reference to an IG Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseIGCtrl &refPacket);

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A reference to an IG Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   inline CigiOutgoingMsg & pack(CigiBaseIGCtrl &refPacket)
   {
     return (*this) << refPacket;
   }

   //=========================================================
   //! Packs the buffer with the specifed Start Of Frame packet.  
   //! \param refPacket - A reference to an Start Of Frame packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseSOF &refPacket);

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A reference to an Start Of Frame packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseSOF &refPacket)
   {
     return (*this) << refPacket;
   }

   //=========================================================
   //! Packs the buffer with the specifed Entity Control packet.  
   //! \param refPacket - A reference to an Entity Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseEntityCtrl &refPacket);

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A reference to an Entity Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseEntityCtrl &refPacket)
   {
     return (*this) << refPacket;
   }

   //=========================================================
   //! Packs the buffer with the specifed packet.  
   //! \param refPacket - A reference to an Enviroment type
   //!    Control packet.  This includes Celestial and Atmosphere Ctrl
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseEnvCtrl &refPacket);

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A reference to an Enviroment type
   //!    Control packet.  This includes Celestial and Atmosphere Ctrl
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseEnvCtrl &refPacket)
   {
     return (*this) << refPacket;
   }

   //=========================================================
   //! Packs the buffer with the specifed packet.  
   //! \param refPacket - A reference to a variable size packet
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseVariableSizePckt &refPacket);

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A reference to a variable size packet
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseVariableSizePckt &refPacket)
   {
     return (*this) << refPacket;
   }

   //=========================================================
   //! Packs the buffer with the pointer to the specifed packet.  
   //! \param refBasePacket - A reference to a base packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBasePacket &refBasePacket);

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refBasePacket - A reference to a base packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBasePacket &refBasePacket)
   {
     return (*this) << refBasePacket;
   }


   //==> Buffer Packing Operators with Pointers

   //=========================================================
   //! Packs the buffer with the pointer to the specifed IG Control packet.  
   //! \param refPacket - A pointer to an IG Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseIGCtrl *refPacket)
   {
      return(operator<<(*refPacket));
   }

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A pointer to an IG Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseIGCtrl *refPacket)
   {
     return this->pack(*refPacket);
   }

   //=========================================================
   //! Packs the buffer with the pointer to the specifed Start Of Frame packet.  
   //! \param refPacket - A pointer to an Start Of Frame packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseSOF *refPacket)
   {
      return(operator<<(*refPacket));
   }

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A pointer to an Start Of Frame packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseSOF *refPacket)
   {
     return this->pack(*refPacket);
   }

   //=========================================================
   //! Packs the buffer with the pointer to the specifed Entity Control packet.  
   //! \param refPacket - A pointer to an Entity Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseEntityCtrl *refPacket)
   {
      return(operator<<(*refPacket));
   }

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A pointer to an Entity Control packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseEntityCtrl *refPacket)
   {
     return this->pack(*refPacket);
   }

   //=========================================================
   //! Packs the buffer with the pointer to the specifed packet.  
   //! \param refPacket - A pointer to an Enviroment type
   //!    Control packet.  This includes Celestial and Atmosphere Ctrl
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseEnvCtrl *refPacket)
   {
      return(operator<<(*refPacket));
   }

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A pointer to an Enviroment type
   //!    Control packet.  This includes Celestial and Atmosphere Ctrl
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseEnvCtrl *refPacket)
   {
     return this->pack(*refPacket);
   }

   //=========================================================
   //! Packs the buffer with the specifed packet.  
   //! \param refPacket - A pointer to a variable size packet
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBaseVariableSizePckt *refPacket)
   {
      return(operator<<(*refPacket));
   }

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refPacket - A pointer to a variable size packet
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBaseVariableSizePckt *refPacket)
   {
     return this->pack(*refPacket);
   }

   //=========================================================
   //! Packs the buffer with the pointer to the specifed packet.  
   //! \param refBasePacket - A pointer to a base packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & operator <<(CigiBasePacket *refBasePacket)
   {
      return(operator<<(*refBasePacket));
   }

   //=========================================================
   //! Non operator-overloaded pack method for scripting.
   //! \param refBasePacket - A pointer to a base packet.
   //!
   //! \return This returns a reference to this CigiOutgoingMsg object
   CigiOutgoingMsg & pack(CigiBasePacket *refBasePacket)
   {
     return this->pack(*refBasePacket);
   }



   //==> Buffer Packing Managers

   //=========================================================
   //! Alerts the system that a message is being started.  
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int BeginMsg(void)
   {
      if(Buffers.empty())
         AdvanceBuffer();
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Updates the Frame Counter in the IG Control or SOF packet
   //!   of the current message.  
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int UpdateFrameCntr(void);

   //=========================================================
   //! Increments the Frame Counter in the IG Control or SOF packet
   //!   of the specified Outgoing message.  If the IncomingMsg
   //!   is NULL, data from the Version Jump Table is used.
   //! \param OutgoingMsg - A pointer to the outgoing msg buffer
   //! \param IncomingMsg - A pointer to the incoming msg buffer
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int UpdateFrameCntr(Cigi_uint8 *OutgoingMsg, Cigi_uint8 *IncomingMsg = NULL);

   //=========================================================
   //! Updates the IG Control's Frame Counter and Database ID if needed
   //! \param OutgoingMsg - A pointer to the outgoing msg buffer
   //! \param IncomingMsg - A pointer to the incoming msg buffer
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int UpdateIGCtrl(Cigi_uint8 *OutgoingMsg, Cigi_uint8 *IncomingMsg);

   //=========================================================
   //! Updates SOF's Frame Counter
   //! \param OutgoingMsg - A pointer to the outgoing msg buffer
   //! \param IncomingMsg - A pointer to the incoming msg buffer
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int UpdateSOF(Cigi_uint8 *OutgoingMsg, Cigi_uint8 *IncomingMsg = NULL)
   {
      return(UpdateFrameCntr(OutgoingMsg,IncomingMsg));
   }

   //=========================================================
   //! Locks the message for sending
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int LockMsg(void);

   //=========================================================
   //! Gets a pointer to the beginning of the message and
   //!   the length of the message
   //! \param length - A reference to place the length of
   //!    the message.

   //! \return Message - A pointer to the beginning of the message.
   //!
	Cigi_uint8 * GetMsg(int &length);

   //=========================================================
   //! Gets a pointer to the beginning of the buffer.
   //! \return Buffer - A pointer to the beginning of the buffer.
   //!
   Cigi_uint8 * GetBuffer(void);

   //=========================================================
   //! Gets the length of the message in bytes. 
   //!
   //! \return The length of the message in bytes.
   //!
   int GetMsgLength(void);

   //=========================================================
   //! Gets a std::string of the buffer.  Note - not really the 
   //! most efficient way to retrieve the buffer contents, as it 
   //! makes a copy of the buffer.  Used by the scripting language 
   //! wrapper.
   //! \return Buffer - A std::string copy of the buffer.
   //!
   std::string GetBufferString(void);

   //=========================================================
   //! Unlocks the message after sending
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int UnlockMsg(void);

   //=========================================================
   //! Packages the current message.
   //! Sets up the next buffer for packing.
   //! and returns a pointer to the message to be sent and the length.
   //! \param Msg - A pointer to a pointer to the beginning of the message.
   //! \param length - A reference to place the length of
   //!    the message.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int PackageMsg(Cigi_uint8 **Msg, int &length);

   //=========================================================
   //! Gets the currently Packaged message.
   //! Sets up the next buffer for packing.
   //! and returns a pointer to the message to be sent and the length.
   //! \param Msg - A pointer to a pointer to the beginning of the message.
   //! \param length - A reference to place the length of
   //!    the message.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int GetCurrentlyPackagedMsg(Cigi_uint8 **Msg, int &length)
   {
      if(PackagedMsg != NULL)
      {
         *Msg = PackagedMsg->Buffer;
         length = PackagedMsg->BufferFillCnt;
         return(CIGI_SUCCESS);
      }
      else
      {
         *Msg = (Cigi_uint8 *)0;  // equivalent to NULL
         length = 0;
         return(CIGI_ERROR_UNEXPECTED_NULL);
      }
   }

   //=========================================================
   //! Frees the last packaged message buffer for use.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   int FreeMsg(void);

   //+> Frame Count

   //=========================================================
   //! Sets the current Frame Count
   //! \param FrameCntIn - Sets the frame count of the session.
   //!
   void SetFrameCnt(const Cigi_uint32 FrameCntIn) { FrameCnt = FrameCntIn; }

   //=========================================================
   //! Gets the current Frame Count.
   //! \return the current frame count of the session.
   //!
   Cigi_uint32 GetFrameCnt(void) const { return(FrameCnt); }

   //+> Synchronous Operation

   //=========================================================
   //! Deprecated:<br>
   //!   This member function nolonger does anything.
   //! \param Sync - Sets the synchronous/asynchronous mode 
   //!   of operation.<br>
   //!   true - Synchronous operation.
   //!   false - Asynchronous operation.
   //!
   void SetSynchronous(const bool Sync) { };

   //=========================================================
   //! Gets the synchronous/asynchronous mode of operation.
   //! \return the synchronous/asynchronous mode of operation.
   //!   true - Synchronous operation.
   //!   false - Asynchronous operation.
   //!
   bool IsSynchronous(void) const;


   //+> Registering

   //=========================================================
   //! Register a user packet for use.
   //! \param Packet - A pointer to the packet manager object
   //! \param PacketID - The packet id
   //! \param HostSend - A flag specifying whether the host
   //!   can send this packet.
   //! \param IGSend - A flag specifying whether the IG
   //!   can send this packet.
   //!
   //! \return the a flag specifying whether the specified
   //!   packet is valid to send.
   //!
	int RegisterUserPacket(CigiBasePacket *Packet,
                          Cigi_uint8 PacketID,
                          bool HostSend,
                          bool IGSend);




protected:


   //=========================================================
   //! Resets the buffer system.  
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int Reset(void);

   //=========================================================
   //! Prepairs a message buffer for packet insertion.  
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int InitMsg(void)
   {
      AdvanceBuffer();
      return(CIGI_SUCCESS);
   }

   //=========================================================
   //! Sets the complete outgoing external interface Cigi
   //!  Version with bound checking control
   //! \param CigiVersionIn - Sets the Cigi Version of
   //!   the outgoing message interface
   //! \param bndchk - Enables (true) or disables (false) bounds checking
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	int SetOutgoingCigiVersion(CigiVersionID &Version,
                              bool bndchk=true);

   //=========================================================
   //! Sets the complete outgoing external interface Cigi
   //!  Version with bound checking control
   //! \param CigiVersionIn - Sets the Cigi Version of
   //!   the outgoing message interface
   //! \param bndchk - Enables (true) or disables (false) bounds checking
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	CigiVersionID GetOutgoingCigiVersion(void)
   {
      return(OutgoingVersion);
   }

   //=========================================================
   //! Sets the complete Cigi Version value of the most mature
   //    Cigi Version of an incoming message received.
   //! \param CigiVersionIn - The most mature Cigi Version of
   //!   the incoming message interface
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
	void SetMostMatureReceivedCigiVersion(CigiVersionID &Version);

   //=========================================================
   //! Sets the count of the last frame received.
   //! \param LastRcvdFrame - The count of the last frame received.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   void SetLastRcvdFrame(Cigi_uint32 LastRcvdFrameIn)
   {
      LastRcvdFrame = LastRcvdFrameIn;
   }

   //=========================================================
   //! Sets the buffer's complete CIGI version.
   //! Also, changes which version of the IG Control packet
   //! gets packed into the buffer.
   //! It uses the version of CIGI that is currently set as
   //! the version being used for the Outgoing Message.
   //!
	void ChangeBufferCigiVersion(void);

   //=========================================================
   //! Deletes the contents of OutgoingHandlerTbl and sets entries in 
   //! VldSnd accordingly.
   //!
   void ClearHandlerTable(void);

   //=========================================================
   //! Sets the external interface tables to Host output with
   //!   Cigi Version 1 packets
   //!
	void SetOutgoingHostV1Tbls(void);

   //=========================================================
   //! Sets the external interface tables to IG output with
   //!   Cigi Version 1 packets
   //!
	void SetOutgoingIGV1Tbls(void);

   //=========================================================
   //! Sets the external interface tables to Host output with
   //!   Cigi Version 2 packets
   //!
	void SetOutgoingHostV2Tbls(void);

   //=========================================================
   //! Sets the external interface tables to IG output with
   //!   Cigi Version 2 packets
   //!
	void SetOutgoingIGV2Tbls(void);

   //=========================================================
   //! Sets the external interface tables to Host output with
   //!   Cigi Version 3 packets
   //!
	void SetOutgoingHostV3Tbls(void);

   //=========================================================
   //! Sets the external interface tables to IG output with
   //!   Cigi Version 3 packets
   //!
	void SetOutgoingIGV3Tbls(void);

   //=========================================================
   //! Inserts a new buffer into the active buffer list
   //!  and initiates it as the buffer currently being filled.
   //!
	void AdvanceBuffer(void);

   //=========================================================
   //! Packs the buffer with the pointer to the specifed packet.  
   //! \param DataPacket - A packet object containing the data.
   //! \param PackingPacket - A packet object that will pack
   //!   the data from the DataPacket.
   //! \param Spec - A pointer to special data
   //!
   CigiOutgoingMsg &  PackObj(CigiBasePacket &DataPacket,
                              CigiBasePacket &PackingPacket,
                              void *Spec);

   //=========================================================
   //! Changes the outgoing cigi version.  
   //! \param Version - The CIGI version to which to change.
   //!
   void ChangeOutgoingCigiVersion(CigiVersionID &Version);

   //=========================================================
   //! The Version of CIGI being sent out
   //!
   CigiVersionID OutgoingVersion;

   //=========================================================
   //! There is a change in the Commanded Version of Cigi
   //!
   bool CmdVersionChng;

   //=========================================================
   //! The Commanded Version of Cigi
   //!
   CigiVersionID CmdVersion;

   //=========================================================
   //! The most mature version of CIGI received
   //!
   CigiVersionID MostMatureVersionReceived;

   //=========================================================
   //! A default packet manager
   //!
   CigiDefaultPacket DefaultPacket;

   //=========================================================
   //! The Conversion Table for managers of outgoing packets
   //!
   CigiBasePacket *OutgoingHandlerTbl[256];

   //=========================================================
   //! The Packet valid to send Table
   //!
   bool VldSnd[256];

   //=========================================================
   //! The current frame count
   //!
   Cigi_uint32 FrameCnt;

   //=========================================================
   //! The count of the last received frame
   //!
   Cigi_uint32 LastRcvdFrame;

   //=========================================================
   //! An Array of IGCtrl packers
   //!
   CigiBaseIGCtrl *pIGCtrlPck[6];

   //=========================================================
   //! An Array of SOF packers
   //!
   CigiBaseSOF *pSOFPck[5];




};

#endif // !defined(_CIGI_OUTGOING_MESSAGE_INCLUDED_)