/usr/include/cigicl/CigiRateCtrlV3.h

/** <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:   CigiRateCtrlV3.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 the ArtPartIDIn parameter type from const Cigi_int8 to const unsigned 
 *  Cigi_int8 in the SetArtPartID method.
 *  
 *  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_RATE_CTRL_V3_INCLUDED_)
#define _CIGI_RATE_CTRL_V3_INCLUDED_

#include "CigiBaseRateCtrl.h"



class CIGI_SPEC CigiRateCtrlV3 : public CigiBaseRateCtrl
{

public:

   //==> Management

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

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


   //==> Buffer Packing/Unpacking

   //=========================================================
   //! The virtual Pack function for CIGI 3
   //! \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 -
   //!          This is not used in this class.
   //!
   //! \return This returns CIGI_SUCCESS or an error code 
   //!   defined in CigiErrorCodes.h
   //!
   virtual int Pack(CigiBasePacket * Base, Cigi_uint8 * Buff, void *Spec) const;

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



   //==> Accessing Member Variable Values functions

   //+> ArtPartIDV3

   //=========================================================
   //! Sets the ArtPartIDV3 with bound checking control
   //! \param ArtPartIDIn - Specifies the art part to which
   //!   this packet's data is applied.
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetArtPartID(const Cigi_uint8 ArtPartIDIn, bool bndchk=true);

   //=========================================================
   //! Gets the ArtPartIDV3 value.
   //! \return the current ArtPartIDV3.
   Cigi_uint8 GetArtPartID(void) const { return(ArtPartIDV3); }


   //+> ApplyToArtPart

   //=========================================================
   //! Sets the ApplyToArtPart with bound checking control
   //! \param ApplyToArtPartIn - Specifies whether this data is to be
   //!   applied to an articulated part or an entity.
   //! \param bndchk - Enables (true) or disables (false) bounds checking.
   //!
   //! \return This returns CIGI_SUCCESS or an error code
   //!   defined in CigiErrorCodes.h
   int SetApplyToArtPart(const bool ApplyToArtPartIn, bool bndchk=true);

   //=========================================================
   //! Gets the ApplyToArtPart value.
   //! \return the current ApplyToArtPart.
   bool GetApplyToArtPart(void) const { return(ApplyToArtPart); }



};

#endif // #if !defined(_CIGI_RATE_CTRL_V3_INCLUDED_)
libcigicl-dev 3.3.3a+svn818-10ubuntu1 / usr / include / cigicl / CigiRateCtrlV3.h
