/*
 * PointCorrelationAction.def
 *
 *  Created on: Aug 25, 2010
 *      Author: heber
 */

// all includes and forward declarations necessary for non-integral types below
#include "LinearAlgebra/Vector.hpp"
#include <vector>
#include <string>

class element;

#include "Parameters/Validators/DummyValidator.hpp"
#include "Parameters/Validators/Ops_Validator.hpp"
#include "Parameters/Validators/STLVectorValidator.hpp"
#include "Parameters/Validators/Specific/BoxVectorValidator.hpp"
#include "Parameters/Validators/Specific/BoxLengthValidator.hpp"
#include "Parameters/Validators/Specific/ElementValidator.hpp"
#include "Parameters/Validators/Specific/FilePresentValidator.hpp"

// i.e. there is an integer with variable name Z that can be found in
// ValueStorage by the token "Z" -> first column: int, Z, "Z"
// "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
#define paramtypes (std::vector<const element *>)(Vector)(double)(double)(double)(boost::filesystem::path)(boost::filesystem::path)(bool)
#define paramreferences (elements)(Point)(BinStart)(BinWidth)(BinEnd)(outputname)(binoutputname)(periodic)
#define paramtokens ("elements")("position")("bin-start")("bin-width")("bin-end")("output-file")("bin-output-file")("periodic")
#define paramdescriptions ("set of elements")("position in R^3 space")("start of the first bin")("width of the bins")("start of the last bin")("name of the output file")("name of the bin output file")("system is constraint to periodic boundary conditions")
#define paramdefaults (NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(0.5))(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(false))
#define paramvalids \
(STLVectorValidator< std::vector<const element *> >(ElementValidator())) \
(BoxVectorValidator()) \
(BoxLengthValidator()) \
(BoxLengthValidator()) \
(BoxLengthValidator()) \
(!FilePresentValidator()) \
(!FilePresentValidator()) \
(DummyValidator<bool>())

// some defines for all the names, you may use ACTION, STATE and PARAMS
#define CATEGORY Analysis
#define MENUNAME "analysis"
#define MENUPOSITION 3
#define ACTIONNAME PointCorrelation
#define TOKEN "point-correlation"

// finally the information stored in the ActionTrait specialization
#define DESCRIPTION "pair correlation analysis between element and point"
#undef SHORTFORM