Andrew Lindsay / Mbed 2 deprecated IoTGateway_Basic

Dependencies:   NetServices FatFileSystem csv_parser mbed MQTTClient RF12B DNSResolver SDFileSystem

Embed: (wiki syntax)

« Back to documentation index

OutputDef Class Reference

OutputDef Class Reference

Base class for output definitions. More...

#include <OutputDef.h>

Public Member Functions

 OutputDef ()
 Default Constructor.
virtual void init ()=0
 Initialise output definition object.
virtual void addReading (char *dataFeed, char *dataStream, char *reading)=0
 Add a character pointer reading to output.
virtual int send ()=0
 Send any collected readings to the api.
virtual int getSendCount ()=0
 Get the send count.

Detailed Description

Base class for output definitions.

Definition at line 40 of file OutputDef.h.


Constructor & Destructor Documentation

OutputDef (  )

Default Constructor.

IoT Gateway Output definition, base class.

Author:
Andrew Lindsay

LICENSE

Copyright (c) 2012 Andrew Lindsay (andrew [at] thiseldo [dot] co [dot] uk)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

DESCRIPTION

Definition at line 37 of file OutputDef.cpp.


Member Function Documentation

virtual void addReading ( char *  dataFeed,
char *  dataStream,
char *  reading 
) [pure virtual]

Add a character pointer reading to output.

Parameters:
dataFeedThe feed to update
dataStreamThe data stream within the feed to update or null if no feed
readingThe new value
virtual int getSendCount (  ) [pure virtual]

Get the send count.

Returns:
mumber of API calls made
virtual void init (  ) [pure virtual]

Initialise output definition object.

virtual int send (  ) [pure virtual]

Send any collected readings to the api.

Returns:
-1 for fail, 1 for success