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

// all includes and forward declarations necessary for non-integral types below
#include <string>
#include <vector>

#include "Parameters/Validators/DummyValidator.hpp"
#include "Parameters/Validators/Ops_Validator.hpp"
#include "Parameters/Validators/Specific/FilePresentValidator.hpp"
#include "Parameters/Validators/Specific/RotationAngleValidator.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 (double)(double)(double)(boost::filesystem::path)(boost::filesystem::path)(bool)
#define paramreferences (BinStart)(BinWidth)(BinEnd)(outputname)(binoutputname)(periodic)
#define paramtokens ("bin-start")("bin-width")("bin-end")("output-file")("bin-output-file")("periodic")
#define paramdescriptions ("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)(PARAM_DEFAULT(0.5))(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(false))
#define paramvalids \
(RotationAngleValidator()) \
(RotationAngleValidator()) \
(RotationAngleValidator()) \
(!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 DipoleCorrelation
#define TOKEN "dipole-correlation"

// finally the information stored in the ActionTrait specialization
#define DESCRIPTION "dipole orientation correlation analysis between molecules"
#undef SHORTFORM