// Copyright 2008 Nanorex, Inc.  See LICENSE file for details.

#ifndef NX_DATASTOREINFO_H
#define NX_DATASTOREINFO_H

#include <vector>
#include <map>
#include <string>
using namespace std;

#include "Nanorex/Interface/NXNamedView.h"
#include "Nanorex/Interface/NXMoleculeSet.h"
#include "Nanorex/Utility/NXProperties.h"

namespace Nanorex {


/* CLASS: NXDataStoreInfo */
/**
 * Fill this out.
 *
 * @ingroup NanorexInterface PluginArchitecture
 */
class NXDataStoreInfo {
public:
	NXDataStoreInfo();
	~NXDataStoreInfo();
		//
		// Single structures
		//
	bool isSingleStructure();
	void setIsSingleStructure(bool _isSingleStructure);
	
	const string& getSingleStructureFileName();
	int getSingleStructureId();
	
		//
		// Simulation results
		//
	bool isSimulationResults();
	void setIsSimulationResults(bool _isSimulationResults);
	
	NXProperties* getInputParameters();
	void setInputParameters(NXProperties* parameters);
	
	vector<string> getInputFileNames();
	void addInputStructure(const string& fileName);
	int getInputStructureId(const string& fileName);
	void setInputStructureId(const string& fileName, int frameSetId);
	
	NXProperties* getResultsSummary();
	void setResultsSummary(NXProperties* resultsSummary);
	
	vector<string> getTrajectoryNames();
	void addTrajectory(const string& name, int frameSetId);
	int getTrajectoryId(const string& name);
	
	void setLastFrame(int frameSetId, bool isLastFrame);
	bool isLastFrame(int frameSetId);
	
	bool storeIsComplete(int frameSetId);
	void setStoreComplete(int frameSetId, bool storeIsComplete);
	
	
	//
	// General
	//
	// Data store file names
	const string& getFileName(int frameSetId);
	void setFileName(const string& fileName, int frameSetId);
	
	// Data store file handles
	void setHandle(int frameSetId, void* handle);
	void* getHandle(int frameSetId);
	
	//
	// Clipboard
	//
	
	bool hasClipboardStructure(void) const;
	NXMoleculeSet *const getClipboardStructure(void) const;
	void setClipboardStructure(NXMoleculeSet *const molSetPtr);
	
	// Named-views
	bool hasHomeView(void) const;
	NXNamedView const& getHomeView(void) const;
	void setHomeView(NXNamedView const& theHomeView);
	
	bool hasLastView(void) const;
	NXNamedView const& getLastView(void) const;
	void setLastView(NXNamedView const& theLastView);
	
	vector<NXNamedView> const& getOtherViews(void) const;
	void addOtherView(NXNamedView const& view);
	
	void reset(void);
	
private:
	bool _isSimulationResults, _isSingleStructure;
	NXProperties* _inputParameters, *_resultsSummary;
	
	// Maps frame set id to its source file name.
	map<int, string> _fileNames;
	
	// Maps input structure name to its frame set id.
	map<string, int> _inputStructures;
	
	// Maps trajectory name to its frame set id.
	map<string, int> _trajectories;
	
	// Maps frame set id to its file handle.
	map<int, void*> _handle;
	
	// Maps frame set id to its last-frame status
	map<int, bool> _isLastFrame;
	
	// Maps frame set id to its store-complete status
	map<int, bool> _storeIsComplete;
	
	NXMoleculeSet* _clipboardStructure;
	
	// Named-views
	Nanorex::NXNamedView homeView;
	Nanorex::NXNamedView lastView;
	vector<Nanorex::NXNamedView> otherViews;	
};


/* FUNCTION: hasClipboardStructures */
inline
	bool NXDataStoreInfo::hasClipboardStructure(void) const
{
	return (_clipboardStructure != NULL);
}


/* FUNCTION: getClipboardStructures */
inline
	NXMoleculeSet *const NXDataStoreInfo::getClipboardStructure(void) const
{
	return _clipboardStructure;
}


/* FUNCTION: addClipboardStructure */
inline
	void NXDataStoreInfo::setClipboardStructure(NXMoleculeSet*const molSetPtr)
{
	_clipboardStructure = molSetPtr;
}


inline bool NXDataStoreInfo::hasHomeView(void) const
{
	bool const result = (homeView.getName() == "HomeView");
	return result;
}


inline Nanorex::NXNamedView const& NXDataStoreInfo::getHomeView(void) const
{
	return homeView;
}


inline void NXDataStoreInfo::setHomeView(Nanorex::NXNamedView const& theHomeView)
{
	homeView = theHomeView;
}


inline bool NXDataStoreInfo::hasLastView(void) const
{
	bool result = (lastView.getName() == "LastView");
	return result;
}


inline Nanorex::NXNamedView const& NXDataStoreInfo::getLastView(void) const
{
	return lastView;
}


inline
void NXDataStoreInfo::setLastView(Nanorex::NXNamedView const& theLastView)
{
	lastView = theLastView;
}


inline
vector<Nanorex::NXNamedView> const& NXDataStoreInfo::getOtherViews(void) const
{
	return otherViews;
}


inline
void NXDataStoreInfo::addOtherView(Nanorex::NXNamedView const& view)
{
	otherViews.push_back(view);
}


} // Nanorex::

#endif