Gromacs  2021.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
SimulationInputHandle Class Reference

#include <gromacs/mdrun/simulationinputhandle.h>

Description

Owning handle to a SimulationInput object.

internal

SimulationInput objects are logically immutable, so ownership may be shared by multiple SimulationInputHolders.

Acquire a SimulationInputHolder with makeSimulationInput() and pass to (e.g.) gmx::MdrunnerBuilder::addInput()

SimulationInput has no public API yet.

See Also
https://gitlab.com/gromacs/gromacs/-/issues/3379

Public Member Functions

SimulationInput * get () const noexcept
 Access opaque SimulationInput pointer. More...
 
 operator bool () const
 Boolean context returns true if an input is held, else false.
 

Member Function Documentation

SimulationInput * SimulationInputHandle::get ( ) const
noexcept

Access opaque SimulationInput pointer.

Returns
Borrowed access to the SimulationInput, if present.

The documentation for this class was generated from the following files: