libgromacs-dev 2018.1-1 / usr / include / gromacs / options / ioptionscontainerwithsections.h

This file is indexed.

/usr/include/gromacs/options/ioptionscontainerwithsections.h is in libgromacs-dev 2018.1-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
 * This file is part of the GROMACS molecular simulation package.
 *
 * Copyright (c) 2016, by the GROMACS development team, led by
 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
 * and including many others, as listed in the AUTHORS file in the
 * top-level source directory and at http://www.gromacs.org.
 *
 * GROMACS is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * GROMACS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GROMACS; if not, see
 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 *
 * If you want to redistribute modifications to GROMACS, please
 * consider that scientific software is very special. Version
 * control is crucial - bugs must be traceable. We will be happy to
 * consider code for inclusion in the official distribution, but
 * derived work must not be called official GROMACS. Details are found
 * in the README & COPYING files - if they are missing, get the
 * official version at http://www.gromacs.org.
 *
 * To help us fund GROMACS development, we humbly ask that you cite
 * the research papers on the package. Check out http://www.gromacs.org.
 */
/*! \file
 * \brief
 * Declares gmx::IOptionsContainerWithSections.
 *
 * \author Teemu Murtola <teemu.murtola@gmail.com>
 * \inpublicapi
 * \ingroup module_options
 */
#ifndef GMX_OPTIONS_IOPTIONSCONTAINERWITHSECTIONS_H
#define GMX_OPTIONS_IOPTIONSCONTAINERWITHSECTIONS_H

#include "gromacs/options/ioptionscontainer.h"

namespace gmx
{

class AbstractOptionSection;
class AbstractOptionSectionHandle;

namespace internal
{
class OptionSectionImpl;
}

/*! \brief
 * Interface for adding input options with sections.
 *
 * This interface extends IOptionsContainer with an additional addSection()
 * method that supports creating a hierarchy of sections for the options.
 *
 * Header optionsection.h provides OptionSection.
 *
 * \inpublicapi
 * \ingroup module_options
 */
class IOptionsContainerWithSections : public IOptionsContainer
{
    public:
        /*! \brief
         * Adds a section to this collection.
         *
         * \tparam    SectionType Type of the section description object.
         * \param[in] section     Section description.
         * \returns   AbstractOptionSectionHandle object for the created option.
         * \throws    APIError if invalid option settings are provided.
         *
         * Options can be added to the section through the returned handle.
         *
         * \internal
         * \p SectionType::HandleType must specify a type that derives from
         * AbstractinOptionSectionHandle and has a suitable constructor.
         */
        template <class SectionType>
        typename SectionType::HandleType addSection(const SectionType &section)
        {
            internal::OptionSectionImpl *storage
                = addSectionImpl(static_cast<const AbstractOptionSection &>(section));
            return typename SectionType::HandleType(storage);
        }

    protected:
        // Disallow deletion through the interface.
        // (no need for the virtual, but some compilers warn otherwise)
        virtual ~IOptionsContainerWithSections();

        /*! \brief
         * Adds a section to this container.
         *
         * \param[in] section     Section description.
         * \returns   Pointer to the internal section representation object.
         */
        virtual internal::OptionSectionImpl *
        addSectionImpl(const AbstractOptionSection &section) = 0;

        GMX_DEFAULT_CONSTRUCTORS(IOptionsContainerWithSections);
};

} // namespace

#endif

APT Browse - Built by Thomas Orozco.