OutputDef.h

00001 /** IoT Gateway Output definition parent class
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 _OUTPUTDEF_H
00033 #define _OUTPUTDEF_H
00034 
00035 #include "mbed.h"
00036 
00037 /** Base class for output definitions
00038  *
00039  */
00040 class OutputDef {
00041 public:
00042     /** Default Constructor
00043      */
00044     OutputDef();
00045 
00046     /** Initialise output definition object
00047      */
00048     virtual void init( ) = 0;
00049     
00050     /** Add a character pointer reading to output 
00051      * 
00052      * @param dataFeed The feed to update
00053      * @param dataStream The data stream within the feed to update or null if no feed
00054      * @param reading The new value
00055      */
00056     virtual void addReading(char *dataFeed, char *dataStream, char *reading ) = 0;
00057     
00058     /** Send any collected readings to the api
00059      * 
00060      * @returns -1 for fail, 1 for success
00061      */
00062     virtual int send( ) = 0;
00063 
00064     /** Get the send count
00065      * 
00066      * @returns mumber of API calls made
00067      */
00068     virtual int getSendCount( ) = 0;
00069 
00070 };
00071 
00072 #endif /* _OUTPUTDEF_H */