//------------------------------------------------------------------------------
// <copyright file="LqrSMACCSVSample.h" company="LiquidRobotics">
//
// Copyright (c) 2014 Liquid Robotics, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
// This software is associated with a release.  Liquid Robotics makes no
// representation that the design, interfaces or component distribution will
// remain unchanged in future releases.
//
// </copyright>
//
// <summary>
//   Declaration of CSVSample class, which encapsulates a set of CSV values
//
//	 CSVSample sample;
//   sample += timestamp.ToString();
//	 sample += ftos(latitude,9);
//   sample += ftos(longitude,10);
//   cout << sample << endl;
// </summary>
//
// <owner>Mike Cookson</owner>
//------------------------------------------------------------------------------

#ifndef __LqrSMACCSVSample_h__
#define __LqrSMACCSVSample_h__

#include "LqrSMACSharedLib.h"
#include <string>
#include <vector>

namespace LiquidRobotics {
namespace SMACFramework {

class SHARED_LIB_PUBLIC CSVSample
{
public:

	typedef std::string ItemType;
	typedef std::vector<std::string> ContainerType;
	typedef ContainerType::size_type size_type;

	CSVSample(size_type initialSize = 0, size_type reservedSize = 0);
	CSVSample(const CSVSample& rhs);
	CSVSample(const ContainerType& rhs);
	CSVSample(const ItemType& rhs, size_type reservedSize = 1);

	virtual ~CSVSample();

	CSVSample& operator=(const CSVSample& rhs);
	CSVSample& operator+=(const ItemType& rhs);
	void Clear();
	ContainerType& Container();
	const ContainerType& Container() const;
	ItemType& operator[](size_type index);
	const ItemType& operator[](size_type index) const;
	bool IsEmpty() const;
	void Reserve(size_type newReserved);
	size_type Size() const;

	template<typename T> bool CastField(size_t index, T& value) const throw();
	template<typename T> T CastField(size_t index) const;

	void FormatCSV(std::ostream& stm) const;
	void FromString(const std::string& str);
	void ParseCSV(std::istream& stm);
	std::string ToString() const;

	static void FormatCSVField(std::ostream& stm, const ItemType& item);
	static ItemType ParseCSVField(std::istream& stm);
	static ItemType ParseCSVField(std::istream& stm, bool& positiveItem);

private:

	ContainerType container;
};

}
}

std::istream& operator>>(std::istream& stm, LiquidRobotics::SMACFramework::CSVSample& sample);
std::istream& operator<<(std::ostream& stm, const LiquidRobotics::SMACFramework::CSVSample& sample);

#endif
