Utility library to read and write Ndef messages from/to a Type4 NFC tag

Dependents:   NFC M2M_2016_STM32 MyongjiElec_capstone1 IDW01M1_Cloud_IBM ... more

Fork of NDefLib by ST Expansion SW Team

NDEF NFC library

This library provides an abstract API to create NDEF formatted messages and records and to read/write them from/to a Type4 NFC Tag.

Implementations

At the moment, the NDEF API is implemented by X_NUCLEO_NFC01A1 and X_NUCLEO_NFC02A1 Dynamic NFC Tag libraries respectively driving the X-NUCLEO-NFC01A1 and X-NUCLEO-NFC02A1 boards.

RecordType/RecordAAR.h

Committer:
giovannivisentini
Date:
2015-12-22
Revision:
8:473f6e0b03df
Parent:
7:1ebd6049fa57
Child:
9:689c1f56f359

File content as of revision 8:473f6e0b03df:

/**
 ******************************************************************************
 * @file    RecordAAR.h
 * @author  ST / Central Labs
 * @version V1.0.0
 * @date    6 Nov 2015
 * @brief   Create a record that can start an application in an Android mobile
 ******************************************************************************
 * @attention
 *
 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright notice,
 *      this list of conditions and the following disclaimer in the documentation
 *      and/or other materials provided with the distribution.
 *   3. Neither the name of STMicroelectronics nor the names of its contributors
 *      may be used to endorse or promote products derived from this software
 *      without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************
 */

#ifndef NDEFLIB_RECORDTYPE_RECORDAAR_H_
#define NDEFLIB_RECORDTYPE_RECORDAAR_H_

#include <string>

#include "NDefLib/Record.h"

namespace NDefLib {

/**
 * create a record that can start an application in an Android mobile
 */
class RecordAAR: public Record {
public:
	/**
	 * create an RecordAAR reading the data from the buffer
 	 * @param header record header already read
	 * @param buffer buffer where read the data
	 * @return an object of type recordAAR or NULL
	 * @par free the pointer return by this function
	 */
	static RecordAAR* parse(const RecordHeader &header,
			const uint8_t * const buffer);

	/**
	 * build a new record
	 * @param packageName package of the application to start
	 */
	explicit RecordAAR(const std::string &packageName);


	virtual uint16_t write(uint8_t *buffer);

	virtual RecordType_t getType() const {
		return TYPE_AAR;
	} //getType

	/**
	 * @return get the package inside this record
	 */
	const std::string& getPackage() const {
		return mPackageName;
	}

	/**
	 * change the package name of this record
	 * @param package
	 */
	void setPackage(const std::string& package){
		mPackageName=package;
		mRecordHeader.setPayloadLength(mPackageName.size());
	}

	virtual ~RecordAAR() {	};

	bool operator==(const RecordAAR &other) const{
		return 	(mPackageName==other.mPackageName);
	}

private:
	std::string mPackageName;

	/**
	 * string to use as record type for this record
	 */
	static const char sRecordType[];
};

} /* namespace NDefLib */

#endif /* NDEFLIB_RECORDTYPE_RECORDAAR_H_ */