/*******************************************************************
*
*  DESCRIPTION: class NeighborhoodValue
*
*  AUTHOR:    Amir Barylko, Jorge Beyoglonian
*  Version 2: Daniel Rodriguez
*  Version 3: Alejandro Troccoli
*
*  EMAIL: mailto://amir@dc.uba.ar
*         mailto://jbeyoglo@dc.uba.ar
*         mailto://drodrigu@dc.uba.ar
*	   mailto://atroccol@dc.uba.ar
*
*  DATE: 27/06/1998
*  DATE: 02/06/1999 (v2)
*  DATE: 22/02/2001 (v3)
*
*******************************************************************/

#ifndef __NEIGHBORHOOD_VALUE_H
#define __NEIGHBORHOOD_VALUE_H

/** include files **/
#include <map.h>
#include <list>
#include "except.h"	// class MException
#include "real.h"	// The value of the cell
#include "cellpos.h"	// NeighborPosition
#include "coupcell.h"	// CellPositionList

/** declarations **/
class NeighborhoodValue
{
public:
	typedef map<string, Real> CellPorts;
	typedef map<CellPosition, CellPorts, less < CellPosition > > NeighborList;

	NeighborhoodValue() {};
	NeighborhoodValue& create( const CoupledCell      &coupled, 
	                           const CellPositionList &neighbors, 
				   const CellPosition     &center, 
				   const list<string>     &ports);	// default constructor

	~NeighborhoodValue()		// Destructor
	{}

	// ** Modifiers ** //
	NeighborhoodValue &set( const string intportname, const Real &v )
	{ return set(NeighborPosition(dim,0), intportname, v);}

	NeighborhoodValue &set( const NeighborPosition& n, const string &port, const Real &v);

	NeighborhoodValue &setAbsolutePosition( const CellPosition &pos, const Real &v);

	// ** Queries ** // 
	bool isValid(CellPosition &cp) const;
			// Returns true if the CellPosition is contained
			// in the neighborhood.

	const Real &get( const NeighborPosition &n, const string &port ) const ; // throws InvalidNeighborRef

	const Real &get(const string &port) const
	{ return get( NeighborPosition(dim,0), port ); }

	unsigned dimension() const
	{return dim;}

	void print(ostream &os) const;

	CellPosition centralPosition() const
	{ return centralCell; }

	NeighborhoodValue& operator = ( const NeighborhoodValue& );

	const NeighborList& neighborValues() const
	{ return neighborList; }

private:

	NeighborList neighborList;
	unsigned	dim;
	CellPosition	centralCell;


	NeighborhoodValue( const NeighborhoodValue & ) ; // copy constructor

}; // NeighborhoodValue

class InvalidNeighbordRef : public MException
{
public:
	InvalidNeighbordRef(): MException( "Invalid Neighbor reference!" )
	{}
};

#endif // __NEIGHBORHOOD_VALUE_H