Changeset 53be34


Ignore:
Timestamp:
Oct 30, 2010, 7:27:57 PM (14 years ago)
Author:
Frederik Heber <heber@…>
Branches:
Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable
Children:
20d46c
Parents:
8bcf3f
git-author:
Frederik Heber <heber@…> (10/26/10 14:04:10)
git-committer:
Frederik Heber <heber@…> (10/30/10 19:27:57)
Message:

ActionTraits returns also MenuName(), MenuPosition(), and also OptionDescriptions().

  • is filled within ../src/Actions/Action_impl_header.hpp from MENUNAME and MENUPOSITION.
  • OptionDescriptions taken from paramdescriptions and paramtokens.
  • OptionDescrptions are also iterable.
Location:
src/Actions
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • src/Actions/ActionTraits.cpp

    r8bcf3f r53be34  
    3030
    3131/** Returns Current Value for this ActionTrait.
    32  * \return current value as std::string
     32 * \return ActionTraits::CurrentValue as std::string
    3333 */
    34 const std::string ActionTraits::getCurrentValue()
     34const std::string ActionTraits::getCurrentValue() const
    3535{
    3636 return CurrentValue;
    … …  
    3838
    3939/** Returns Description for this ActionTrait.
    40  * \return current value as std::string
     40 * \return ActionTraits::Description as std::string
    4141 */
    42 const std::string ActionTraits::getDescription()
     42const std::string ActionTraits::getDescription() const
    4343{
    4444  return Description;
    4545}
    4646
     47/** Returns menu title for this ActionTrait.
     48 * \return ActionTraits::MenuTitle as std::string
     49 */
     50const std::string ActionTraits::getMenuName() const
     51{
     52  return MenuTitle;
     53}
     54
     55/** Returns menu title for this ActionTrait.
     56 * \return ActionTraits::MenuPosition as std::string
     57 */
     58const int ActionTraits::getMenuPosition() const
     59{
     60  return MenuPosition;
     61}
     62
     63/** Returns Description for the given option of this ActionTrait.
     64 * \param token of option
     65 * \return ActionTraits::OptionDescription as std::string
     66 */
     67const std::string ActionTraits::getOptionDescription(const std::string descr) const
     68{
     69  if (OptionDescription.find(descr) != OptionDescription.end())
     70    return OptionDescription.find(descr)->second;
     71  else
     72    return std::string();
     73}
     74
    4775/** Returns ShortForm for this ActionTrait.
    48  * \return current value as std::string
     76 * \return ActionTraits::ShortForm as std::string
    4977 */
    50 const std::string ActionTraits::getShortForm()
     78const std::string ActionTraits::getShortForm() const
    5179{
    5280  return ShortForm;
    … …  
    5482
    5583/** Returns Type for this ActionTrait.
    56  * \return current value as std::type_info reference
     84 * \return ActionTraits::InternalType as std::type_info reference
    5785 */
    58 const std::type_info * ActionTraits::getType()
     86const std::type_info * ActionTraits::getType() const
    5987{
    6088  return InternalType;
    6189}
    6290
     91/** Forward iterator from beginning of list of options.
     92 * \return iterator
     93 */
     94ActionTraits::options_iterator ActionTraits::getBeginIter()
     95{
     96  return OptionDescription.begin();
     97}
     98
     99/** Forward iterator at end of list of options.
     100 * \return iterator
     101 */
     102ActionTraits::options_iterator ActionTraits::getEndIter()
     103{
     104  return OptionDescription.end();
     105}
     106
     107/** Constant forward iterator from beginning of list of options.
     108 * \return constant iterator
     109 */
     110ActionTraits::options_const_iterator ActionTraits::getBeginIter() const
     111{
     112  return OptionDescription.begin();
     113}
     114
     115/** Constant forward iterator at end of list of options.
     116 * \return constant iterator
     117 */
     118ActionTraits::options_const_iterator ActionTraits::getEndIter() const
     119{
     120  return OptionDescription.end();
     121}
     122
     123

  • src/Actions/ActionTraits.hpp

    r8bcf3f r53be34  
    1414#endif
    1515
     16#include <map>
    1617#include <string>
    1718
    … …  
    2829class ActionTraits {
    2930public:
    30   /* TODO: This internal reference is only needed as long as information is not
    31    * yet local. Here it is used to gather info from MapOfActions.
    32    */
    3331  explicit ActionTraits();
    3432  virtual ~ActionTraits();
    3533
    36   const std::string getCurrentValue();
    37   const std::string getDescription();
    38   const std::string getShortForm();
    39   const std::type_info * getType();
     34  typedef std::map<std::string, std::string>::iterator    options_iterator;
     35  typedef std::map<std::string, std::string>::const_iterator    options_const_iterator;
     36
     37  const std::string getCurrentValue() const;
     38  const std::string getDescription() const;
     39  const std::string getMenuName() const;
     40  const int getMenuPosition() const;
     41  const std::string getOptionDescription(const std::string descr) const;
     42  const std::string getShortForm() const;
     43  const std::type_info * getType() const;
     44
     45  options_iterator getBeginIter();
     46  options_iterator getEndIter();
     47  options_const_iterator getBeginIter() const;
     48  options_const_iterator getEndIter() const;
    4049
    4150protected:
    … …  
    4453  std::string CurrentValue;
    4554  std::string Description;
     55  std::string MenuTitle;
     56  int MenuPosition;
     57  std::map<std::string, std::string> OptionDescription;
    4658  std::string ShortForm;
    4759  const std::type_info *InternalType;

  • src/Actions/Action_impl_header.hpp

    r8bcf3f r53be34  
    5454)
    5555#endif
     56#ifdef paramdescriptions
     57BOOST_PP_ASSERT_MSG(BOOST_PP_EQUAL(MAXPARAMTYPES, BOOST_PP_SEQ_SIZE(paramdescriptions)),\
     58  ERROR: There are not the same number of "paramtokens" and "paramdescriptions" in: __FILE__ \
     59)
     60#endif
     61
     62// check for mandatory defines
     63#ifndef DESCRIPTION
     64BOOST_PP_ASSERT_MSG(0, \
     65    "ERROR: Description is mandatory for Actions, here for ACTION " \
     66)
     67#endif
     68#ifndef TYPEINFO
     69BOOST_PP_ASSERT_MSG(0, \
     70    "ERROR: Type is mandatory for Actions, here for ACTION " \
     71)
     72#endif
    5673
    5774// print a list of type ref followed by a separator, i.e. "int i;"
    … …  
    6683  BOOST_PP_SEQ_ELEM(n, TYPELIST) \
    6784  BOOST_PP_SEQ_ELEM(n, VARLIST)
     85
     86// prints OptionDescription.insert
     87#define optiondescription_print(z,n,unused, unused2) \
     88  OptionDescription. insert (\
     89      pair<std::string, std::string> (\
     90  BOOST_PP_SEQ_ELEM(n, paramtokens), \
     91  BOOST_PP_SEQ_ELEM(n, paramdescriptions) )\
     92  );
     93
    6894
    6995#if defined paramtypes && defined paramreferences
    … …  
    89115#ifdef DESCRIPTION
    90116    Description = DESCRIPTION;
    91 #else
    92     BOOST_PP_ASSERT_MSG(0, \
    93         "ERROR: Description is mandatory for Actions, here for ACTION " \
    94     )
     117#endif
     118#ifdef paramdescriptions
     119#define BOOST_PP_LOCAL_MACRO(n) optiondescription_print(~, n, ~, )
     120#define BOOST_PP_LOCAL_LIMITS  (0, MAXPARAMTYPES-1)
     121#include BOOST_PP_LOCAL_ITERATE()
     122#endif
     123#ifdef MENUNAME
     124    MenuTitle = MENUNAME;
     125#endif
     126#ifdef MENUPOSITION
     127    MenuPosition = MENUPOSITION;
    95128#endif
    96129#ifdef SHORTFORM
    … …  
    99132#ifdef TYPEINFO
    100133    InternalType = TYPEINFO;
    101 #else
    102     BOOST_PP_ASSERT_MSG(0, \
    103         "ERROR: Type is mandatory for Actions, here for ACTION " \
    104     )
    105134#endif
    106135  }
Note: See TracChangeset for help on using the changeset viewer.