/*
 * DipoleAngularCorrelationAction.def
 *
 *  Created on: Feb 11, 2011
 *      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/FormulaValidator.hpp"
#include "Parameters/Validators/Specific/RotationAngleValidator.hpp"
#include "Parameters/Validators/Specific/TimeStepPresentValidator.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::string)(double)(double)(double)(boost::filesystem::path)(boost::filesystem::path)(unsigned int)
#define paramreferences (DipoleFormula)(BinStart)(BinWidth)(BinEnd)(outputname)(binoutputname)(timestepzero)
#define paramtokens ("dipole-angular-correlation")("bin-start")("bin-width")("bin-end")("output-file")("bin-output-file")("time-step-zero")
#define paramdescriptions ("formula of molecules to calculate dipole of")("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")("initial time step to correlate following ones against")
#define paramdefaults (NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(0.5))(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(0))
#define paramvalids \
(FormulaValidator()) \
(RotationAngleValidator()) \
(RotationAngleValidator()) \
(RotationAngleValidator()) \
(!FilePresentValidator()) \
(!FilePresentValidator()) \
(TimeStepPresentValidator())

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

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