/**
 * 最初の著者:: トゥイー
 * リポジトリ情報:: $Id: WMElement.hpp 11 2011-05-14 02:11:18Z yutaka_at_home $
 * 著作権:: Copyright (C) Ownway.info, 2011. All rights reserved.
 * ライセンス:: CPL(Common Public Licence)
 */

#ifndef _TOPS_WORKING_MEMORY_ELEMENT_HPP_
#define _TOPS_WORKING_MEMORY_ELEMENT_HPP_

#include "tops/common/Printable.hpp"

#include "tops/utilities/CloseContainer.hpp"

#include <list>
#include <map>
#include <string>

#include <boost/shared_ptr.hpp>

namespace tops {

	class Fact;
	typedef boost::shared_ptr<Fact> FactPtr;
	class WorkingMemory;

	class WMElement;
	typedef boost::shared_ptr<WMElement> WMElementPtr;

	/**
	 * ワーキングメモリ要素です。
	 * 構築及び破棄に関して全てのワーキングメモリ要素は、ワーキングメモリによって管理されます。
	 *
	 * @author トゥイー
	 */
	class WMElement :
			public Printable,
			public Utility::CloseContainerElement {
		friend class WorkingMemory;
	private:
		unsigned long m_timeTag;
		FactPtr m_fact;

	private:
		/**
		 * ワーキングメモリ要素を構築します。
		 *
		 * @param timeTag プロダクションシステムから与えられる一意的な時系列番号を指定します。
		 * @param fact 事実を指定します。
		 */
		WMElement(unsigned long timeTag, const FactPtr& fact);

	public:
		/**
		 * ワーキングメモリ要素を破棄します。
		 */
		~WMElement();

	public:
		/**
		 * 時刻タグを取得します。
		 */
		unsigned long getTimeTag() const {
			return m_timeTag;
		}

		/**
		 * 名前を取得します。
		 */
		const std::string& getName() const;

		/**
		 * 事実を取得します。
		 */
		const Fact& getFact() const {
			return *m_fact;
		}

	public:
		/**
		 * 等値判断を行います。
		 *
		 * @param element 等値判断対象となるワーキングメモリ要素を指定します。
		 *
		 * @return 等値ならtrueを、そうじゃないならfalseを返します。
		 */
		bool equals(const WMElement& element) const;

	public:
		/**
		 * ストリームに出力します。
		 */
		void print(std::ostream& stream) const;
	};

}  // namespace tops

#endif
