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

ArSickPacket.h

00001 /*
00002 MobileRobots Advanced Robotics Interface for Applications (ARIA)
00003 Copyright (C) 2004, 2005 ActivMedia Robotics LLC
00004 Copyright (C) 2006, 2007 MobileRobots Inc.
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 MobileRobots for information about a commercial version of ARIA at 
00022 robots@mobilerobots.com or 
00023 MobileRobots Inc, 19 Columbia Drive, Amherst, NH 03031; 800-639-9481
00024 */
00025 
00026 #ifndef ARSICKPACKET_H
00027 #define ARSICKPACKET_H
00028 
00029 #include "ariaTypedefs.h"
00030 #include "ArBasePacket.h"
00031 #include "ariaUtil.h"
00032 
00034 
00043 class ArSickPacket: public ArBasePacket
00044 {
00045 public:
00047   AREXPORT ArSickPacket(unsigned char sendingAddress = 0);
00049   AREXPORT virtual ~ArSickPacket();
00050 
00052   AREXPORT void setSendingAddress(unsigned char address);
00053 
00055   AREXPORT unsigned char getSendingAddress(void);
00056 
00058   AREXPORT unsigned char getReceivedAddress(void);
00059   
00061   AREXPORT bool verifyCRC(void);
00062   
00064   AREXPORT ArTypes::UByte getID(void);
00065 
00067   AREXPORT ArTypes::Byte2 calcCRC(void);
00068   
00069   // only call finalizePacket before a send
00070   AREXPORT virtual void finalizePacket(void);
00071   AREXPORT virtual void resetRead(void);
00072   
00074   AREXPORT ArTime getTimeReceived(void);
00076   AREXPORT void setTimeReceived(ArTime timeReceived);
00077 
00079   AREXPORT virtual void duplicatePacket(ArSickPacket *packet);
00080 protected:
00081   ArTime myTimeReceived;
00082   unsigned char mySendingAddress;
00083 };
00084 
00085 #endif // ARSICKPACKET_H

Generated on Tue Feb 20 10:51:41 2007 for Aria by  doxygen 1.4.0