PayloadDef.h

00001 /** IoT Gateway RFM12B payload definition
00002  *
00003  * @author Andrew Lindsay
00004  *
00005  * @section LICENSE
00006  *
00007  * Copyright (c) 2012 Andrew Lindsay (andrew [at] thiseldo [dot] co [dot] uk)
00008  *
00009  * Permission is hereby granted, free of charge, to any person obtaining a copy
00010  * of this software and associated documentation files (the "Software"), to deal
00011  * in the Software without restriction, including without limitation the rights
00012  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00013  * copies of the Software, and to permit persons to whom the Software is
00014  * furnished to do so, subject to the following conditions:
00015 
00016  * The above copyright notice and this permission notice shall be included in
00017  * all copies or substantial portions of the Software.
00018  * 
00019  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00020  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00021  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00022  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00023  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00024  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00025  * THE SOFTWARE.
00026  * 
00027  * @section DESCRIPTION
00028  * 
00029  * 
00030  */
00031 
00032 #ifndef _PAYLOADDEF_H
00033 #define _PAYLOADDEF_H
00034 
00035 #include "mbed.h"
00036 
00037 #define MAX_PAYLOAD_SIZE 76
00038 
00039 /** Payload definition base class
00040  */
00041 class PayloadDef {
00042 public:
00043     /** Default Constructor 
00044     */
00045     PayloadDef();
00046     
00047     /** Alternative constructor for passing payload
00048      *
00049      * @param pptr  Pointer to payload data
00050      * @param plen  Length of paylod data
00051      */
00052     PayloadDef( uint8_t *pptr, short plen );
00053 
00054     /** Get the number of readings in a payload
00055      *
00056      * @returns the number of readings found in payload so they can be read
00057      */
00058     virtual short numReadings() = 0;
00059     
00060     /** Get a single reading from the payload
00061      * Other payload definition classes may provide alternative versions for bytes, words or strings
00062      *
00063      * @param readingNum The number of the reading, starts from 0 upto number of readings in payload
00064      * @returns Integer representation of reading
00065      */
00066     virtual int reading( short readingNum ) = 0;
00067     
00068     /** Get the sensor ID for the specified reading within the payload
00069      * Other payload definition classes may provide alternative versions for bytes, words or strings
00070      *
00071      * @param readingNum The number of the reading, starts from 0 upto number of readings in payload
00072      * @returns Integer representation of reading
00073      */
00074     virtual short sensorId( short readingNum ) = 0;
00075 
00076     /** Get the node ID from the data header
00077      * 
00078      * @returns Single byte Node ID from the received header data
00079      */
00080     uint8_t nodeId();
00081 
00082     /** Get the group ID from the data header
00083      * 
00084      * @returns Single byte Group ID from the received header data
00085      */
00086     uint8_t groupId();
00087 
00088 protected:
00089     short readingCount;
00090     short payloadLen;
00091     uint8_t payloadBuffer[MAX_PAYLOAD_SIZE];
00092 
00093 };
00094 
00095 #endif /* _PAYLOADDEF_H */