//---------------------------------------------------------------------------------
// <copyright file="LqrSMACPayloadDescriptionList.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>
// 	Declarations for PayloadDescriptionList, an entity class that stands in for the
//  IDL generated description class.
// </summary>
//
// <owner>Mike Cookson</owner>
//---------------------------------------------------------------------------------

#ifndef __LQRSMACPAYLOADDESCRIPTIONLIST_H__
#define __LQRSMACPAYLOADDESCRIPTIONLIST_H__

#include "LqrSMACIdl.h"
#include "LqrSMACPayloadDescription.h"
#include "LqrSMACSharedLib.h"
#include <ostream>
#include <string>
#include <boost/serialization/access.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/shared_ptr.hpp>

namespace LiquidRobotics {
namespace SMACFramework {

typedef std::list<LiquidRobotics::SMACFramework::PayloadDescription::Ptr> PayloadDescriptionListBase;

class SHARED_LIB_PUBLIC PayloadDescriptionList
: public PayloadDescriptionListBase
{
public:

	typedef std::list<LiquidRobotics::SMACFramework::PayloadDescription::Ptr> Base;
	typedef LiquidRobotics::SMAC::PayloadDescriptionList CORBAEntity;
	typedef LiquidRobotics::SMAC::PayloadDescriptionList_var CORBAEntity_var;
	typedef LiquidRobotics::SMAC::BoardIDType BoardIDType;
	typedef boost::shared_ptr<PayloadDescriptionList> Ptr;
	typedef std::string string;

	PayloadDescriptionList();
	PayloadDescriptionList(size_type n);
	PayloadDescriptionList(const PayloadDescriptionList& other);
	PayloadDescriptionList(const CORBAEntity& entity);

	PayloadDescriptionList& operator=(const PayloadDescriptionList& other);
	PayloadDescriptionList& operator=(const CORBAEntity& entity);

	bool operator==(const PayloadDescriptionList& other) const;
	bool operator<(const PayloadDescriptionList& other) const;

	CORBAEntity_var GetEntity() const;
	void SetEntity(const CORBAEntity& entity);

	PayloadDescriptionList& Clone(const PayloadDescriptionList& other);

private:

	friend class boost::serialization::access;

	template<class Archive>
	void serialize(Archive & ar, const unsigned int version)
	{
		ar & boost::serialization::make_nvp("payloadDescriptionList", *this);
	}

	void copy(const CORBAEntity& entity);
	int compare(const PayloadDescriptionList& other) const;
};

std::ostream& operator<<(std::ostream& out, const PayloadDescriptionList& pyldDesc);

}
}

#endif
