Candidate_v1.7.0
        stable
      
      
        
          | 
            Last change
 on this file since 7d2ee1 was             55feff5, checked in by Frederik Heber <heber@…>, 11 years ago           | 
        
        
          | 
             
Removed extra option actionname from HelpAction. 
 
- this shortens the way to getting help a lot.
 - TESTFIX: regression potentials fixed due to removed actionname.
  
           | 
        
        
          
            
              - 
Property                 mode
 set to                 
100644
               
             
           | 
        
        
          | 
            File size:
            1.6 KB
           | 
        
      
      
| Rev | Line |   | 
|---|
| [1fd675] | 1 | /*
 | 
|---|
 | 2 |  * HelpAction.def
 | 
|---|
 | 3 |  *
 | 
|---|
 | 4 |  *  Created on: Aug 26, 2010
 | 
|---|
 | 5 |  *      Author: heber
 | 
|---|
 | 6 |  */
 | 
|---|
 | 7 | 
 | 
|---|
 | 8 | // all includes and forward declarations necessary for non-integral types below
 | 
|---|
| [6ba9ba] | 9 | #include <string> 
 | 
|---|
 | 10 | #include <vector> 
 | 
|---|
| [1fd675] | 11 | 
 | 
|---|
| [ab2ebe1] | 12 | #include "Parameters/Validators/DiscreteValidator.hpp"
 | 
|---|
 | 13 | #include "Parameters/Validators/Ops_Validator.hpp"
 | 
|---|
| [23958d] | 14 | #include "Parameters/Validators/Specific/ActionNameValidator.hpp"
 | 
|---|
| [649aaa] | 15 | 
 | 
|---|
| [1fd675] | 16 | // i.e. there is an integer with variable name Z that can be found in
 | 
|---|
 | 17 | // ValueStorage by the token "Z" -> first column: int, Z, "Z"
 | 
|---|
| [6ba9ba] | 18 | // "undefine" if no parameters are required, use (NOPARAM_DEFAULT) for each (undefined) default value
 | 
|---|
| [dac853c] | 19 | #define paramtypes (std::string)
 | 
|---|
| [55feff5] | 20 | #define paramtokens ("help")
 | 
|---|
| [dac853c] | 21 | #define paramdescriptions ("Name of an action whose option list is then given")
 | 
|---|
| [6ba9ba] | 22 | #define paramdefaults (PARAM_DEFAULT(std::string("none")))
 | 
|---|
| [dac853c] | 23 | #define paramreferences (actionname)
 | 
|---|
| [23958d] | 24 | #define paramvalids \
 | 
|---|
| [ab2ebe1] | 25 | (DiscreteValidator<std::string>(std::vector<std::string>(1, std::string("none"))) || ActionNameValidator())
 | 
|---|
 | 26 | // NOTE: The _default_ value MUST NOT require validation via ActionNameValidator!
 | 
|---|
 | 27 | // This will trigger an infinite loop of ActionRegistry::fillRegistry() calls as ActionRegistry is
 | 
|---|
 | 28 | // at the time of the filling on of the default values not yet completely constructed!
 | 
|---|
| [1fd675] | 29 | 
 | 
|---|
 | 30 | #undef statetypes
 | 
|---|
 | 31 | #undef statereferences
 | 
|---|
 | 32 | 
 | 
|---|
 | 33 | // some defines for all the names, you may use ACTION, STATE and PARAMS
 | 
|---|
 | 34 | #define CATEGORY Command
 | 
|---|
| [052bfd8] | 35 | #define MENUNAME "command"
 | 
|---|
 | 36 | #define MENUPOSITION 4
 | 
|---|
| [1fd675] | 37 | #define ACTIONNAME Help
 | 
|---|
 | 38 | #define TOKEN "help"
 | 
|---|
 | 39 | 
 | 
|---|
| [24fbf3] | 40 | 
 | 
|---|
 | 41 | // finally the information stored in the ActionTrait specialization
 | 
|---|
| [dac853c] | 42 | #define DESCRIPTION "prints help and available actions, or an action's options"
 | 
|---|
| [24fbf3] | 43 | #define SHORTFORM "h"
 | 
|---|
       
      
  Note:
 See   
TracBrowser
 for help on using the repository browser.