source: src/Actions/AnalysisAction/DipoleAngularCorrelationAction.def

Candidate_v1.6.1
Last change on this file was 6ba9ba, checked in by Frederik Heber <heber@…>, 13 years ago

Default values are properly set by the Action into their (Action)Parameters.

  • we changed the boost::preprocessor magic to accomplish this.
  • NODEFAULT -> NOPARAM_DEFAULT to be safe.
  • it has been a hell of a lot of work to make it possible to add a construct such as ", default" to the call of a function, either the comma or the default is easy but both could only be accomplished via a list contained in the sequence of default values. Because the list has an explicit NIL element which is taken as NOPARAM_DEFAULT.
  • PARAM_DEFAULT is a macro to wrap the default value into a list.
  • Property mode set to 100644
File size: 2.2 KB
Line 
1/*
2 * DipoleAngularCorrelationAction.def
3 *
4 * Created on: Feb 11, 2011
5 * Author: heber
6 */
7
8// all includes and forward declarations necessary for non-integral types below
9#include <string>
10#include <vector>
11
12#include "Parameters/Validators/DummyValidator.hpp"
13#include "Parameters/Validators/Ops_Validator.hpp"
14#include "Parameters/Validators/Specific/FilePresentValidator.hpp"
15#include "Parameters/Validators/Specific/FormulaValidator.hpp"
16#include "Parameters/Validators/Specific/RotationAngleValidator.hpp"
17#include "Parameters/Validators/Specific/TimeStepPresentValidator.hpp"
18
19// i.e. there is an integer with variable name Z that can be found in
20// ValueStorage by the token "Z" -> first column: int, Z, "Z"
21// "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
22#define paramtypes (std::string)(double)(double)(double)(boost::filesystem::path)(boost::filesystem::path)(unsigned int)
23#define paramreferences (DipoleFormula)(BinStart)(BinWidth)(BinEnd)(outputname)(binoutputname)(timestepzero)
24#define paramtokens ("dipole-angular-correlation")("bin-start")("bin-width")("bin-end")("output-file")("bin-output-file")("time-step-zero")
25#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")
26#define paramdefaults (NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(0.5))(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(0))
27#define paramvalids \
28(FormulaValidator()) \
29(RotationAngleValidator()) \
30(RotationAngleValidator()) \
31(RotationAngleValidator()) \
32(!FilePresentValidator()) \
33(!FilePresentValidator()) \
34(TimeStepPresentValidator())
35
36// some defines for all the names, you may use ACTION, STATE and PARAMS
37#define CATEGORY Analysis
38#define MENUNAME "analysis"
39#define MENUPOSITION 3
40#define ACTIONNAME DipoleAngularCorrelation
41#define TOKEN "dipole-angular-correlation"
42
43// finally the information stored in the ActionTrait specialization
44#define DESCRIPTION "dipole angular correlation analysis between molecules"
45#undef SHORTFORM
Note: See TracBrowser for help on using the repository browser.