Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

ArRobotPacket.h

00001 /*
00002 ActivMedia Robotics Interface for Applications (ARIA)
00003 Copyright (C) 2004,2005 ActivMedia Robotics, LLC
00004 
00005 
00006      This program is free software; you can redistribute it and/or modify
00007      it under the terms of the GNU General Public License as published by
00008      the Free Software Foundation; either version 2 of the License, or
00009      (at your option) any later version.
00010 
00011      This program is distributed in the hope that it will be useful,
00012      but WITHOUT ANY WARRANTY; without even the implied warranty of
00013      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014      GNU General Public License for more details.
00015 
00016      You should have received a copy of the GNU General Public License
00017      along with this program; if not, write to the Free Software
00018      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00019 
00020 If you wish to redistribute ARIA under different terms, contact 
00021 ActivMedia Robotics for information about a commercial version of ARIA at 
00022 robots@activmedia.com or 
00023 ActivMedia Robotics, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
00024 
00025 */
00026 
00027 #ifndef ARROBOTPACKET_H
00028 #define ARROBOTPACKET_H
00029 
00030 #include "ariaTypedefs.h"
00031 #include "ArBasePacket.h"
00032 #include "ariaUtil.h"
00033 
00035 
00042 class ArRobotPacket: public ArBasePacket
00043 {
00044 public:
00046   ArRobotPacket(unsigned char sync1 = 0xfa, 
00047                          unsigned char sync2 = 0xfb);
00049   virtual ~ArRobotPacket();
00050 
00052   bool verifyCheckSum(void);
00053 
00055   ArTypes::UByte getID(void);
00056 
00058   void setID(ArTypes::UByte id);
00059 
00061   ArTypes::Byte2 calcCheckSum(void);
00062   
00063   // only call finalizePacket before a send
00064   virtual void finalizePacket(void);
00065   
00067   ArTime getTimeReceived(void);
00069   void setTimeReceived(ArTime timeReceived);
00070 
00071 protected:
00072   unsigned char mySync1;
00073   unsigned char mySync2;
00074   ArTime myTimeReceived;
00075 };
00076 
00077 #endif // ARROBOTPACKET_H

Generated on Wed Oct 19 12:56:36 2005 for Aria by  doxygen 1.4.0