NDEF NFC library

File content as of revision 9:689c1f56f359:

/**
 ******************************************************************************
 * @file    Message.h
 * @author  ST / Central Labs
 * @version V1.0.0
 * @date    6 Nov 2015
 * @brief   NDef Message 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_MESSAGE_H_
#define NDEFLIB_MESSAGE_H_

#include <vector>

#include "Record.h"

namespace NDefLib {

/**
 * class containing a list of {@link Record}
 */
class Message {
public:

	/**
	 * add a ndef record to this message
	 * @param r record to add
	 */
	void addRecord(Record *r) {
		mRecords.push_back(r);
	}

	/**
	 * add all the record in the list to this message
	 * @param addList list of record to add
	 */
	void addRecords(const std::vector<Record*> &addList) {
		mRecords.insert(mRecords.end(), addList.begin(), addList.end());
	}

	/**
	 * get the specific record contained by this message, or NULL if itn't a valid index
	 * @param index record index
	 * @return if present a record otherwise NULL
	 */
	Record* operator[](const uint32_t index){
		if (index >= mRecords.size())
			return NULL;
		return mRecords[index];
	}

	/**
	 * get the number of records in this message
	 * @return number of record in this message
	 */
	uint32_t getNRecords() const {
		return mRecords.size();
	}

	/**
	 * length in byte needed for write this message
	 * @return number of byte needed for with this message
	 */
	uint16_t getByteLength() const;

	/**
	 * write this message in the buffer
	 * @par the first 2 byte are the NDEF message length
	 * @param[out] buffer buffer where write this message
	 * @return number of bytes wrote
	 */
	uint16_t write(uint8_t *buffer) const;

	/**
	 * try to rebuild all the record from a message buffer
	 * @par I assume that you already read the NDEF length, so the buffer doesn't contain it
	 * @param buffer buffer containing the message record
	 * @param bufferLength buffer length
	 * @param message message where the function will add the read record
	 */
	static void parseMessage(const uint8_t * const buffer,
			const uint8_t bufferLength, Message *message);

	virtual ~Message() {
	}

private:
	/**
	 * list of record contained by this message
	 */
	std::vector<Record*> mRecords;
};

} /* namespace NDefLib */

#endif /* NDEFLIB_MESSAGE_H_ */