Duy tran / RecordType

CUSTOMIZED FOR WATER MONITOR

RecordSMS.h@0:51d7bdf88981, 2017-12-07 (annotated)

Committer:
DuyLionTran
Date:
Thu Dec 07 17:07:22 2017 +0000
Revision:
0:51d7bdf88981
CUSTOMIZED FOR WATER MONITOR

Who changed what in which revision?

UserRevisionLine numberNew contents of line
DuyLionTran 0:51d7bdf88981 1 /**
DuyLionTran 0:51d7bdf88981 2 ******************************************************************************
DuyLionTran 0:51d7bdf88981 3 * @file RecordSMS.h
DuyLionTran 0:51d7bdf88981 4 * @author ST / Central Labs
DuyLionTran 0:51d7bdf88981 5 * @version V2.0.0
DuyLionTran 0:51d7bdf88981 6 * @date 28 Apr 2017
DuyLionTran 0:51d7bdf88981 7 * @brief Extend the {@link RecordUri} to handle the SMS content
DuyLionTran 0:51d7bdf88981 8 ******************************************************************************
DuyLionTran 0:51d7bdf88981 9 * @attention
DuyLionTran 0:51d7bdf88981 10 *
DuyLionTran 0:51d7bdf88981 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
DuyLionTran 0:51d7bdf88981 12 *
DuyLionTran 0:51d7bdf88981 13 * Redistribution and use in source and binary forms, with or without modification,
DuyLionTran 0:51d7bdf88981 14 * are permitted provided that the following conditions are met:
DuyLionTran 0:51d7bdf88981 15 * 1. Redistributions of source code must retain the above copyright notice,
DuyLionTran 0:51d7bdf88981 16 * this list of conditions and the following disclaimer.
DuyLionTran 0:51d7bdf88981 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
DuyLionTran 0:51d7bdf88981 18 * this list of conditions and the following disclaimer in the documentation
DuyLionTran 0:51d7bdf88981 19 * and/or other materials provided with the distribution.
DuyLionTran 0:51d7bdf88981 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
DuyLionTran 0:51d7bdf88981 21 * may be used to endorse or promote products derived from this software
DuyLionTran 0:51d7bdf88981 22 * without specific prior written permission.
DuyLionTran 0:51d7bdf88981 23 *
DuyLionTran 0:51d7bdf88981 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
DuyLionTran 0:51d7bdf88981 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
DuyLionTran 0:51d7bdf88981 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DuyLionTran 0:51d7bdf88981 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
DuyLionTran 0:51d7bdf88981 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DuyLionTran 0:51d7bdf88981 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
DuyLionTran 0:51d7bdf88981 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
DuyLionTran 0:51d7bdf88981 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
DuyLionTran 0:51d7bdf88981 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
DuyLionTran 0:51d7bdf88981 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
DuyLionTran 0:51d7bdf88981 34 *
DuyLionTran 0:51d7bdf88981 35 ******************************************************************************
DuyLionTran 0:51d7bdf88981 36 */
DuyLionTran 0:51d7bdf88981 37
DuyLionTran 0:51d7bdf88981 38 #ifndef NDEFLIB_RECORDTYPE_RECORDSMS_H_
DuyLionTran 0:51d7bdf88981 39 #define NDEFLIB_RECORDTYPE_RECORDSMS_H_
DuyLionTran 0:51d7bdf88981 40
DuyLionTran 0:51d7bdf88981 41 #include <string>
DuyLionTran 0:51d7bdf88981 42
DuyLionTran 0:51d7bdf88981 43 #include "RecordURI.h"
DuyLionTran 0:51d7bdf88981 44
DuyLionTran 0:51d7bdf88981 45 namespace NDefLib {
DuyLionTran 0:51d7bdf88981 46
DuyLionTran 0:51d7bdf88981 47 /**
DuyLionTran 0:51d7bdf88981 48 * Extend the {@link RecordUri} to handle the SMS content.
DuyLionTran 0:51d7bdf88981 49 */
DuyLionTran 0:51d7bdf88981 50 class RecordSMS: public RecordURI {
DuyLionTran 0:51d7bdf88981 51 public:
DuyLionTran 0:51d7bdf88981 52
DuyLionTran 0:51d7bdf88981 53 /**
DuyLionTran 0:51d7bdf88981 54 * Read a recordSMS.
DuyLionTran 0:51d7bdf88981 55 * @param header Record header.
DuyLionTran 0:51d7bdf88981 56 * @param buffer Buffer to read the data from.
DuyLionTran 0:51d7bdf88981 57 * @return a RecordSMS type or NULL if it was not possible to build this record
DuyLionTran 0:51d7bdf88981 58 * @par User is in charge of freeing the pointer returned by this function.
DuyLionTran 0:51d7bdf88981 59 */
DuyLionTran 0:51d7bdf88981 60 static RecordSMS* parse(const RecordHeader &header,
DuyLionTran 0:51d7bdf88981 61 const uint8_t *buffer);
DuyLionTran 0:51d7bdf88981 62
DuyLionTran 0:51d7bdf88981 63 /**
DuyLionTran 0:51d7bdf88981 64 * Build a sms record.
DuyLionTran 0:51d7bdf88981 65 * @param number Sms recipient phone number.
DuyLionTran 0:51d7bdf88981 66 * @param message Message to send.
DuyLionTran 0:51d7bdf88981 67 * @par Strings are copied inside the class.
DuyLionTran 0:51d7bdf88981 68 */
DuyLionTran 0:51d7bdf88981 69 RecordSMS(const std::string &number, const std::string &message);
DuyLionTran 0:51d7bdf88981 70
DuyLionTran 0:51d7bdf88981 71 /**
DuyLionTran 0:51d7bdf88981 72 * Get the record type.
DuyLionTran 0:51d7bdf88981 73 * @return TYPE_URI_SMS
DuyLionTran 0:51d7bdf88981 74 */
DuyLionTran 0:51d7bdf88981 75 virtual RecordType_t get_type() const {
DuyLionTran 0:51d7bdf88981 76 return TYPE_URI_SMS;
DuyLionTran 0:51d7bdf88981 77 } //getType
DuyLionTran 0:51d7bdf88981 78
DuyLionTran 0:51d7bdf88981 79 /**
DuyLionTran 0:51d7bdf88981 80 * Get recipient number.
DuyLionTran 0:51d7bdf88981 81 * @return recipient number
DuyLionTran 0:51d7bdf88981 82 */
DuyLionTran 0:51d7bdf88981 83 const std::string& get_number() const {
DuyLionTran 0:51d7bdf88981 84 return mNumber;
DuyLionTran 0:51d7bdf88981 85 }
DuyLionTran 0:51d7bdf88981 86
DuyLionTran 0:51d7bdf88981 87 /**
DuyLionTran 0:51d7bdf88981 88 * Get SMS text message.
DuyLionTran 0:51d7bdf88981 89 * @return SMS text message
DuyLionTran 0:51d7bdf88981 90 */
DuyLionTran 0:51d7bdf88981 91 const std::string& get_messagge() const {
DuyLionTran 0:51d7bdf88981 92 return mMsg;
DuyLionTran 0:51d7bdf88981 93 }
DuyLionTran 0:51d7bdf88981 94
DuyLionTran 0:51d7bdf88981 95 /**
DuyLionTran 0:51d7bdf88981 96 * Change the recipent number.
DuyLionTran 0:51d7bdf88981 97 * @param number New recipent number.
DuyLionTran 0:51d7bdf88981 98 */
DuyLionTran 0:51d7bdf88981 99 void set_number(const std::string &number){
DuyLionTran 0:51d7bdf88981 100 mNumber=number;
DuyLionTran 0:51d7bdf88981 101 mContentIsChange=true;
DuyLionTran 0:51d7bdf88981 102 }
DuyLionTran 0:51d7bdf88981 103
DuyLionTran 0:51d7bdf88981 104 /**
DuyLionTran 0:51d7bdf88981 105 * Change the message content.
DuyLionTran 0:51d7bdf88981 106 * @param message New message.
DuyLionTran 0:51d7bdf88981 107 */
DuyLionTran 0:51d7bdf88981 108 void set_message(const std::string &message){
DuyLionTran 0:51d7bdf88981 109 mMsg=message;
DuyLionTran 0:51d7bdf88981 110 mContentIsChange=true;
DuyLionTran 0:51d7bdf88981 111 }
DuyLionTran 0:51d7bdf88981 112
DuyLionTran 0:51d7bdf88981 113 /**
DuyLionTran 0:51d7bdf88981 114 * Compare 2 objects.
DuyLionTran 0:51d7bdf88981 115 * @return true if the records have the same message and number.
DuyLionTran 0:51d7bdf88981 116 */
DuyLionTran 0:51d7bdf88981 117 bool operator==(const RecordSMS &other) const {
DuyLionTran 0:51d7bdf88981 118 return (mMsg == other.mMsg) &&
DuyLionTran 0:51d7bdf88981 119 (mNumber == other.mNumber);
DuyLionTran 0:51d7bdf88981 120 }
DuyLionTran 0:51d7bdf88981 121
DuyLionTran 0:51d7bdf88981 122 virtual ~RecordSMS() {
DuyLionTran 0:51d7bdf88981 123 };
DuyLionTran 0:51d7bdf88981 124
DuyLionTran 0:51d7bdf88981 125 protected:
DuyLionTran 0:51d7bdf88981 126
DuyLionTran 0:51d7bdf88981 127 /**
DuyLionTran 0:51d7bdf88981 128 * Generate the URI content that encodes the sms.
DuyLionTran 0:51d7bdf88981 129 * @see RecordUri#updateContent
DuyLionTran 0:51d7bdf88981 130 */
DuyLionTran 0:51d7bdf88981 131 virtual void update_content();
DuyLionTran 0:51d7bdf88981 132
DuyLionTran 0:51d7bdf88981 133 private:
DuyLionTran 0:51d7bdf88981 134 std::string mNumber; ///< Recipient number.
DuyLionTran 0:51d7bdf88981 135 std::string mMsg; ///< Sms text.
DuyLionTran 0:51d7bdf88981 136
DuyLionTran 0:51d7bdf88981 137 /**
DuyLionTran 0:51d7bdf88981 138 * This variable is true when we need to update the URI content,
DuyLionTran 0:51d7bdf88981 139 * it is an optimization to avoid to rebuild multiple times the URI content when
DuyLionTran 0:51d7bdf88981 140 * data has not changed
DuyLionTran 0:51d7bdf88981 141 */
DuyLionTran 0:51d7bdf88981 142 bool mContentIsChange;
DuyLionTran 0:51d7bdf88981 143
DuyLionTran 0:51d7bdf88981 144 /**
DuyLionTran 0:51d7bdf88981 145 * String used as URI type.
DuyLionTran 0:51d7bdf88981 146 */
DuyLionTran 0:51d7bdf88981 147 static const std::string sSmsTag;
DuyLionTran 0:51d7bdf88981 148
DuyLionTran 0:51d7bdf88981 149 /**
DuyLionTran 0:51d7bdf88981 150 * String used to separate the number and body data.
DuyLionTran 0:51d7bdf88981 151 */
DuyLionTran 0:51d7bdf88981 152 static const std::string sBodyTag;
DuyLionTran 0:51d7bdf88981 153 };
DuyLionTran 0:51d7bdf88981 154
DuyLionTran 0:51d7bdf88981 155 } /* namespace NDefLib */
DuyLionTran 0:51d7bdf88981 156
DuyLionTran 0:51d7bdf88981 157 #endif /* NDEFLIB_RECORDTYPE_RECORDSMS_H_ */