Gromacs  2021-beta2-UNCHECKED
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::SimulationInputHandle Class Reference

#include <gromacs/mdrun/simulationinputhandle.h>


Owning handle to a SimulationInput object.


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

Public Member Functions

 SimulationInputHandle (const SimulationInputHandle &source)
 SimulationInputHandle (SimulationInputHandle &&) noexcept=default
SimulationInputHandleoperator= (const SimulationInputHandle &rhs)
SimulationInputHandleoperator= (SimulationInputHandle &&) noexcept=default
 SimulationInputHandle (std::unique_ptr< detail::SimulationInputHandleImpl > impl)
 Take ownership of private implementation object to produce a new public holder.
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 * gmx::SimulationInputHandle::get ( ) const

Access opaque SimulationInput pointer.

Borrowed access to the SimulationInput, if present.

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