NDEF NFC library

File content as of revision 8:473f6e0b03df:

/**
 ******************************************************************************
 * @file    Record.h
 * @author  ST / Central Labs
 * @version V1.0.0
 * @date    30 Nov 2015
 * @brief   generic Record class 
 ******************************************************************************
 * @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_RECORD_H_
#define NDEFLIB_RECORD_H_
#include <stdint.h>

#include "RecordHeader.h"

namespace NDefLib {

/**
 * Base class for a NDefRecord
 * @see NFC Data Exchange Format (NDEF) Technical Specification NDEF 1.0
 */
class Record {
public:

	/**
	 * enum used for identify the record type
	 */
	typedef enum {
		TYPE_UNKNOWN,        //!< UNKNOWN record
		TYPE_TEXT,           //!< TEXT
		TYPE_AAR,            //!< Android Archive record
		TYPE_MIME,           //!< generic MIME type
		TYPE_URI,            //!< generic URI
		TYPE_URI_MAIL,       //!< Email URI record
		TYPE_URI_SMS,        //!< SMS URI record
		TYPE_URI_GEOLOCATION,//!< position URI record
		TYPE_MIME_VCARD      //!< VCard record
	} RecordType_t;

	Record() {
	}

	/**
	 * set the record as the first record in the message
	 */
	void setAsFirstRecord() {
		mRecordHeader.setMB(true);
	}

	/**
	 * set the record as the last record in the message
	 */
	void setAsLastRecord() {
		mRecordHeader.setME(true);
	}

	/**
	 * @return true if it is the last record in the message
	 */
	bool isLastRecord() const {
		return mRecordHeader.getME();
	}

	/**
	 * @return true if it is the fist record in the message
	 */
	bool isFirstRecord() const {
		return mRecordHeader.getMB();
	}

	/**
	 * set the record as generic
	 */
	void setAsMiddleRecord() {
		mRecordHeader.setMB(false);
		mRecordHeader.setME(false);
	}

	bool isMiddleRecord() const{
		return ! (mRecordHeader.getMB() || mRecordHeader.getME());
	}

	/**
	 * get tag type
	 * @return tag type if not overwrite it return TYPE_UNKNOWN
	 */
	virtual RecordType_t getType() const {
		return TYPE_UNKNOWN;
	} //getType


	/**
	 * get the record header for this record
	 * @return record header used for this record
	 */
	const RecordHeader& getHeader() const{
		return mRecordHeader;
	}

	/**
	 * number of byte needed for store this record
	 * @return size header + size record content
	 */
	virtual uint16_t getByteLength() {
		return mRecordHeader.getRecordLength();
	}

	/**
	 * write the record content into a buffer
	 * @param[out] buffer buffer where write the record content, the buffer size must be almost getByteLength() bytes
	 * @return number of write bytes
	 */
	virtual uint16_t write(uint8_t *buffer)=0;

	virtual ~Record() {
	};

protected:
	RecordHeader mRecordHeader;
};

} /* namespace NDefLib */

#endif /* NDEFLIB_RECORD_H_ */