source: src/documentation/constructs/parameters.dox@ 0f9eb0

/*
 * Project: MoleCuilder
 * Description: creates and alters molecular systems
 * Copyright (C)  2010 University of Bonn. All rights reserved.
 * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
 */

/**
 * \file parameters.dox
 *
 * Created on: Jan 20, 2013
 *    Author: ankele
 */


/** \page parameters Parameters
 *
 * A Parameter is a named variable with constraints. The constraints are
 * defined via \ref validators.
 *
 * Their main purpose is to hold user input as options for \ref actions.
 *
 * Some important functions are:
 *  - Parameter::set() (set a value)
 *  - Parameter::get() (get the set value)
 *  - Parameter::isSet() (tests whether a value was set)
 *
 * Setting a value not respecting the constraint will raise an ParameterException.
 * Initially no value is set. Getting the value without having set one will
 * also raise an ParameterException.
 *
 * There are also functions for string representations:
 *  - Parameter::setAsString()
 *  - Parameter::getAsString()
 *
 * Internally the value is represented by a plain member variable of the given
 * type. The type is fixed through the template parameter of the Parameter class.
 *
 * \date 2013-01-28
 *
 */