Duy tran / RecordType-v-16

v-16

RecordAAR.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 RecordAAR.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 Create a Record that can start an application in an Android mobile.
DuyLionTran 0:89e2c8a57572 8 ******************************************************************************
DuyLionTran 0:89e2c8a57572 9 * @attention
DuyLionTran 0:89e2c8a57572 10 *
DuyLionTran 0:89e2c8a57572 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
DuyLionTran 0:89e2c8a57572 12 *
DuyLionTran 0:89e2c8a57572 13 * Redistribution and use in source and binary forms, with or without modification,
DuyLionTran 0:89e2c8a57572 14 * are permitted provided that the following conditions are met:
DuyLionTran 0:89e2c8a57572 15 * 1. Redistributions of source code must retain the above copyright notice,
DuyLionTran 0:89e2c8a57572 16 * this list of conditions and the following disclaimer.
DuyLionTran 0:89e2c8a57572 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
DuyLionTran 0:89e2c8a57572 18 * this list of conditions and the following disclaimer in the documentation
DuyLionTran 0:89e2c8a57572 19 * and/or other materials provided with the distribution.
DuyLionTran 0:89e2c8a57572 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
DuyLionTran 0:89e2c8a57572 21 * may be used to endorse or promote products derived from this software
DuyLionTran 0:89e2c8a57572 22 * without specific prior written permission.
DuyLionTran 0:89e2c8a57572 23 *
DuyLionTran 0:89e2c8a57572 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
DuyLionTran 0:89e2c8a57572 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
DuyLionTran 0:89e2c8a57572 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DuyLionTran 0:89e2c8a57572 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
DuyLionTran 0:89e2c8a57572 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DuyLionTran 0:89e2c8a57572 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
DuyLionTran 0:89e2c8a57572 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
DuyLionTran 0:89e2c8a57572 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
DuyLionTran 0:89e2c8a57572 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
DuyLionTran 0:89e2c8a57572 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
DuyLionTran 0:89e2c8a57572 34 *
DuyLionTran 0:89e2c8a57572 35 ******************************************************************************
DuyLionTran 0:89e2c8a57572 36 */
DuyLionTran 0:89e2c8a57572 37
DuyLionTran 0:89e2c8a57572 38 #ifndef NDEFLIB_RECORDTYPE_RECORDAAR_H_
DuyLionTran 0:89e2c8a57572 39 #define NDEFLIB_RECORDTYPE_RECORDAAR_H_
DuyLionTran 0:89e2c8a57572 40
DuyLionTran 0:89e2c8a57572 41 #include <string>
DuyLionTran 0:89e2c8a57572 42
DuyLionTran 0:89e2c8a57572 43 #include "NDefLib/Record.h"
DuyLionTran 0:89e2c8a57572 44
DuyLionTran 0:89e2c8a57572 45 namespace NDefLib {
DuyLionTran 0:89e2c8a57572 46
DuyLionTran 0:89e2c8a57572 47 /**
DuyLionTran 0:89e2c8a57572 48 * Create a Record that can start an application in an Android mobile.
DuyLionTran 0:89e2c8a57572 49 * @par The package data are copied inside the class.
DuyLionTran 0:89e2c8a57572 50 */
DuyLionTran 0:89e2c8a57572 51 class RecordAAR: public Record {
DuyLionTran 0:89e2c8a57572 52 public:
DuyLionTran 0:89e2c8a57572 53
DuyLionTran 0:89e2c8a57572 54 /**
DuyLionTran 0:89e2c8a57572 55 * Create an RecordAAR 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 recordAAR 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 RecordAAR* 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 * Build a new record.
DuyLionTran 0:89e2c8a57572 66 * @param packageName Package of the application to start
DuyLionTran 0:89e2c8a57572 67 */
DuyLionTran 0:89e2c8a57572 68 explicit RecordAAR(const std::string &packageName);
DuyLionTran 0:89e2c8a57572 69
DuyLionTran 0:89e2c8a57572 70 /**
DuyLionTran 0:89e2c8a57572 71 * Get the record type.
DuyLionTran 0:89e2c8a57572 72 * @return TYPE_AAR
DuyLionTran 0:89e2c8a57572 73 */
DuyLionTran 0:89e2c8a57572 74 virtual RecordType_t get_type() const {
DuyLionTran 0:89e2c8a57572 75 return TYPE_AAR;
DuyLionTran 0:89e2c8a57572 76 } //getType
DuyLionTran 0:89e2c8a57572 77
DuyLionTran 0:89e2c8a57572 78 /**
DuyLionTran 0:89e2c8a57572 79 * Get the package inside this record
DuyLionTran 0:89e2c8a57572 80 * @return get the package inside this record
DuyLionTran 0:89e2c8a57572 81 */
DuyLionTran 0:89e2c8a57572 82 const std::string& get_package() const {
DuyLionTran 0:89e2c8a57572 83 return mPackageName;
DuyLionTran 0:89e2c8a57572 84 }
DuyLionTran 0:89e2c8a57572 85
DuyLionTran 0:89e2c8a57572 86 /**
DuyLionTran 0:89e2c8a57572 87 * Change the package name of this record.
DuyLionTran 0:89e2c8a57572 88 * @param package new package
DuyLionTran 0:89e2c8a57572 89 */
DuyLionTran 0:89e2c8a57572 90 void set_package(const std::string& package){
DuyLionTran 0:89e2c8a57572 91 mPackageName=package;
DuyLionTran 0:89e2c8a57572 92 mRecordHeader.set_payload_length(mPackageName.size());
DuyLionTran 0:89e2c8a57572 93 }
DuyLionTran 0:89e2c8a57572 94
DuyLionTran 0:89e2c8a57572 95 virtual uint16_t write(uint8_t *buffer);
DuyLionTran 0:89e2c8a57572 96 virtual ~RecordAAR() { };
DuyLionTran 0:89e2c8a57572 97
DuyLionTran 0:89e2c8a57572 98 /**
DuyLionTran 0:89e2c8a57572 99 * compare two objects
DuyLionTran 0:89e2c8a57572 100 * @return true if the records have the same package name
DuyLionTran 0:89e2c8a57572 101 */
DuyLionTran 0:89e2c8a57572 102 bool operator==(const RecordAAR &other) const{
DuyLionTran 0:89e2c8a57572 103 return (mPackageName==other.mPackageName);
DuyLionTran 0:89e2c8a57572 104 }
DuyLionTran 0:89e2c8a57572 105
DuyLionTran 0:89e2c8a57572 106 private:
DuyLionTran 0:89e2c8a57572 107 /**
DuyLionTran 0:89e2c8a57572 108 * Application to start
DuyLionTran 0:89e2c8a57572 109 */
DuyLionTran 0:89e2c8a57572 110 std::string mPackageName;
DuyLionTran 0:89e2c8a57572 111
DuyLionTran 0:89e2c8a57572 112 /**
DuyLionTran 0:89e2c8a57572 113 * String to use as record type for this record
DuyLionTran 0:89e2c8a57572 114 */
DuyLionTran 0:89e2c8a57572 115 static const char sRecordType[];
DuyLionTran 0:89e2c8a57572 116 };
DuyLionTran 0:89e2c8a57572 117
DuyLionTran 0:89e2c8a57572 118 } /* namespace NDefLib */
DuyLionTran 0:89e2c8a57572 119
DuyLionTran 0:89e2c8a57572 120 #endif /* NDEFLIB_RECORDTYPE_RECORDAAR_H_ */