.. _Information: ================================================================================ Information ================================================================================ Group for information container models. Available models: Summary_ .. _Summary: -------------------------------------------------------------------------------- Summary -------------------------------------------------------------------------------- Class for storing system summary. Can be used for random information or notes. Parameters ---------- +-----------+--------+-----------------------------------+---------+------+------------+ | Name | Symbol | Description | Default | Unit | Properties | +===========+========+===================================+=========+======+============+ | field | | field name | | | | +-----------+--------+-----------------------------------+---------+------+------------+ | comment | | information, comment, or anything | | | | +-----------+--------+-----------------------------------+---------+------+------------+ | comment2 | | comment field 2 | | | | +-----------+--------+-----------------------------------+---------+------+------------+ | comment3 | | comment field 3 | | | | +-----------+--------+-----------------------------------+---------+------+------------+ | comment4 | | comment field 4 | | | | +-----------+--------+-----------------------------------+---------+------+------------+ Config Fields in [Summary] +---------------+--------+-------+---------------------------------------+-----------------+ | Option | Symbol | Value | Info | Accepted values | +===============+========+=======+=======================================+=================+ | allow_adjust | | 1 | allow adjusting upper or lower limits | (0, 1) | +---------------+--------+-------+---------------------------------------+-----------------+ | adjust_lower | | 0 | adjust lower limit | (0, 1) | +---------------+--------+-------+---------------------------------------+-----------------+ | adjust_upper | | 1 | adjust upper limit | (0, 1) | +---------------+--------+-------+---------------------------------------+-----------------+