source: src/Actions/AnalysisAction/SurfaceCorrelationAction.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.1 KB
Line 
1/*
2 * SurfaceCorrelationAction.def
3 *
4 * Created on: Aug 25, 2010
5 * Author: heber
6 */
7
8// all includes and forward declarations necessary for non-integral types below
9#include <string>
10#include <vector>
11class element;
12class molecule;
13
14#include "Parameters/Validators/DummyValidator.hpp"
15#include "Parameters/Validators/Ops_Validator.hpp"
16#include "Parameters/Validators/STLVectorValidator.hpp"
17#include "Parameters/Validators/Specific/BoxLengthValidator.hpp"
18#include "Parameters/Validators/Specific/ElementValidator.hpp"
19#include "Parameters/Validators/Specific/FilePresentValidator.hpp"
20
21// i.e. there is an integer with variable name Z that can be found in
22// ValueStorage by the token "Z" -> first column: int, Z, "Z"
23// "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
24#define paramtypes (std::vector<const element *>)(double)(double)(double)(boost::filesystem::path)(boost::filesystem::path)(bool)
25#define paramreferences (elements)(BinStart)(BinWidth)(BinEnd)(outputname)(binoutputname)(periodic)
26#define paramtokens ("elements")("bin-start")("bin-width")("bin-end")("output-file")("bin-output-file")("periodic")
27#define paramdescriptions ("set of elements")("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")
28#define paramdefaults (NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(0.5))(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(NOPARAM_DEFAULT)(PARAM_DEFAULT(false))
29#define paramvalids \
30(STLVectorValidator< std::vector<const element *> >(ElementValidator())) \
31(BoxLengthValidator()) \
32(BoxLengthValidator()) \
33(BoxLengthValidator()) \
34(!FilePresentValidator()) \
35(!FilePresentValidator()) \
36(DummyValidator<bool>())
37
38// some defines for all the names, you may use ACTION, STATE and PARAMS
39#define CATEGORY Analysis
40#define MENUNAME "analysis"
41#define MENUPOSITION 4
42#define ACTIONNAME SurfaceCorrelation
43#define TOKEN "surface-correlation"
44
45// finally the information stored in the ActionTrait specialization
46#define DESCRIPTION "pair correlation analysis between element and surface"
47#undef SHORTFORM
Note: See TracBrowser for help on using the repository browser.