Duy tran / RecordType-v-16

v-16

RecordGeo.h@0:89e2c8a57572, 2017-12-12 (annotated)

Committer:
DuyLionTran
Date:
Tue Dec 12 15:58:23 2017 +0000
Revision:
0:89e2c8a57572
version 1.6

Who changed what in which revision?

UserRevisionLine numberNew contents of line
DuyLionTran 0:89e2c8a57572 1 /**
DuyLionTran 0:89e2c8a57572 2 ******************************************************************************
DuyLionTran 0:89e2c8a57572 3 * @file RecordGEO.h
DuyLionTran 0:89e2c8a57572 4 * @author ST / Central Labs
DuyLionTran 0:89e2c8a57572 5 * @version V2.0.0
DuyLionTran 0:89e2c8a57572 6 * @date 28 Apr 2017
DuyLionTran 0:89e2c8a57572 7 * @brief Specialize the @{link RecordURI} to handle a location position, the location
DuyLionTran 0:89e2c8a57572 8 * is stored with latitude and longitude.
DuyLionTran 0:89e2c8a57572 9 ******************************************************************************
DuyLionTran 0:89e2c8a57572 10 * @attention
DuyLionTran 0:89e2c8a57572 11 *
DuyLionTran 0:89e2c8a57572 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
DuyLionTran 0:89e2c8a57572 13 *
DuyLionTran 0:89e2c8a57572 14 * Redistribution and use in source and binary forms, with or without modification,
DuyLionTran 0:89e2c8a57572 15 * are permitted provided that the following conditions are met:
DuyLionTran 0:89e2c8a57572 16 * 1. Redistributions of source code must retain the above copyright notice,
DuyLionTran 0:89e2c8a57572 17 * this list of conditions and the following disclaimer.
DuyLionTran 0:89e2c8a57572 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
DuyLionTran 0:89e2c8a57572 19 * this list of conditions and the following disclaimer in the documentation
DuyLionTran 0:89e2c8a57572 20 * and/or other materials provided with the distribution.
DuyLionTran 0:89e2c8a57572 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
DuyLionTran 0:89e2c8a57572 22 * may be used to endorse or promote products derived from this software
DuyLionTran 0:89e2c8a57572 23 * without specific prior written permission.
DuyLionTran 0:89e2c8a57572 24 *
DuyLionTran 0:89e2c8a57572 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
DuyLionTran 0:89e2c8a57572 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
DuyLionTran 0:89e2c8a57572 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DuyLionTran 0:89e2c8a57572 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
DuyLionTran 0:89e2c8a57572 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DuyLionTran 0:89e2c8a57572 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
DuyLionTran 0:89e2c8a57572 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
DuyLionTran 0:89e2c8a57572 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
DuyLionTran 0:89e2c8a57572 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
DuyLionTran 0:89e2c8a57572 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
DuyLionTran 0:89e2c8a57572 35 *
DuyLionTran 0:89e2c8a57572 36 ******************************************************************************
DuyLionTran 0:89e2c8a57572 37 */
DuyLionTran 0:89e2c8a57572 38
DuyLionTran 0:89e2c8a57572 39 #ifndef NDEFLIB_RECORDTYPE_RECORDGEO_H_
DuyLionTran 0:89e2c8a57572 40 #define NDEFLIB_RECORDTYPE_RECORDGEO_H_
DuyLionTran 0:89e2c8a57572 41
DuyLionTran 0:89e2c8a57572 42 #include "RecordURI.h"
DuyLionTran 0:89e2c8a57572 43
DuyLionTran 0:89e2c8a57572 44 namespace NDefLib {
DuyLionTran 0:89e2c8a57572 45
DuyLionTran 0:89e2c8a57572 46 /**
DuyLionTran 0:89e2c8a57572 47 * Specialize the {@link RecordUri} to handle a location position, the location
DuyLionTran 0:89e2c8a57572 48 * is stored with latitude and longitude.
DuyLionTran 0:89e2c8a57572 49 * @par The coordinates are floats with 4 decimal positions.
DuyLionTran 0:89e2c8a57572 50 */
DuyLionTran 0:89e2c8a57572 51 class RecordGeo: public RecordURI {
DuyLionTran 0:89e2c8a57572 52 public:
DuyLionTran 0:89e2c8a57572 53
DuyLionTran 0:89e2c8a57572 54 /**
DuyLionTran 0:89e2c8a57572 55 * Create an RecordGeo reading the data from the buffer.
DuyLionTran 0:89e2c8a57572 56 * @param header Record header.
DuyLionTran 0:89e2c8a57572 57 * @param buffer Buffer to read the data from.
DuyLionTran 0:89e2c8a57572 58 * @return an object of type RecordGeo or NULL
DuyLionTran 0:89e2c8a57572 59 * @par User is in charge of freeing the pointer returned by this function.
DuyLionTran 0:89e2c8a57572 60 */
DuyLionTran 0:89e2c8a57572 61 static RecordGeo* parse(const RecordHeader &header,
DuyLionTran 0:89e2c8a57572 62 const uint8_t * const buffer);
DuyLionTran 0:89e2c8a57572 63
DuyLionTran 0:89e2c8a57572 64
DuyLionTran 0:89e2c8a57572 65 /**
DuyLionTran 0:89e2c8a57572 66 * Create a record that contains a gps coordinate.
DuyLionTran 0:89e2c8a57572 67 * @param lat Latitude.
DuyLionTran 0:89e2c8a57572 68 * @param lon Longitude.
DuyLionTran 0:89e2c8a57572 69 */
DuyLionTran 0:89e2c8a57572 70 RecordGeo(const float lat, const float lon);
DuyLionTran 0:89e2c8a57572 71
DuyLionTran 0:89e2c8a57572 72 virtual ~RecordGeo() { };
DuyLionTran 0:89e2c8a57572 73
DuyLionTran 0:89e2c8a57572 74 /**
DuyLionTran 0:89e2c8a57572 75 * Return the longitude coordinate
DuyLionTran 0:89e2c8a57572 76 * @return the longitude coordinate
DuyLionTran 0:89e2c8a57572 77 */
DuyLionTran 0:89e2c8a57572 78 float get_longitude()const {
DuyLionTran 0:89e2c8a57572 79 return mLongitude;
DuyLionTran 0:89e2c8a57572 80 }
DuyLionTran 0:89e2c8a57572 81
DuyLionTran 0:89e2c8a57572 82 /**
DuyLionTran 0:89e2c8a57572 83 * Return the latitude coordinate
DuyLionTran 0:89e2c8a57572 84 * @return the latitude coordinate
DuyLionTran 0:89e2c8a57572 85 */
DuyLionTran 0:89e2c8a57572 86 float get_latitude()const {
DuyLionTran 0:89e2c8a57572 87 return mLatitiude;
DuyLionTran 0:89e2c8a57572 88 }
DuyLionTran 0:89e2c8a57572 89
DuyLionTran 0:89e2c8a57572 90 /**
DuyLionTran 0:89e2c8a57572 91 * Change the latitude coordinate.
DuyLionTran 0:89e2c8a57572 92 * @param lat new latitude.
DuyLionTran 0:89e2c8a57572 93 */
DuyLionTran 0:89e2c8a57572 94 void set_latitude(const float lat){
DuyLionTran 0:89e2c8a57572 95 mContentIsChange=true;
DuyLionTran 0:89e2c8a57572 96 mLatitiude=lat;
DuyLionTran 0:89e2c8a57572 97 }
DuyLionTran 0:89e2c8a57572 98
DuyLionTran 0:89e2c8a57572 99 /**
DuyLionTran 0:89e2c8a57572 100 * Change the longitude coordinate.
DuyLionTran 0:89e2c8a57572 101 * @param lon new longitude
DuyLionTran 0:89e2c8a57572 102 */
DuyLionTran 0:89e2c8a57572 103 void set_longitude(const float lon){
DuyLionTran 0:89e2c8a57572 104 mContentIsChange=true;
DuyLionTran 0:89e2c8a57572 105 mLongitude=lon;
DuyLionTran 0:89e2c8a57572 106 }
DuyLionTran 0:89e2c8a57572 107
DuyLionTran 0:89e2c8a57572 108 /**
DuyLionTran 0:89e2c8a57572 109 * Get the record type.
DuyLionTran 0:89e2c8a57572 110 * @return TYPE_URI_GEOLOCATION
DuyLionTran 0:89e2c8a57572 111 */
DuyLionTran 0:89e2c8a57572 112 virtual RecordType_t get_type() const {
DuyLionTran 0:89e2c8a57572 113 return TYPE_URI_GEOLOCATION;
DuyLionTran 0:89e2c8a57572 114 } //getType
DuyLionTran 0:89e2c8a57572 115
DuyLionTran 0:89e2c8a57572 116 /**
DuyLionTran 0:89e2c8a57572 117 * Compare two RecordGeo tags.
DuyLionTran 0:89e2c8a57572 118 * @return true if the two tags have the same latitude and longitude
DuyLionTran 0:89e2c8a57572 119 */
DuyLionTran 0:89e2c8a57572 120 bool operator==(const RecordGeo &other) const {
DuyLionTran 0:89e2c8a57572 121 return (mLatitiude == other.mLatitiude) &&
DuyLionTran 0:89e2c8a57572 122 (mLongitude == other.mLongitude) ;
DuyLionTran 0:89e2c8a57572 123 }
DuyLionTran 0:89e2c8a57572 124
DuyLionTran 0:89e2c8a57572 125 protected:
DuyLionTran 0:89e2c8a57572 126
DuyLionTran 0:89e2c8a57572 127 /**
DuyLionTran 0:89e2c8a57572 128 * This function updates the uri message to write into the tag.
DuyLionTran 0:89e2c8a57572 129 */
DuyLionTran 0:89e2c8a57572 130 virtual void update_content();
DuyLionTran 0:89e2c8a57572 131
DuyLionTran 0:89e2c8a57572 132 private:
DuyLionTran 0:89e2c8a57572 133
DuyLionTran 0:89e2c8a57572 134 /**
DuyLionTran 0:89e2c8a57572 135 * Latitude information.
DuyLionTran 0:89e2c8a57572 136 */
DuyLionTran 0:89e2c8a57572 137 float mLatitiude;
DuyLionTran 0:89e2c8a57572 138
DuyLionTran 0:89e2c8a57572 139 /**
DuyLionTran 0:89e2c8a57572 140 * Longitude information.
DuyLionTran 0:89e2c8a57572 141 */
DuyLionTran 0:89e2c8a57572 142 float mLongitude;
DuyLionTran 0:89e2c8a57572 143
DuyLionTran 0:89e2c8a57572 144 /**
DuyLionTran 0:89e2c8a57572 145 * True if the user has updated the latitude or longitude.
DuyLionTran 0:89e2c8a57572 146 */
DuyLionTran 0:89e2c8a57572 147 bool mContentIsChange;
DuyLionTran 0:89e2c8a57572 148
DuyLionTran 0:89e2c8a57572 149 /**
DuyLionTran 0:89e2c8a57572 150 * Uri type to use for this record.
DuyLionTran 0:89e2c8a57572 151 */
DuyLionTran 0:89e2c8a57572 152 static const std::string sGeoTag;
DuyLionTran 0:89e2c8a57572 153 };
DuyLionTran 0:89e2c8a57572 154
DuyLionTran 0:89e2c8a57572 155 } /* namespace NDefLib */
DuyLionTran 0:89e2c8a57572 156
DuyLionTran 0:89e2c8a57572 157 #endif /* NDEFLIB_RECORDTYPE_RECORDGEO_H_ */