SI1143ProximityMessage.h

00001 /**
00002  * @file SI1143ProximityMessage.h
00003  *
00004  * @author Adrian
00005  * @date 02.06.2016
00006  *
00007  */
00008 #include <stdio.h>
00009 #include <string>
00010 #include <vector>
00011 #include <stdint.h>
00012 #include "SensorMessage.h "
00013 
00014 #ifndef APP_SI1143MESSAGE_H_
00015 #define APP_SI1143MESSAGE_H_
00016 
00017 #define SI1143_PROXIMITY_MESSAGE_ID     "P4"
00018 
00019 /**
00020  * @class SI1143ProximityMessage
00021  * @brief A Container that can hold acquired proximity values from the SI1143. The container will be
00022  * transported via a MessageQueue between different Tasks.
00023  */
00024 class SI1143ProximityMessage: public SensorMessage {
00025 public:
00026     SI1143ProximityMessage();
00027     virtual ~SI1143ProximityMessage();
00028 
00029     /**
00030      * Sets the proximity value of the SI1143ProximityMessage
00031      * @param proximity proximity value to be stored
00032      */
00033     void setProximity(uint16_t proximity);
00034 
00035     /**
00036      * Gets the proximity value from the SI1143ProximityMessage
00037      * @return
00038      */
00039     uint16_t getProximity();
00040 
00041 
00042     /**
00043      * Gets a small LoRaMessage Type Formated String from the MAX44009Message.
00044      * This String can later be used for transportation via LoRa
00045      * @return
00046      */
00047     virtual char* getLoRaMessageString();
00048 
00049 private:
00050     std::string loraMessage;
00051     std::vector<std::string> loraMessageId;
00052 
00053     uint16_t proximity;
00054 };
00055 
00056 #endif /* APP_SI1143MESSAGE_H_ */