NDEF NFC library

File content as of revision 4:eaf6c49a86e4:

/*
 * Record.h
 *
 *  Created on: Nov 6, 2015
 *      Author: giovanni visentini
 */

#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();
	}

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

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

	/**
	 * 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_ */