Action_Thermostats
Add_SelectAtomByNameAction
Adding_Graph_to_ChangeBondActions
Adding_MD_integration_tests
Adding_StructOpt_integration_tests
AutomationFragmentation_failures
Candidate_v1.6.1
Candidate_v1.7.0
ChemicalSpaceEvaluator
EmpiricalPotential_contain_HomologyGraph_documentation
Enhance_userguide
Enhanced_StructuralOptimization
Enhanced_StructuralOptimization_continued
Example_ManyWaysToTranslateAtom
Exclude_Hydrogens_annealWithBondGraph
Fix_Verbose_Codepatterns
ForceAnnealing_oldresults
ForceAnnealing_with_BondGraph
ForceAnnealing_with_BondGraph_continued
ForceAnnealing_with_BondGraph_continued_betteresults
ForceAnnealing_with_BondGraph_contraction-expansion
Gui_displays_atomic_force_velocity
IndependentFragmentGrids_IntegrationTest
JobMarket_RobustOnKillsSegFaults
JobMarket_StableWorkerPool
PythonUI_with_named_parameters
Recreated_GuiChecks
StoppableMakroAction
TremoloParser_IncreasedPrecision
TremoloParser_MultipleTimesteps
stable
|
Last change
on this file since 9a4772 was eee1b7, checked in by Frederik Heber <heber@…>, 13 years ago |
|
DOCU: Documentation on ShapeRegistry, QtUI changes, validators, and parameters.
|
-
Property mode
set to
100644
|
|
File size:
1.2 KB
|
| Line | |
|---|
| 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2010 University of Bonn. All rights reserved.
|
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * \file parameters.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Jan 20, 2013
|
|---|
| 12 | * Author: ankele
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 |
|
|---|
| 16 | /** \page parameters Parameters
|
|---|
| 17 | *
|
|---|
| 18 | * A Parameter is a named variable with constraints. The constraints are
|
|---|
| 19 | * defined via \ref validators.
|
|---|
| 20 | *
|
|---|
| 21 | * Their main purpose is to hold user input as options for \ref actions.
|
|---|
| 22 | *
|
|---|
| 23 | * Some important functions are:
|
|---|
| 24 | * - Parameter::set() (set a value)
|
|---|
| 25 | * - Parameter::get() (get the set value)
|
|---|
| 26 | * - Parameter::isSet() (tests whether a value was set)
|
|---|
| 27 | *
|
|---|
| 28 | * Setting a value not respecting the constraint will raise an ParameterException.
|
|---|
| 29 | * Initially no value is set. Getting the value without having set one will
|
|---|
| 30 | * also raise an ParameterException.
|
|---|
| 31 | *
|
|---|
| 32 | * There are also functions for string representations:
|
|---|
| 33 | * - Parameter::setAsString()
|
|---|
| 34 | * - Parameter::getAsString()
|
|---|
| 35 | *
|
|---|
| 36 | * Internally the value is represented by a plain member variable of the given
|
|---|
| 37 | * type. The type is fixed through the template parameter of the Parameter class.
|
|---|
| 38 | *
|
|---|
| 39 | * \date 2013-01-28
|
|---|
| 40 | *
|
|---|
| 41 | */
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
