Candidate_v1.7.0
stable
|
Last change
on this file since 6762b2 was caece4, checked in by Frederik Heber <heber@…>, 11 years ago |
|
Enhanced documentation significantly.
- went through all of the constructs and updated each.
- enhanced documentation ofr Fragmentation::FragmentMolecule().
|
-
Property mode
set to
100644
|
|
File size:
1.4 KB
|
| Rev | Line | |
|---|
| [eee1b7] | 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 validators.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Jan 20, 2013
|
|---|
| 12 | * Author: ankele
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 |
|
|---|
| 16 | /** \page validators Validators
|
|---|
| 17 | *
|
|---|
| 18 | * Validators define constraints for variables. A given variable can be
|
|---|
| [caece4] | 19 | * tested whether or not it fulfills the constraints by executing the
|
|---|
| 20 | * validator's isValid() function. Equivalently the Validator::operator()
|
|---|
| 21 | * can be used.
|
|---|
| [eee1b7] | 22 | *
|
|---|
| 23 | * Their main purpose is to constrain user input for \ref parameters in \ref actions.
|
|---|
| 24 | *
|
|---|
| 25 | * There are several general purpose validators, for example:
|
|---|
| 26 | * - DummyValidator (no constraint)
|
|---|
| 27 | * - DiscreteValidator (is the variable element of a given set)
|
|---|
| 28 | * - RangeValidator (is the variable inside a halfopen interval)
|
|---|
| 29 | * - STLVectorValidator (defines a constraint for each element and/or for the number of elements)
|
|---|
| 30 | *
|
|---|
| 31 | * Validators can also be joined via and/or/not operations:
|
|---|
| 32 | * \code
|
|---|
| 33 | * RealSpaceMatrixSymmetricValidator() && RealSpaceMatrixInvertibleValidator()
|
|---|
| 34 | * \endcode
|
|---|
| 35 | *
|
|---|
| [caece4] | 36 | * The type of the variable is static. The base class Validator has a template
|
|---|
| 37 | * parameter to define the type. Some derived validators don't have template
|
|---|
| 38 | * parameters because they are derived from a Validator<SomeFixedType>.
|
|---|
| [eee1b7] | 39 | *
|
|---|
| 40 | * \date 2013-01-28
|
|---|
| 41 | *
|
|---|
| 42 | */
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
