//-----------------------------------------------------------------------------------
// <copyright file="StringEvent.cpp" 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>
//   Implementation of the StringEvent class, which contains a single ASCII string to
//   be transmitted
// </summary>
//
// <owner>Mike Cookson</owner>
//-----------------------------------------------------------------------------------

#include "StringEvent.h"

using namespace std;
using namespace LiquidRobotics::EventLib;

namespace LiquidRobotics {
namespace EventLib {

const StringEvent::PropertyNameType StringEvent::stringTag("StringEvent-String");

StringEvent::StringEvent(IObjectBroker& _broker)
: Base(_broker)
{
}

StringEvent::StringEvent(const EventSettings& _eventSettings, IObjectBroker& _broker)
: Base(_eventSettings, _broker)
{
}

StringEvent::StringEvent(const EventName& _eventName, const EventType& _eventType, IObjectBroker& _broker)
: Base(_eventName, _eventType, _broker)
{
}

StringEvent::StringEvent(const EventName& _eventName, const EventType& _eventType, const IOR& _senderIOR, IObjectBroker& _broker)
: Base(_eventName, _eventType, _senderIOR, _broker)
{
}

StringEvent::StringEvent(const StringEvent& other)
: Base(other)
{
}

ostream& StringEvent::Describe(ostream& stm) const
{
	Base::Describe(stm);

	if (HasString())
		stm << " string=\"" << GetString() << "\"";

	return stm;
}

IEventBase::Ptr StringEvent::Duplicate() const
{
	IEventBase::Ptr result;
	result.reset(new StringEvent(broker));

	((StringEvent*) result.get())->Copy(*this);
	return result;
}

void StringEvent::ClearString()
{
	if (ContainsProperty(stringTag))		ClearProperty(stringTag);
}

string StringEvent::GetString() const
{
	string result = GetProperty(stringTag).GetString();

	return result;
}
bool StringEvent::HasString() const
{
	bool result = ContainsProperty(stringTag);
	return result;
}

void StringEvent::SetString(const string& newValue)
{
	PropertyValueType str(broker);
	str.SetString(newValue);

	SetProperty(stringTag, str);
}

}
}
